Merge pull request #7 from namecheap/bugfix/stabilize-connection

fix: improve reconnection logic

.github/workflows/easy-tunnel-ci.yaml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [16.x, 18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -21,4 +21,16 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
+      - name: Checkout server
+        uses: actions/checkout@v3
+        with:
+          repository: namecheap/mytunnel-server
+          ref: master
+          path: server
+      - name: Start server
+        run: |
+          npm ci
+          npm run dev &
+          npx -y wait-on tcp:127.0.0.1:8087 --log
+        working-directory: server
       - run: npm test

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "avoid",
+  "singleQuote": true,
+  "tabWidth": 2,
+  "printWidth": 120
+}

README.md

@@ -77,7 +77,7 @@ const easyTunnel = require('@namecheap/easy-tunnel');
 
 - `port` (number) [required] The local port number to expose through easy-tunnel.
 - `subdomain` (string) Request a specific subdomain on the proxy server. **Note** You may not actually receive this name depending on availability.
-- `host` (string) URL for the upstream proxy server. Defaults to `https://localtunnel.me`.
+- `host` (string) URL for the upstream proxy server. Defaults to `http://localhost:8087`.
 - `local_host` (string) Proxy to this hostname instead of `localhost`. This will also cause the `Host` header to be re-written to this value in proxied requests.
 - `local_https` (boolean) Enable tunneling to local HTTPS server.
 - `local_cert` (string) Path to certificate PEM file for local HTTPS server.

bin/et.js

@@ -17,7 +17,7 @@ const { argv } = yargs
   .option('h', {
     alias: 'host',
     describe: 'Upstream server providing forwarding',
-    default: 'https://localtunnel.me',
+    default: 'http://localhost:8087',
   })
   .option('s', {
     alias: 'subdomain',
@@ -50,11 +50,20 @@ const { argv } = yargs
     describe: 'Print basic request info',
   })
   .option('request-secure-tunnel', {
-    describe: 'Requests tunel server to create secure tunnel if it is available.',
+    alias: 'secure',
+    describe: 'Requests tunnel server to create secure tunnel if it is available.',
   })
