@forge/api 2.18.3-next.0 → 2.18.3-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/api
 
+## 2.18.3-next.1
+
+### Patch Changes
+
+- 88be9538: Use HTTP polyfill to call proxy
+
 ## 2.18.3-next.0
 
 ### Patch Changes

package/out/api/fetch.d.ts

@@ -1,17 +1,13 @@
-import { RequestInfo, RequestInit, Response, Headers } from 'node-fetch';
-import { FetchAPI } from '..';
-type FetchFunction = (url: RequestInfo, options?: RequestInit) => Promise<Response>;
-type ProxyUrlProvider = 'app' | 'user' | 'none';
-type ProxyUrlRemote = 'jira' | 'confluence' | 'stargate' | 'bitbucket';
-type ProxyFetchArgs = {
-    type: 'fpp';
-    provider: ProxyUrlProvider;
-    remote: ProxyUrlRemote;
-} | {
-    type: 'egress';
+import { RequestInit } from 'node-fetch';
+import { FetchAPI, FetchMethod } from '..';
+type AuthProvider = 'app' | 'user' | 'none';
+type RemoteAPI = 'jira' | 'confluence' | 'stargate' | 'bitbucket';
+type FetchArgs = {
+    provider: AuthProvider;
+    remote: RemoteAPI;
 };
-export declare const getRedirectUrl: (responseHeaders: Headers, original: string, isFromEgress: boolean) => string;
-export declare const createProxyFetch: (args: ProxyFetchArgs) => FetchFunction;
+export declare function fetchProduct(args: FetchArgs): FetchMethod;
+export declare const addMagicAgent: (init?: RequestInit) => RequestInit;
 export declare function getNodeRuntimeAPI(): FetchAPI;
 export declare function getSandboxRuntimeAPI(api: any): FetchAPI;
 export {};

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,OAAO,EAAE,MAAM,YAAY,CAAC;AAEzF,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAS9B,KAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AACpF,KAAK,gBAAgB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,KAAK,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AA4BvE,KAAK,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"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,WAAW,EAAY,MAAM,YAAY,CAAC;AAG1D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAI3C,KAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC5C,KAAK,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAElE,KAAK,SAAS,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAS/D,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAkBzD;AAgCD,eAAO,MAAM,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,KAAK,WAGlD,CAAC;AAOH,wBAAgB,iBAAiB,IAAI,QAAQ,CAoB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -1,171 +1,61 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.createProxyFetch = exports.getRedirectUrl = void 0;
+exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.addMagicAgent = exports.fetchProduct = void 0;
 const tslib_1 = require("tslib");
-const node_fetch_1 = tslib_1.__importStar(require("node-fetch"));
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const _1 = require(".");
-const runtime_1 = require("./runtime");
 const polyfill_response_1 = require("./polyfill-response");
 const errors_1 = require("./errors");
-const perf_hooks_1 = require("perf_hooks");
-const FORGE_PROXY_UPSTREAM_LATENCY_HEADER = 'forge-proxy-upstream-latency';
+function fetchProduct(args) {
+    return async (path, init) => {
+        const url = productURL(args.remote, path);
+        init = (0, exports.addMagicAgent)(init);
+        init.headers = Object.assign(Object.assign({}, init.headers), { authorization: `Forge ${args.provider}` });
+        const response = await (0, node_fetch_1.default)(url, init);
+        handleProxyResponseErrors(response);
+        return response;
+    };
+}
+exports.fetchProduct = fetchProduct;
 const ATLASSIAN_TOKEN_SERVICE_KEY = 'atlassian-token-service-key';
-const providerToMetric = {
-    app: 'asApp',
-    user: 'asUser'
-};
-const remoteToMetric = {
-    jira: 'requestJira',
-    confluence: 'requestConfluence',
-    bitbucket: 'requestBitbucket',
-    stargate: 'requestAtlassian'
-};
-const metricName = (args) => {
-    switch (args.type) {
-        case 'egress':
-            return 'api.fetch';
-        case 'fpp':
-            if (args.provider === 'none') {
-                return `api.${remoteToMetric[args.remote]}`;
-            }
-            return `api.${providerToMetric[args.provider]}.${remoteToMetric[args.remote]}`;
-    }
-};
-const createProxyRequest = ({ url: proxyUrl, token, host }, args, originalRequest) => {
-    let proxyEndpoint;
-    switch (args.type) {
-        case 'egress':
-            proxyEndpoint = `${proxyUrl}/egress`;
-            break;
-        case 'fpp':
-            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 wrapWithOverheadMetric = async (fetch, metrics) => {
-    const requestStart = perf_hooks_1.performance.now();
-    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) => {
+const handleProxyResponseErrors = (response) => {
     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(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;
+function productURL(remote, path) {
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+    return `https://${remote}${path}`;
+}
+const addMagicAgent = (init) => (Object.assign(Object.assign({}, init), { agent: 'FORGE_PRODUCT_REQUEST' }));
+exports.addMagicAgent = addMagicAgent;
 const throwNotImplementedError = () => {
     throw new Error('not implemented');
 };
 function getNodeRuntimeAPI() {
     return {
-        fetch: (0, _1.wrapWithRouteUnwrapper)((0, exports.createProxyFetch)({ type: 'egress' })),
-        requestJira: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'none', remote: 'jira' })),
-        requestConfluence: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'none', remote: 'confluence' })),
-        requestBitbucket: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'none', remote: 'bitbucket' })),
+        fetch: (0, _1.wrapWithRouteUnwrapper)(node_fetch_1.default),
+        requestJira: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'none', remote: 'jira' })),
+        requestConfluence: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'none', remote: 'confluence' })),
+        requestBitbucket: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'none', remote: 'bitbucket' })),
         asUser: () => ({
-            requestJira: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'user', remote: 'jira' })),
-            requestConfluence: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'user', remote: 'confluence' })),
-            requestBitbucket: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'user', remote: 'bitbucket' })),
-            requestGraph: (0, _1.wrapRequestGraph)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'user', remote: 'stargate' })),
+            requestJira: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'user', remote: 'jira' })),
+            requestConfluence: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'user', remote: 'confluence' })),
+            requestBitbucket: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'user', remote: 'bitbucket' })),
+            requestGraph: (0, _1.wrapRequestGraph)(fetchProduct({ provider: 'user', remote: 'stargate' })),
             withProvider: throwNotImplementedError
         }),
         asApp: () => ({
-            requestJira: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'app', remote: 'jira' })),
-            requestConfluence: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'app', remote: 'confluence' })),
-            requestBitbucket: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'app', remote: 'bitbucket' })),
-            requestGraph: (0, _1.wrapRequestGraph)((0, exports.createProxyFetch)({ type: 'fpp', provider: 'app', remote: 'stargate' }))
+            requestJira: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'app', remote: 'jira' })),
+            requestConfluence: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'app', remote: 'confluence' })),
+            requestBitbucket: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'app', remote: 'bitbucket' })),
+            requestGraph: (0, _1.wrapRequestGraph)(fetchProduct({ provider: 'app', remote: 'stargate' }))
         })
     };
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,QAAQ,EAER,WAAW,EAEX,oBAAoB,EACpB,wBAAwB,EAGxB,WAAW,EACZ,MAAM,IAAI,CAAC;AAIZ,MAAM,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAElH,eAAO,MAAM,gBAAgB,oBAAqB,WAAW,aAAa,MAAM,cAAc,GAAG,uCAQ7F,CAAC;AAEL,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,EAAE,WAAW,KAAK,oBAGpD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,EAAE,WAAW,KAAK,wBAGxD,CAAC;AAEF,eAAO,MAAM,mBAAmB,QAAS,GAAG,aAAa,YAAY,KAAG,QAkCvE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,QAAQ,EAER,WAAW,EAEX,oBAAoB,EACpB,wBAAwB,EAGxB,WAAW,EACZ,MAAM,IAAI,CAAC;AAIZ,MAAM,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAElH,eAAO,MAAM,gBAAgB,oBACT,WAAW,aACrB,MAAM,cAAc,GAAG,uCAQ3B,CAAC;AAEP,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,EAAE,WAAW,KAAK,oBAGpD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,EAAE,WAAW,KAAK,wBAGxD,CAAC;AAEF,eAAO,MAAM,mBAAmB,QAAS,GAAG,aAAa,YAAY,KAAG,QAkCvE,CAAC"}

