@forge/tunnel 3.7.1-next.7 → 3.8.0-next.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/tunnel
 
+## 3.8.0-next.8
+
+### Minor Changes
+
+- bd192806: Added ngrok config option to tunnel
+
+### Patch Changes
+
+- Updated dependencies [bd192806]
+  - @forge/cli-shared@3.19.0-next.5
+  - @forge/bundler@4.12.1-next.8
+
 ## 3.7.1-next.7
 
 ### Patch Changes

package/out/command/start-tunnel-command.d.ts

@@ -9,6 +9,7 @@ export interface StartTunnelOptions {
     port?: number;
     host: string;
     environmentKey: string;
+    ngrokConfig?: string;
     resourcePortMap?: Record<string, number>;
 }
 export interface StartTunnelResult {

package/out/command/start-tunnel-command.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"start-tunnel-command.d.ts","sourceRoot":"","sources":["../../src/command/start-tunnel-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,EAAyB,MAAM,mBAAmB,CAAC;AACjG,OAAO,EAAE,SAAS,EAAqB,MAAM,gBAAgB,CAAC;AAG9D,OAAO,EACL,iBAAiB,EAKlB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAsC,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACzE,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,eAAe,CAAC,WAAW,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,eAAO,MAAM,mBAAmB,IAAI,CAAC;AACrC,eAAO,MAAM,UAAU,QAAiB,CAAC;AAEzC,qBAAa,kBAAkB;IAK3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,OAAO,CAAC,aAAa,CAAmE;IACxF,OAAO,CAAC,iBAAiB,CAAgC;gBAGtC,YAAY,EAAE,iBAAiB,EAC/B,SAAS,EAAE,iBAAiB,EAC5B,aAAa,EAAE,mBAAmB,EAClC,YAAY,EAAE,qBAAqB,EACnC,YAAY,EAAE,qBAAqB,EACnC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU;IAGzC,OAAO,CAAC,YAAY,CAUlB;IAEF,OAAO,CAAC,qBAAqB,CAc3B;IAEF,OAAO,CAAC,gCAAgC,CAmCtC;IAEW,OAAO,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAoD9E"}
+{"version":3,"file":"start-tunnel-command.d.ts","sourceRoot":"","sources":["../../src/command/start-tunnel-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,EAAyB,MAAM,mBAAmB,CAAC;AACjG,OAAO,EAAE,SAAS,EAAqB,MAAM,gBAAgB,CAAC;AAG9D,OAAO,EACL,iBAAiB,EAKlB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAsC,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACzE,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,eAAe,CAAC,WAAW,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5D;AAED,eAAO,MAAM,mBAAmB,IAAI,CAAC;AACrC,eAAO,MAAM,UAAU,QAAiB,CAAC;AAEzC,qBAAa,kBAAkB;IAK3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAX7B,OAAO,CAAC,aAAa,CAAmE;IACxF,OAAO,CAAC,iBAAiB,CAAgC;gBAGtC,YAAY,EAAE,iBAAiB,EAC/B,SAAS,EAAE,iBAAiB,EAC5B,aAAa,EAAE,mBAAmB,EAClC,YAAY,EAAE,qBAAqB,EACnC,YAAY,EAAE,qBAAqB,EACnC,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU;IAGzC,OAAO,CAAC,YAAY,CAUlB;IAEF,OAAO,CAAC,qBAAqB,CAuB3B;IAEF,OAAO,CAAC,gCAAgC,CAmCtC;IAEW,OAAO,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAoD9E"}

package/out/command/start-tunnel-command.js

@@ -32,14 +32,16 @@ class StartTunnelCommand {
                 (_a = this.cspReporterServer) === null || _a === void 0 ? void 0 : _a.stop()
             ]);
         };