-  .option('local_max_reconnect_count', {
+  .option('local-max-retries', {
     describe: 'Max number of reconnection retries to local server if it goes offline.',
-    default: 90,
+    default: Infinity,
+  })
+  .option('connect-timeout', {
+    describe: 'Connection timeout (ms)',
+    default: 10_000,
+  })
+  .option('idle-timeout', {
+    describe: 'Idle socket timeout (ms)',
+    default: 15_000,
   })
   .require('port')
   .boolean('local-https')
@@ -82,7 +91,9 @@ if (typeof argv.port !== 'number') {
     local_ca: argv.localCa,
     allow_invalid_cert: argv.allowInvalidCert,
     request_secure_tunnel: argv.requestSecureTunnel,
-    local_max_reconnect_count: argv.local_max_reconnect_count
+    local_max_retries: argv.localMaxRetries,
+    connect_timeout: argv.connectTimeout,
+    idle_timeout: argv.idleTimeout
   }).catch(err => {
     throw err;
   });

cert.pem

@@ -0,0 +1,32 @@
+-----BEGIN CERTIFICATE-----
+MIIFmTCCA4GgAwIBAgIUN8ZRrUaNcWvSZUcrQODSzxj3tdUwDQYJKoZIhvcNAQEL
+BQAwXDELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
+GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEVMBMGA1UEAwwMY2EubG9jYWxob3N0
+MB4XDTI0MDYyNDE2NTM1MloXDTI1MDYyNDE2NTM1MlowXDELMAkGA1UEBhMCQVUx
+EzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMg
+UHR5IEx0ZDEVMBMGA1UEAwwMY2EubG9jYWxob3N0MIICIjANBgkqhkiG9w0BAQEF
+AAOCAg8AMIICCgKCAgEAqvgDXnVfqT30mFY2Wg7cpeVBMZmW6/JiM8Ncu2GQMAOc
+PHgQYLPmuDuHY7gUMt/NB5DAfiL7TpGjnx6W0nS70rgYWjXF6FpMW245QIiB1fKQ
+Swk/ssu4WjnbzRxkiPdHOZlsKLCl74i5HASSpVWKlR9w36a+p3WiCK7XiE56RdyU
+5otbWalKSpmEu3+UOYEbEFxSy7RQJBAsLGmYs5tgLzTfXNaukwCwYU9H7h0d1Lgq
+1y0m2O2DGVwBEpCX9e9sT0M5T3gKpaFT770jacv2I2jP3plSLPdNbij8TQ2jrR4N
+wWU1D+KXSkE16ojPO9WI0Hy9tgEiD7ac6b36hcT1mgmBaVJ/aoBRVAqBADnMz4jt
+Qb5rknUJnTQ6uoLXs+D4dblCRP7ZSZVeGqhLL7oEJ78VVrk8bD/IMYo2wVREEOsn
+rVSG+iQ9FzAgqWcBVPLqnzvlvjVsUH6PlCfQfVRWiWUmDUEKEcr2IMSZfqUODKKG
+MV3nc/Xt8d5YoRG2aHptWxgRLEDWb8jRpmeR9iSzb4KXaAQtohsmxJapgTc9Uoxl
+1En5hFIQng/+aRQkLc6FrWte8Qx0jtOgpDQ3q15UM6nHaDk6zR93IXQDcHSBMV30
+YALl0PSzO5Pn/sh081+CUxzpOS2AiGVgTuxwRYM9ZJB9RZ9qRHFoJN2kfKaMsTsC
+AwEAAaNTMFEwHQYDVR0OBBYEFILVdBynDOWHfudabk+lRs5ALuEHMB8GA1UdIwQY
+MBaAFILVdBynDOWHfudabk+lRs5ALuEHMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZI
+hvcNAQELBQADggIBAFpUr+/aeYFl/EU8i9ZQ7FbGLmRNJMU/WYBePBfLC5kdScCb
+hdavps5lozaJ6ECjuBCGMDsDMu1Z+zV8Ps2UgMRYZcmucSg2DRXooY3WxrAiTgrd
+VEyaLotfulG+Am70t4mrdbQfhEWX/fMTh1ruFq1sn0gk7mD1gvlaElxH200p8Yyf
+qAE60JKkVikvuaff/eplIEbU3C2BGXU3+/+/qRtr+Cy5HC9SLuOLgSJidi2P192+
+Z3jpZEd7EMKMZ/k8knBtoZM8nZ7q+LqQmnEP+BFURG2Ht8i9mK+NHWfvUuZoyCaU
+mhcG37+lGjRS8x94SgHFDKKsyeF7qI5RSuWSd4b/2/ZurW1Us9C03Evu2/dcHhku
+eczKA9T0MM6ZrIPrzM7whNldLredJoai734Kzq1kkl6Z/lESy/dlXGBA+UgnGuP0
+LQSmJ8RQis8k01nm4T0vht+7GYJ1QVzEB1I4/WVhjll6ig+s+Dvx8tT01nmxepxR
+TjbFYVQuS3G9TWkP/OJm87sHZmYfDdVjQQlpSYaSQ2qEthVtmzTVg6r4FBxGErGL
+6z7bNmqnpnrmCebjl+xoRwyatTLTZz/+lmtszYg+WhzEsy61PaU4fzF8y0VfncJ9
+6dP0XP3CVgKjHIDM4Jsk6rDkzOc8yU3ESkcnCPCIJIQQtBk31EyKPRp4ALTK
+-----END CERTIFICATE-----

easyTunnel.d.ts

@@ -15,7 +15,8 @@ declare interface BootstrapOpts {
     local_ca?: string;
     allow_invalid_cert?: boolean;
     request_secure_tunnel?: boolean;
-    local_max_reconnect_count?: number;
+    local_max_retries?: number;
+    local_reconnect_delay?: number;
 }
 
 declare const localtunnel: (opts: BootstrapOpts) => Promise<Tunnel>;