@forge/api 2.17.0 → 2.18.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/api
 
+## 2.18.0
+
+### Minor Changes
+
+- 7cab7f9c: Handle redirect in nodejs runtime
+
+## 2.18.0-next.0
+
+### Minor Changes
+
+- 7cab7f9c: Handle redirect in nodejs runtime
+
 ## 2.17.0
 
 ### Minor Changes

package/out/api/fetch.d.ts

@@ -1,4 +1,4 @@
-import { RequestInfo, RequestInit, Response } from 'node-fetch';
+import { RequestInfo, RequestInit, Response, Headers } from 'node-fetch';
 import { FetchAPI } from '..';
 declare type FetchFunction = (url: RequestInfo, options?: RequestInit) => Promise<Response>;
 declare type ProxyUrlProvider = 'app' | 'user' | 'none';
@@ -10,6 +10,7 @@ declare type ProxyFetchArgs = {
 } | {
     type: 'egress';
 };
+export declare const getRedirectUrl: (responseHeaders: Headers, original: string, isFromEgress: boolean) => string;
 export declare const createProxyFetch: (args: ProxyFetchArgs) => FetchFunction;
 export declare function getNodeRuntimeAPI(): FetchAPI;
 export declare function getSandboxRuntimeAPI(api: any): FetchAPI;

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;AAEhF,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAQ9B,aAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACpF,aAAK,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,aAAK,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AA4BvE,aAAK,cAAc,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AA8B/G,eAAO,MAAM,gBAAgB,SAAU,cAAc,KAAG,aAoCrD,CAAC;AAOJ,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,OAAO,EAAE,MAAM,YAAY,CAAC;AAEzF,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAS9B,aAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACpF,aAAK,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,aAAK,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AA4BvE,aAAK,cAAc,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAsE/G,eAAO,MAAM,cAAc,oBAAqB,OAAO,YAAY,MAAM,gBAAgB,OAAO,KAAG,MAQlG,CAAC;AAyEF,eAAO,MAAM,gBAAgB,SAAU,cAAc,KAAG,aAerD,CAAC;AAOJ,wBAAgB,iBAAiB,IAAI,QAAQ,CAoB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.createProxyFetch = void 0;
+exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.createProxyFetch = exports.getRedirectUrl = void 0;
 const tslib_1 = require("tslib");
 const node_fetch_1 = tslib_1.__importStar(require("node-fetch"));
 const _1 = require(".");
@@ -32,46 +32,116 @@ const metricName = (args) => {
     }
 };
 const createProxyRequest = ({ url: proxyUrl, token, host }, args, originalRequest) => {
-    let proxyRequest;
+    let proxyEndpoint;
     switch (args.type) {
         case 'egress':
-            proxyRequest = new node_fetch_1.Request(`${proxyUrl}/egress`, originalRequest);
-            const url = new URL(originalRequest.url);
-            proxyRequest.headers.set('Forge-Proxy-Target-Relative', `${url.pathname}${url.search}`);
-            proxyRequest.headers.set('Forge-Proxy-Target-Host', url.hostname);
+            proxyEndpoint = `${proxyUrl}/egress`;
             break;
         case 'fpp':
-            proxyRequest = new node_fetch_1.Request(`${proxyUrl}/fpp/provider/${args.provider}/remote/${args.remote}`, originalRequest);
-            proxyRequest.headers.set('Forge-Proxy-Target-Relative', originalRequest.url);
+            proxyEndpoint = `${proxyUrl}/fpp/provider/${args.provider}/remote/${args.remote}`;
             break;
     }
+    const tempRequest = new node_fetch_1.Request(proxyEndpoint, originalRequest);
+    const proxyRequest = new node_fetch_1.Request(tempRequest, { redirect: 'manual' });
+    proxyRequest.headers.set('Forge-Proxy-Target', originalRequest.url);
     proxyRequest.headers.set('Forge-Proxy-Authorization', `Bearer ${token}`);
     if (host) {
         proxyRequest.headers.set('Host', host);
     }
     return proxyRequest;
 };