package/out/api/polyfill-response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"polyfill-response.d.ts","sourceRoot":"","sources":["../../src/api/polyfill-response.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AAGjC,eAAO,MAAM,iBAAiB,EAAE,YAM/B,CAAC"}
+{"version":3,"file":"polyfill-response.d.ts","sourceRoot":"","sources":["../../src/api/polyfill-response.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AAGjC,eAAO,MAAM,iBAAiB,EAAE,YAQ7B,CAAC"}

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

@@ -1,5 +1,5 @@
-import { createProxyFetch } from '../api/fetch';
-export declare const createRequestStargateAsApp: () => ReturnType<typeof createProxyFetch>;
+import { FetchMethod } from '..';
+export declare const createRequestStargateAsApp: () => FetchMethod;
 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":"AAAA,OAAO,EAAE,gBAAgB,EAA2C,MAAM,cAAc,CAAC;AAGzF,eAAO,MAAM,0BAA0B,EAAE,MAAM,UAAU,CAAC,OAAO,gBAAgB,CAET,CAAC;AAEzE,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,WAAW,EAAE,MAAM,IAAI,CAAC;AAIjC,eAAO,MAAM,0BAA0B,EAAE,MAAM,WAC2D,CAAC;AAE3G,eAAO,MAAM,aAAa,WAQzB,CAAC;AAEF,eAAO,MAAM,WAAW,6BAOvB,CAAC"}

package/out/runtime/fetch-and-storage.js

@@ -3,10 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFetchAPI = exports.getContextAri = exports.createRequestStargateAsApp = void 0;
 const fetch_1 = require("../api/fetch");
 const runtime_1 = require("../api/runtime");
-const createRequestStargateAsApp = () => {
-    var _a, _b;
-    return (_b = (_a = global.api) === null || _a === void 0 ? void 0 : _a.asApp().__requestAtlassian) !== null && _b !== void 0 ? _b : (0, fetch_1.createProxyFetch)({ type: 'fpp', provider: 'app', remote: 'stargate' });
-};
+const createRequestStargateAsApp = () => { var _a, _b; return (_b = (_a = global.api) === null || _a === void 0 ? void 0 : _a.asApp().__requestAtlassian) !== null && _b !== void 0 ? _b : (0, fetch_1.fetchProduct)({ provider: 'app', remote: 'stargate' }); };
 exports.createRequestStargateAsApp = createRequestStargateAsApp;
 const getContextAri = () => {
     var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "2.18.3-next.0",
+  "version": "2.18.3-next.1",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,7 +12,7 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
-    "@forge/runtime": "4.4.5-next.0",
+    "@forge/runtime": "4.4.5-next.1",
     "@types/node": "14.18.53",
     "jest-matcher-specific-error": "^1.0.0",
     "nock": "^10.0.6"