@forge/api 2.12.0-next.1 → 2.12.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/api
 
+## 2.12.0-next.2
+
+### Patch Changes
+
+- 659107b: Implement getting webtrigger URL in Node runtime
+
 ## 2.12.0-next.1
 
 ### Patch Changes

package/out/api/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":";AAAA,OAAc,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAW,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAS9B,aAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrG,aAAK,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,aAAK,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAuBvE,eAAO,MAAM,gBAAgB,aAAc,gBAAgB,UAAU,cAAc,KAAG,aAsCrF,CAAC;AAuBF,wBAAgB,iBAAiB,IAAI,QAAQ,CAoB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":";AAAA,OAAc,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAW,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAS9B,aAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrG,aAAK,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,aAAK,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAuBvE,eAAO,MAAM,gBAAgB,aAAc,gBAAgB,UAAU,cAAc,KAAG,aAkCnF,CAAC;AAuBJ,wBAAgB,iBAAiB,IAAI,QAAQ,CAoB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -27,37 +27,27 @@ const metricName = (provider, remote) => {
     }
     return `api.${providerToMetric[provider]}.${remoteToMetric[remote]}`;
 };
-const createProxyFetch = (provider, remote) => {
-    return async (url, options) => {
-        const { proxy, metrics } = (0, runtime_1.getRuntime)();
-        const request = new node_fetch_1.Request(url, options);
-        const metric = metricName(provider, remote);
-        const timer = metrics.timing(metric, { proxy: 'true' }).measure();
-        metrics.counter(metric).incr();
-        try {
-            const proxyRequest = new node_fetch_1.Request(`${proxy.url}/fpp/provider/${provider}/remote/${remote}`, request);
-            proxyRequest.headers.set('Forge-Proxy-Target-Relative', request.url);
-            proxyRequest.headers.set('Forge-Proxy-Authorization', `Bearer ${proxy.token}`);
-            const requestStart = perf_hooks_1.performance.now();
-            const response = await (0, node_fetch_1.default)(proxyRequest);
-            const requestEnd = perf_hooks_1.performance.now();
-            const proxyUpstreamLatency = parseInt(response.headers.get(FORGE_PROXY_UPSTREAM_LATENCY_HEADER) || '');
-            if (proxyUpstreamLatency) {
-                metrics.timing('proxy-success-overhead').set(requestEnd - requestStart - proxyUpstreamLatency);
-            }
-            if (response.headers.has('forge-proxy-error')) {
-                if (response.headers.get('forge-proxy-error') === 'NEEDS_AUTHENTICATION_ERR') {
-                    throw new errors_1.NeedsAuthenticationError('Authentication Required', ATLASSIAN_TOKEN_SERVICE_KEY);
-                }
-                throw new errors_1.ProxyRequestError(response.status, response.headers.get('forge-proxy-error'));
-            }
-            return response;
-        }
-        finally {
-            timer.stop();
+const createProxyFetch = (provider, remote) => (0, runtime_1.wrapInMetrics)(metricName(provider, remote), async (url, options) => {
+    const { proxy, metrics } = (0, runtime_1.getRuntime)();
+    const request = new node_fetch_1.Request(url, options);
+    const proxyRequest = new node_fetch_1.Request(`${proxy.url}/fpp/provider/${provider}/remote/${remote}`, request);
+    proxyRequest.headers.set('Forge-Proxy-Target-Relative', request.url);
+    proxyRequest.headers.set('Forge-Proxy-Authorization', `Bearer ${proxy.token}`);
+    const requestStart = perf_hooks_1.performance.now();
+    const response = await (0, node_fetch_1.default)(proxyRequest);
+    const requestEnd = perf_hooks_1.performance.now();
+    const proxyUpstreamLatency = parseInt(response.headers.get(FORGE_PROXY_UPSTREAM_LATENCY_HEADER) || '');
+    if (proxyUpstreamLatency) {
+        metrics.timing('proxy-success-overhead').set(requestEnd - requestStart - proxyUpstreamLatency);
+    }
+    if (response.headers.has('forge-proxy-error')) {
+        if (response.headers.get('forge-proxy-error') === 'NEEDS_AUTHENTICATION_ERR') {
+            throw new errors_1.NeedsAuthenticationError('Authentication Required', ATLASSIAN_TOKEN_SERVICE_KEY);
         }
-    };
-};
+        throw new errors_1.ProxyRequestError(response.status, response.headers.get('forge-proxy-error'));
+    }
+    return response;
+}, { tags: { proxy: 'true' } });
 exports.createProxyFetch = createProxyFetch;
 const throwNotImplementedError = () => {
     throw new Error('not implemented');

package/out/api/runtime.d.ts

@@ -1,10 +1,18 @@
-import type { Metrics } from '@forge/util/packages/metrics-interface';
+import type { Metrics, Tags } from '@forge/util/packages/metrics-interface';
 export declare type ForgeRuntime = {
     proxy: {
         token: string;
         url: string;
     };
     contextAri: string;
+    appContext: {
+        appId: string;
+        environmentId: string;
+        appVersion: string;
+        functionKey: string;
+        moduleType: string;
+        moduleKey: string;
+    };
     allowedEgress: string[];
     lambdaContext: {
         awsRequestId: string;
@@ -12,4 +20,7 @@ export declare type ForgeRuntime = {
     metrics: Metrics;
 };
 export declare function getRuntime(): ForgeRuntime;
+export declare function wrapInMetrics<Args extends unknown[], Ret>(name: string, fn: (...args: Args) => Promise<Ret>, { tags }?: {
+    tags?: Tags;
+}): (...args: Args) => Promise<Ret>;
 //# sourceMappingURL=runtime.d.ts.map

package/out/api/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/api/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AAOtE,oBAAY,YAAY,GAAG;IACzB,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,EAAE;QACb,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,wBAAgB,UAAU,IAAI,YAAY,CAOzC"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/api/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,wCAAwC,CAAC;AAO5E,oBAAY,YAAY,GAAG;IACzB,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,EAAE;QACb,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,wBAAgB,UAAU,IAAI,YAAY,CAOzC;AAED,wBAAgB,aAAa,CAAC,IAAI,SAAS,OAAO,EAAE,EAAE,GAAG,EACvD,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,GAAG,CAAC,EACnC,EAAE,IAAI,EAAE,GAAE;IAAE,IAAI,CAAC,EAAE,IAAI,CAAA;CAAO,GAC7B,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,GAAG,CAAC,CAWjC"}

package/out/api/runtime.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRuntime = void 0;
+exports.wrapInMetrics = exports.getRuntime = void 0;
 function getRuntime() {
     const runtime = global.__forge_runtime__;
     if (!runtime) {
@@ -9,3 +9,17 @@ function getRuntime() {
     return runtime;
 }
 exports.getRuntime = getRuntime;
+function wrapInMetrics(name, fn, { tags } = {}) {
+    return async (...args) => {
+        const { metrics } = getRuntime();
+        metrics.counter(name, tags).incr();
+        const timer = metrics.timing(name, tags).measure();
+        try {
+            return await fn(...args);
+        }
+        finally {
+            timer.stop();
+        }
+    };
+}
+exports.wrapInMetrics = wrapInMetrics;

package/out/runtime/fetch-and-storage.d.ts

@@ -1,4 +1,5 @@
-export declare const createRequestStargateAsApp: () => any;
+import { createProxyFetch } from '../api/fetch';
+export declare const createRequestStargateAsApp: () => ReturnType<typeof createProxyFetch>;
 export declare const getContextAri: () => any;
 export declare const getFetchAPI: () => import("..").FetchAPI;
 //# sourceMappingURL=fetch-and-storage.d.ts.map

package/out/runtime/fetch-and-storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch-and-storage.d.ts","sourceRoot":"","sources":["../../src/runtime/fetch-and-storage.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,0BAA0B,WACiD,CAAC;AAEzF,eAAO,MAAM,aAAa,WAQzB,CAAC;AAEF,eAAO,MAAM,WAAW,6BAOvB,CAAC"}
+{"version":3,"file":"fetch-and-storage.d.ts","sourceRoot":"","sources":["../../src/runtime/fetch-and-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAA2C,MAAM,cAAc,CAAC;AAGzF,eAAO,MAAM,0BAA0B,EAAE,MAAM,UAAU,CAAC,OAAO,gBAAgB,CACO,CAAC;AAEzF,eAAO,MAAM,aAAa,WAQzB,CAAC;AAEF,eAAO,MAAM,WAAW,6BAOvB,CAAC"}

package/out/{webTrigger/index.d.ts → webTrigger.d.ts}

@@ -3,4 +3,4 @@ interface WebTriggerAPI {
 }
 export declare const webTrigger: WebTriggerAPI;
 export {};
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=webTrigger.d.ts.map

package/out/webTrigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webTrigger.d.ts","sourceRoot":"","sources":["../src/webTrigger.ts"],"names":[],"mappings":"AAGA,UAAU,aAAa;IACrB,MAAM,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1D;AA2CD,eAAO,MAAM,UAAU,EAAE,aAGxB,CAAC"}

package/out/webTrigger.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webTrigger = void 0;
+const runtime_1 = require("./api/runtime");
+const fetch_and_storage_1 = require("./runtime/fetch-and-storage");
+const proxyGetWebTriggerURL = (0, runtime_1.wrapInMetrics)('api.getWebTriggerUrl', async (webTriggerModuleKey) => {
+    var _a, _b;
+    const runtime = (0, runtime_1.getRuntime)();
+    const response = await (0, fetch_and_storage_1.createRequestStargateAsApp)()('/graphql', {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({
+            query: `
+            mutation forge_app_createWebTriggerUrl($input: WebTriggerUrlInput!) {
+              createWebTriggerUrl(input: $input) {
+                url
+              }
+            }
+          `,
+            variables: {
+                input: {
+                    appId: runtime.appContext.appId,
+                    envId: runtime.appContext.environmentId,
+                    triggerKey: webTriggerModuleKey,
+                    contextId: runtime.contextAri
+                }
+            }
+        })
+    });
+    if (!response.ok) {
+        throw new Error(`Internal error occurred: Failed to get web trigger URL: ${response.statusText}.`);
+    }
+    const responseBody = await response.json();
+    if (!((_b = (_a = responseBody === null || responseBody === void 0 ? void 0 : responseBody.data) === null || _a === void 0 ? void 0 : _a.createWebTriggerUrl) === null || _b === void 0 ? void 0 : _b.url)) {
+        throw new Error(`Internal error occurred: Failed to get web trigger URL.`);
+    }
+    return responseBody.data.createWebTriggerUrl.url;
+});
+exports.webTrigger = {
+    getUrl: async (webTriggerModuleKey) => { var _a, _b, _c; return ((_c = (_b = (_a = global.api) === null || _a === void 0 ? void 0 : _a.webTrigger) === null || _b === void 0 ? void 0 : _b.getUrl) !== null && _c !== void 0 ? _c : proxyGetWebTriggerURL)(webTriggerModuleKey); }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "2.12.0-next.1",
+  "version": "2.12.0-next.2",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,6 +12,7 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
+    "@forge/runtime": "4.3.0-next.0",
     "@forge/util": "1.2.1",
     "nock": "^10.0.6",
     "@types/node": "^12.12.63"

package/out/webTrigger/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/webTrigger/index.ts"],"names":[],"mappings":"AAAA,UAAU,aAAa;IACrB,MAAM,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1D;AAED,eAAO,MAAM,UAAU,EAAE,aAIxB,CAAC"}

package/out/webTrigger/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.webTrigger = void 0;
-exports.webTrigger = {
-    getUrl: async (webTriggerModuleKey) => {
-        return global.api.webTrigger.getUrl(webTriggerModuleKey);
-    }
-};