-const createProxyFetch = (args) => (0, runtime_1.wrapInMetrics)(metricName(args), async (url, options) => {
-    const { proxy, metrics } = (0, runtime_1.getRuntime)();
-    const request = new node_fetch_1.Request(url, options);
-    const proxyRequest = createProxyRequest(proxy, args, request);
+const wrapWithOverheadMetric = async (fetch, metrics) => {
     const requestStart = perf_hooks_1.performance.now();
-    const response = await (0, node_fetch_1.default)(proxyRequest);
+    const response = await fetch;
     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);
     }
+    return response;
+};
+const getRedirectArgs = (args, response) => {
+    const proxyRelativeLocation = response.headers.get('forge-proxy-relative-location');
+    if (!proxyRelativeLocation) {
+        return { type: 'egress' };
+    }
+    return args;
+};
+const buildGetRequest = (url, originalRequest) => {
+    const request = new node_fetch_1.Request(url, { method: 'GET' });
+    for (const [name, values] of Array.from(originalRequest.headers.entries())) {
+        if (!name.toLowerCase().startsWith('content-')) {
+            request.headers.set(name, values);
+        }
+    }
+    return request;
+};
+const getLocation = (responseHeaders) => {
+    const location = responseHeaders.get('location');
+    if (!location) {
+        throw new errors_1.FetchError('Redirect location is empty');
+    }
+    return location;
+};
+const getRedirectUrl = (responseHeaders, original, isFromEgress) => {
+    if (!isFromEgress) {
+        return responseHeaders.get('forge-proxy-relative-location') || getLocation(responseHeaders);
+    }
+    return new URL(getLocation(responseHeaders), original).toString();
+};
+exports.getRedirectUrl = getRedirectUrl;
+const buildRedirectedRequest = (response, originalRequest, isFromEgress) => {
+    const url = (0, exports.getRedirectUrl)(response.headers, originalRequest.url, isFromEgress);
+    if (response.status === 303) {
+        return buildGetRequest(url, originalRequest);
+    }
+    return new node_fetch_1.Request(url, originalRequest);
+};
+const fetchViaProxy = async ({ proxy, proxyFetchArgs, request, metrics, count = 0 }) => {
+    const REDIRECT_STATUS = [300, 301, 302, 303, 307, 308];
+    const MAX_REDIRECTS = 20;
+    if (count >= MAX_REDIRECTS) {
+        throw new errors_1.FetchError('Max redirects exceeded');
+    }
+    const proxyRequest = createProxyRequest(proxy, proxyFetchArgs, request);
+    if (request.redirect === 'manual' && count === 0) {
+        return wrapWithOverheadMetric((0, node_fetch_1.default)(proxyRequest), metrics);
+    }
+    const response = await wrapWithOverheadMetric((0, node_fetch_1.default)(proxyRequest), metrics);
+    if (REDIRECT_STATUS.includes(response.status)) {
+        const redirectedRequest = buildRedirectedRequest(response, request, proxyFetchArgs.type === 'egress');
+        const redirectedArgs = getRedirectArgs(proxyFetchArgs, response);
+        return fetchViaProxy({
+            proxy,
+            proxyFetchArgs: redirectedArgs,
+            request: redirectedRequest,
+            metrics,
+            count: count + 1
+        });
+    }
+    return response;
+};
+const handleProxyResponseErrors = (response, requestUrl) => {
     if (response.headers.has('forge-proxy-error')) {
         const errorReason = response.headers.get('forge-proxy-error');
         if (errorReason === 'NEEDS_AUTHENTICATION_ERR') {
             throw new errors_1.NeedsAuthenticationError('Authentication Required', ATLASSIAN_TOKEN_SERVICE_KEY);
         }
         if (errorReason === 'BLOCKED_EGRESS') {
-            throw new errors_1.ExternalEndpointNotAllowedError(request.url);
+            throw new errors_1.ExternalEndpointNotAllowedError(requestUrl);
         }
         throw new errors_1.ProxyRequestError(response.status, response.headers.get('forge-proxy-error'));
     }
+};
+const createProxyFetch = (args) => (0, runtime_1.wrapInMetrics)(metricName(args), async (url, options) => {
+    const { proxy, metrics } = (0, runtime_1.getRuntime)();
+    const response = await fetchViaProxy({
+        proxy,
+        proxyFetchArgs: args,
+        request: new node_fetch_1.Request(url, options),
+        metrics
+    });
+    handleProxyResponseErrors(response, url.toString());
     return response;
 }, { tags: { proxy: 'true' } });
 exports.createProxyFetch = createProxyFetch;

package/out/api/runtime.d.ts

@@ -1,10 +1,11 @@
 import type { Metrics, Tags } from '@forge/util/packages/metrics-interface';
+export declare type ProxyInfo = {
+    token: string;
+    url: string;
+    host?: string;
+};
 export declare type ForgeRuntime = {
-    proxy: {
-        token: string;
-        url: string;
-        host?: string;
-    };
+    proxy: ProxyInfo;
     contextAri: string;
     appContext: {
         appId: string;

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,IAAI,EAAE,MAAM,wCAAwC,CAAC;AAS5E,oBAAY,YAAY,GAAG;IACzB,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,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;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,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,CAiBjC"}
+{"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;AAU5E,oBAAY,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,KAAK,EAAE,SAAS,CAAC;IACjB,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;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,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,CAiBjC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",