-        this.startFaaSTunnelServer = async (port) => {
+        this.startFaaSTunnelServer = async ({ port, tunnelConfigPath }) => {
             const { permissions = {}, remotes = [] } = await this.configFile.readConfig();
             const serverInfo = await this.devServer.start(port, permissions, remotes);
-            const faasTunnelUrl = await this.tunnelFactory.establishTunnel(serverInfo.port);
-            this.logger.warn(cli_shared_1.Text.tunnel.ngrokTimeoutWarning(exports.NGROK_TIMEOUT_HOURS));
-            setTimeout(() => {
-                this.logger.warn(cli_shared_1.Text.tunnel.ngrokTimeoutReached(exports.NGROK_TIMEOUT_HOURS));
-            }, exports.NGROK_TIMEOUT_HOURS * exports.MS_IN_HOUR);
+            const faasTunnelUrl = await this.tunnelFactory.establishTunnel({ port: serverInfo.port, tunnelConfigPath });
+            if (!tunnelConfigPath) {
+                this.logger.warn(cli_shared_1.Text.tunnel.ngrokTimeoutWarning(exports.NGROK_TIMEOUT_HOURS));
+                setTimeout(() => {
+                    this.logger.warn(cli_shared_1.Text.tunnel.ngrokTimeoutReached(exports.NGROK_TIMEOUT_HOURS));
+                }, exports.NGROK_TIMEOUT_HOURS * exports.MS_IN_HOUR);
+            }
             return Object.assign(Object.assign({}, serverInfo), { tunnelUrl: faasTunnelUrl });
         };
         this.startResourceBasedTunnelsServers = async (resourceDetails, options) => {
@@ -66,7 +68,7 @@ class StartTunnelCommand {
         const { port, environmentKey } = options;
         const allResources = await this.configFile.getResources();
         try {
-            const faasTunnelServer = await this.startFaaSTunnelServer(port);
+            const faasTunnelServer = await this.startFaaSTunnelServer({ port, tunnelConfigPath: options.ngrokConfig });
             const customUITunnelsServers = await this.startResourceBasedTunnelsServers(allResources, options);
             const tunnelDefinitions = {
                 faasTunnelUrl: faasTunnelServer.tunnelUrl,

package/out/services/create-tunnel-service.d.ts

@@ -2,14 +2,20 @@
 import { URL } from 'url';
 import { Logger } from '@forge/cli-shared';
 export interface CreateTunnelService {
-    establishTunnel(port: number): Promise<URL>;
+    establishTunnel({ port, tunnelConfigPath }: {
+        port: number;
+        tunnelConfigPath: string | undefined;
+    }): Promise<URL>;
     closeTunnel(): Promise<void>;
 }
 export declare class NgrokCreateTunnelService implements CreateTunnelService {
     private readonly logger;
     private endpoint;
     constructor(logger: Logger);
-    establishTunnel(port: number): Promise<URL>;
+    establishTunnel({ port, tunnelConfigPath }: {
+        port: number;
+        tunnelConfigPath: string | undefined;
+    }): Promise<URL>;
     closeTunnel(): Promise<void>;
 }
 //# sourceMappingURL=create-tunnel-service.d.ts.map

package/out/services/create-tunnel-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-tunnel-service.d.ts","sourceRoot":"","sources":["../../src/services/create-tunnel-service.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAGjD,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAQD,qBAAa,wBAAyB,YAAW,mBAAmB;IAGtD,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,QAAQ,CAAqB;gBAER,MAAM,EAAE,MAAM;IAE9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAqB3C,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;CAkB1C"}
+{"version":3,"file":"create-tunnel-service.d.ts","sourceRoot":"","sources":["../../src/services/create-tunnel-service.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAGjD,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAQD,qBAAa,wBAAyB,YAAW,mBAAmB;IAGtD,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,QAAQ,CAAqB;gBAER,MAAM,EAAE,MAAM;IAE9B,eAAe,CAAC,EAC3B,IAAI,EACJ,gBAAgB,EACjB,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;KACtC,GAAG,OAAO,CAAC,GAAG,CAAC;IAwBH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;CAkB1C"}

package/out/services/create-tunnel-service.js

@@ -15,12 +15,12 @@ class NgrokCreateTunnelService {
     constructor(logger) {
         this.logger = logger;
     }
-    async establishTunnel(port) {
-        const configPath = path_1.default.join(__dirname, '..', '..', 'config', 'ngrok.yml');
+    async establishTunnel({ port, tunnelConfigPath }) {
+        const defaultConfigPath = path_1.default.join(__dirname, '..', '..', 'config', 'ngrok.yml');
         try {
             const options = {
                 addr: port,
-                configPath,
+                configPath: tunnelConfigPath !== null && tunnelConfigPath !== void 0 ? tunnelConfigPath : defaultConfigPath,
                 onStatusChange: (status) => {
                     this.logger.debug(cli_shared_1.Text.tunnel.tunnelStatusChange(status));
                 },
@@ -33,6 +33,9 @@ class NgrokCreateTunnelService {
             return new url_1.URL(this.endpoint);
         }
         catch (e) {
+            if (e instanceof Error) {
+                this.logger.debug(e.message);
+            }
             throw new NgrokError();
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/tunnel",
-  "version": "3.7.1-next.7",
+  "version": "3.8.0-next.8",
   "description": "Tunnel functionality for Forge CLI",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -11,8 +11,8 @@
     "compile": "tsc -b -v"
   },
   "dependencies": {
-    "@forge/bundler": "4.12.1-next.7",
-    "@forge/cli-shared": "3.18.1-next.4",
+    "@forge/bundler": "4.12.1-next.8",
+    "@forge/cli-shared": "3.19.0-next.5",
     "@forge/csp": "2.2.2-next.0",
     "@forge/runtime": "5.0.2-next.0",
     "express": "^4.18.2",