@forge/api 3.5.0-next.1 → 3.6.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @forge/api
 
+## 3.6.0-next.0
+
+### Minor Changes
+
+- 1588c76: Embed metrics for external auth method calls in Node Runtime
+
+## 3.5.0
+
+### Minor Changes
+
+- 94956a5: Avoid logging NEEDS_AUTHENTICATION_ERR when it is thrown from requestCredentials()
+
+### Patch Changes
+
+- f8a4714: Use InMemoryMetrics from the Node monorepo
+- Updated dependencies [f8a4714]
+  - @forge/util@1.4.3
+
 ## 3.5.0-next.1
 
 ### Minor Changes

package/out/api/ari.js

@@ -10,7 +10,6 @@ class InstallationAriImpl {
     constructor(installationId) {
         this._installationId = installationId;
     }
-    _installationId;
     get installationId() {
         return this._installationId;
     }

package/out/api/errors.js

@@ -15,11 +15,11 @@ function isHostedCodeError(err) {
 }
 exports.isHostedCodeError = isHostedCodeError;
 function isExpectedError(err) {
-    return err.name === exports.NEEDS_AUTHENTICATION_ERR && !!err.options?.isExpectedError;
+    var _a;
+    return err.name === exports.NEEDS_AUTHENTICATION_ERR && !!((_a = err.options) === null || _a === void 0 ? void 0 : _a.isExpectedError);
 }
 exports.isExpectedError = isExpectedError;
 class HttpError extends Error {
-    status;
     constructor(message) {
         super(message);
     }
@@ -67,8 +67,6 @@ class InvalidWorkspaceRequestedError extends NotAllowedError {
 }
 exports.InvalidWorkspaceRequestedError = InvalidWorkspaceRequestedError;
 class NeedsAuthenticationError extends HttpError {
-    serviceKey;
-    options;
     constructor(error, serviceKey, options) {
         super(error);
         this.serviceKey = serviceKey;
@@ -80,8 +78,6 @@ class NeedsAuthenticationError extends HttpError {
 }
 exports.NeedsAuthenticationError = NeedsAuthenticationError;
 class ProxyRequestError extends HttpError {
-    status;
-    errorCode;
     constructor(status, errorCode) {
         super(`Forge platform failed to process runtime HTTP request - ${status} - ${errorCode}`);
         this.status = status;

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

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,WAAW,EAAkC,MAAM,YAAY,CAAC;AAShF,OAAO,EAIL,QAAQ,EACR,WAAW,EAEZ,MAAM,IAAI,CAAC;AAKZ,aAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC5C,aAAK,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAElE,aAAK,oBAAoB,GAAG,MAAM,CAAC;AACnC,aAAK,kBAAkB,GAAG,MAAM,CAAC;AAEjC,aAAK,SAAS,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAC/D,aAAK,qBAAqB,GAAG;IAAE,QAAQ,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAS7G,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAqBzD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,WAAW,CA0BpE;AAyGD,eAAO,MAAM,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,WAG1E,CAAC;AA2CH,wBAAgB,iBAAiB,IAAI,QAAQ,CAsB5C;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,EAAkC,MAAM,YAAY,CAAC;AAShF,OAAO,EAIL,QAAQ,EACR,WAAW,EAEZ,MAAM,IAAI,CAAC;AAKZ,aAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC5C,aAAK,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAElE,aAAK,oBAAoB,GAAG,MAAM,CAAC;AACnC,aAAK,kBAAkB,GAAG,MAAM,CAAC;AAEjC,aAAK,SAAS,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAC/D,aAAK,qBAAqB,GAAG;IAAE,QAAQ,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAuB7G,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAqBzD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,WAAW,CA0BpE;AA+GD,eAAO,MAAM,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,WAG1E,CAAC;AAkDH,wBAAgB,iBAAiB,IAAI,QAAQ,CAsB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -7,12 +7,23 @@ const _1 = require(".");
 const runtime_1 = require("./runtime");
 const polyfill_response_1 = require("./polyfill-response");
 const errors_1 = require("./errors");
+async function wrapInMetrics(options, cb) {
+    const metrics = (0, runtime_1.__getRuntime)().metrics;
+    metrics.counter(options.name, options.tags).incr();
+    const timer = metrics.timing(options.name, options.tags).measure();
+    try {
+        return await cb();
+    }
+    finally {
+        timer.stop();
+    }
+}
 function fetchProduct(args) {
     return async (path, init) => {
         const url = productURL(args.remote, path);
         init = (0, exports.addMagicAgent)(init);
         if (!hasAuthorizationHeader(init.headers)) {
-            init.headers = { ...init.headers, authorization: `Forge ${args.provider}` };
+            init.headers = Object.assign(Object.assign({}, init.headers), { authorization: `Forge ${args.provider}` });
         }
         const response = await (0, node_fetch_1.default)(url, init);
         handleProxyResponseErrors(response);
@@ -29,10 +40,7 @@ function fetchRemote(args) {
         }
         remoteUrl.searchParams.append('path', path);
         init = (0, exports.addMagicAgent)(init, 'EXTERNAL_AUTH_REQUEST');
-        init.headers = {
-            ...init.headers,
-            authorization: `Forge user ${args.provider} ${args.account}`
-        };
+        init.headers = Object.assign(Object.assign({}, init.headers), { authorization: `Forge user ${args.provider} ${args.account}` });
         const response = await (0, node_fetch_1.default)(remoteUrl, init);
         handleProxyResponseErrors(response);
         return response;
@@ -48,7 +56,7 @@ function getDefaultRemote(provider) {
 }
 function findExternalAuthProviderConfigOrThrow(provider) {
     const { externalAuth } = (0, runtime_1.__getRuntime)();
-    const externalAuthProvider = externalAuth?.find((externalAuthMetaData) => {
+    const externalAuthProvider = externalAuth === null || externalAuth === void 0 ? void 0 : externalAuth.find((externalAuthMetaData) => {
         return externalAuthMetaData.service === provider;
     });
     if (!externalAuthProvider) {
@@ -78,23 +86,21 @@ function productURL(remote, path) {
     return `https://${remote}${path}`;
 }
 function lazyThrowNeedsAuthenticationError(serviceKey) {
-    return async (scopes) => {
+    return async (scopes) => wrapInMetrics({ name: 'api.asUser.withProvider.requestCredentials', tags: { passingScopes: String(!!scopes) } }, async () => {
         throw new errors_1.NeedsAuthenticationError('Authentication Required', serviceKey, { scopes, isExpectedError: true });
-    };
+    });
 }
 function buildExternalAuthAccountsInfo(provider, remote) {
     const { accounts } = findExternalAuthProviderConfigOrThrow(provider);
     const buildAccountModel = (account) => {
-        const { externalAccountId: id, ...rest } = account;
-        return { ...rest, id };
+        const { externalAccountId: id } = account, rest = tslib_1.__rest(account, ["externalAccountId"]);
+        return Object.assign(Object.assign({}, rest), { id });
     };
     const buildExternalAuthAccountMethods = (account, outboundAuthAccountId) => ({
-        hasCredentials: async (scopes) => !scopes || scopes.every((scope) => account.scopes.includes(scope)),
+        hasCredentials: async (scopes) => wrapInMetrics({ name: 'api.asUser.withProvider.hasCredentials', tags: { passingScopes: String(!!scopes) } }, async () => !scopes || scopes.every((scope) => account.scopes.includes(scope))),
         requestCredentials: lazyThrowNeedsAuthenticationError(provider),
-        getAccount: async () => {
-            return account;
-        },
-        fetch: (0, _1.wrapWithRouteUnwrapper)(fetchRemote({ provider, remote: remote ?? getDefaultRemote(provider), account: outboundAuthAccountId }))
+        getAccount: async () => wrapInMetrics({ name: 'api.asUser.withProvider.getAccount' }, async () => account),
+        fetch: (0, _1.wrapWithRouteUnwrapper)(fetchRemote({ provider, remote: remote !== null && remote !== void 0 ? remote : getDefaultRemote(provider), account: outboundAuthAccountId }))
     });
     return accounts.map((account) => {
         const authAccount = buildAccountModel(account);
@@ -104,10 +110,7 @@ function buildExternalAuthAccountsInfo(provider, remote) {
         };
     });
 }
-const addMagicAgent = (init, agentOverride) => ({
-    ...init,
-    agent: (agentOverride ?? 'FORGE_PRODUCT_REQUEST')
-});
+const addMagicAgent = (init, agentOverride) => (Object.assign(Object.assign({}, init), { agent: (agentOverride !== null && agentOverride !== void 0 ? agentOverride : 'FORGE_PRODUCT_REQUEST') }));
 exports.addMagicAgent = addMagicAgent;
 const throwNotImplementedError = () => {
     throw new Error('not implemented');
@@ -122,16 +125,18 @@ const withProvider = (provider, remote) => {
     };
     return {
         hasCredentials: async (scopes) => {
-            return defaultAccountInfo ? await defaultAccountInfo.methods.hasCredentials(scopes) : false;
+            return defaultAccountInfo
+                ? await defaultAccountInfo.methods.hasCredentials(scopes)
+                : await wrapInMetrics({ name: 'api.asUser.withProvider.hasCredentials', tags: { passingScopes: String(!!scopes) } }, async () => false);
         },
-        getAccount: async () => {
+        getAccount: async () => wrapInMetrics({ name: 'api.asUser.withProvider.getAccount' }, async () => {
             return defaultAccountInfo ? defaultAccountInfo.account : undefined;
-        },
+        }),
         requestCredentials: lazyThrowNeedsAuthenticationError(provider),
         listCredentials: throwNotImplementedError,
-        listAccounts: async () => {
+        listAccounts: async () => wrapInMetrics({ name: 'api.asUser.withProvider.listAccounts' }, async () => {
             return accountsInfo.map(({ account }) => account);
-        },
+        }),
         asAccount: (externalAccountId) => {
             const accountInfo = accountsInfo.find(({ account }) => account.id === externalAccountId);
             if (!accountInfo) {

package/out/api/index.js

@@ -4,11 +4,8 @@ exports.wrapFetchApiMethods = exports.wrapWithRouteUnwrapper = exports.wrapReque
 const safeUrl_1 = require("../safeUrl");
 const wrapRequestGraph = (requestGraphApi) => (query, variables, headers = {}) => requestGraphApi('/graphql', {
     method: 'POST',
-    headers: { ...headers, 'Content-Type': 'application/json' },
-    body: JSON.stringify({
-        query,
-        ...(variables ? { variables } : {})
-    })
+    headers: Object.assign(Object.assign({}, headers), { 'Content-Type': 'application/json' }),
+    body: JSON.stringify(Object.assign({ query }, (variables ? { variables } : {})))
 });
 exports.wrapRequestGraph = wrapRequestGraph;
 const wrapRequestConnectedData = (fetch) => (path, init) => {

package/out/api/polyfill-response.js

@@ -4,9 +4,6 @@ exports.transformResponse = void 0;
 const node_fetch_1 = require("node-fetch");
 const transformResponse = (fetchApi) => async (url, init) => {
     const response = await fetchApi(url, init);
-    return {
-        ...response,
-        headers: new node_fetch_1.Headers(response.headers)
-    };
+    return Object.assign(Object.assign({}, response), { headers: new node_fetch_1.Headers(response.headers) });
 };
 exports.transformResponse = transformResponse;

package/out/authorization/index.js

@@ -14,15 +14,12 @@ const authorize = () => {
     if (!accountId) {
         throw new Error(`Couldn’t find the accountId of the invoking user. This API can only be used inside user-invoked modules.`);
     }
-    return {
-        ...(0, auth_1.authorizeConfluenceWithFetch)(async (path, opts) => {
-            const res = await (0, __1.asUser)().requestConfluence((0, __1.assumeTrustedRoute)(path), opts);
-            return res.json();
-        }, accountId),
-        ...(0, auth_1.authorizeJiraWithFetch)(async (path, opts) => {
-            const res = await (0, __1.asUser)().requestJira((0, __1.assumeTrustedRoute)(path), opts);
-            return res.json();
-        }, accountId)
-    };
+    return Object.assign(Object.assign({}, (0, auth_1.authorizeConfluenceWithFetch)(async (path, opts) => {
+        const res = await (0, __1.asUser)().requestConfluence((0, __1.assumeTrustedRoute)(path), opts);
+        return res.json();
+    }, accountId)), (0, auth_1.authorizeJiraWithFetch)(async (path, opts) => {
+        const res = await (0, __1.asUser)().requestJira((0, __1.assumeTrustedRoute)(path), opts);
+        return res.json();
+    }, accountId));
 };
 exports.authorize = authorize;

package/out/index.js

@@ -44,10 +44,7 @@ const storage = (0, storage_1.getStorageInstanceWithQuery)(new storage_1.GlobalS
 exports.storage = storage;
 const properties = properties_1.propertiesApi;
 exports.properties = properties;
-const API = {
-    ...fetchAPI,
-    store: { ...store }
-};
+const API = Object.assign(Object.assign({}, fetchAPI), { store: Object.assign({}, store) });
 exports.privacy = {
     reportPersonalData: (0, privacy_1.createReportPersonalData)((0, fetch_and_storage_1.createRequestStargateAsApp)())
 };

package/out/properties/product-scoped-storage.js

@@ -3,8 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductScopedStorage = void 0;
 const storage_1 = require("@forge/storage");
 class ProductScopedStorage {
-    storageApiPath;
-    apiClient;
     constructor(storageApiPath, apiClient) {
         this.storageApiPath = storageApiPath;
         this.apiClient = apiClient;

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

@@ -3,10 +3,11 @@ 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 = () => global.api?.asApp().__requestAtlassian ?? (0, fetch_1.fetchProduct)({ 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 = () => {
-    const sandboxGetAppAri = global.api?.__getAppAri;
+    var _a;
+    const sandboxGetAppAri = (_a = global.api) === null || _a === void 0 ? void 0 : _a.__getAppAri;
     if (sandboxGetAppAri) {
         return sandboxGetAppAri();
     }

package/out/safeUrl.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assumeTrustedRoute = exports.requireSafeUrl = exports.route = exports.routeFromAbsolute = exports.isRoute = void 0;
 class ReadonlyRoute {
-    value_;
     constructor(value_) {
         this.value_ = value_;
     }

package/out/webTrigger.js

@@ -4,6 +4,7 @@ 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, forceCreate) => {
+    var _a, _b;
     const runtime = (0, runtime_1.__getRuntime)();
     const response = await (0, fetch_and_storage_1.createRequestStargateAsApp)()('/graphql', {
         method: 'POST',
@@ -31,13 +32,14 @@ const proxyGetWebTriggerURL = (0, runtime_1.wrapInMetrics)('api.getWebTriggerUrl
         throw new Error(`Internal error occurred: Failed to get web trigger URL: ${response.statusText}.`);
     }
     const responseBody = await response.json();
-    if (!responseBody?.data?.createWebTriggerUrl?.url) {
+    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;
 });
 const proxyDeleteWebTriggerURL = (0, runtime_1.wrapInMetrics)('api.deleteWebTriggerUrl', async (webTriggerUrl) => {
     const callDelete = async (webTriggerUrlId) => {
+        var _a, _b, _c, _d;
         const response = await (0, fetch_and_storage_1.createRequestStargateAsApp)()('/graphql', {
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
@@ -59,8 +61,8 @@ const proxyDeleteWebTriggerURL = (0, runtime_1.wrapInMetrics)('api.deleteWebTrig
             throw new Error(`Internal error occurred: Failed to delete web trigger URL: ${response.statusText}.`);
         }
         const responseBody = await response.json();
-        if (!responseBody?.data?.deleteWebTriggerUrl?.success) {
-            const errorText = responseBody?.data?.deleteWebTriggerUrl?.message || 'unknown error';
+        if (!((_b = (_a = responseBody === null || responseBody === void 0 ? void 0 : responseBody.data) === null || _a === void 0 ? void 0 : _a.deleteWebTriggerUrl) === null || _b === void 0 ? void 0 : _b.success)) {
+            const errorText = ((_d = (_c = responseBody === null || responseBody === void 0 ? void 0 : responseBody.data) === null || _c === void 0 ? void 0 : _c.deleteWebTriggerUrl) === null || _d === void 0 ? void 0 : _d.message) || 'unknown error';
             throw new Error(`Internal error occurred: Failed to delete web trigger URL: ${errorText}`);
         }
     };
@@ -70,6 +72,7 @@ const proxyDeleteWebTriggerURL = (0, runtime_1.wrapInMetrics)('api.deleteWebTrig
     }
 });
 const proxyGetWebTriggerUrlIds = (0, runtime_1.wrapInMetrics)('api.getWebTriggerUrlIds', async (webTriggerUrl) => {
+    var _a;
     const runtime = (0, runtime_1.__getRuntime)();
     const response = await (0, fetch_and_storage_1.createRequestStargateAsApp)()('/graphql', {
         method: 'POST',
@@ -94,7 +97,7 @@ const proxyGetWebTriggerUrlIds = (0, runtime_1.wrapInMetrics)('api.getWebTrigger
         throw new Error(`Internal error occurred: Failed to get web trigger URLs: ${response.statusText}.`);
     }
     const responseBody = await response.json();
-    if (!responseBody?.data?.webTriggerUrlsByAppContext || responseBody.data.webTriggerUrlsByAppContext.length == 0) {
+    if (!((_a = responseBody === null || responseBody === void 0 ? void 0 : responseBody.data) === null || _a === void 0 ? void 0 : _a.webTriggerUrlsByAppContext) || responseBody.data.webTriggerUrlsByAppContext.length == 0) {
         throw new Error('Internal error occurred: No web trigger URLs found');
     }
     const result = responseBody.data.webTriggerUrlsByAppContext
@@ -106,7 +109,7 @@ const proxyGetWebTriggerUrlIds = (0, runtime_1.wrapInMetrics)('api.getWebTrigger
     return result;
 });
 exports.webTrigger = {
-    getUrl: async (webTriggerModuleKey, forceCreate = false) => (global.api?.webTrigger?.getUrl ?? proxyGetWebTriggerURL)(webTriggerModuleKey, forceCreate),
-    deleteUrl: async (webTriggerUrl) => (global.api?.webTrigger?.deleteUrl ?? proxyDeleteWebTriggerURL)(webTriggerUrl),
-    getUrlIds: async (webTriggerUrl) => (global.api?.webTrigger?.getUrlIds ?? proxyGetWebTriggerUrlIds)(webTriggerUrl)
+    getUrl: async (webTriggerModuleKey, forceCreate = false) => { 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, forceCreate); },
+    deleteUrl: async (webTriggerUrl) => { 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.deleteUrl) !== null && _c !== void 0 ? _c : proxyDeleteWebTriggerURL)(webTriggerUrl); },
+    getUrlIds: async (webTriggerUrl) => { 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.getUrlIds) !== null && _c !== void 0 ? _c : proxyGetWebTriggerUrlIds)(webTriggerUrl); }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "3.5.0-next.1",
+  "version": "3.6.0-next.0",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,7 +12,7 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
-    "@forge/runtime": "5.6.1-next.1",
+    "@forge/runtime": "5.8.0-next.0",
     "@types/node": "14.18.63",
     "expect-type": "^0.17.3",
     "jest-matcher-specific-error": "^1.0.0",
@@ -22,7 +22,7 @@
     "@forge/auth": "0.0.5",
     "@forge/egress": "1.2.13",
     "@forge/storage": "1.5.15",
-    "@forge/util": "1.4.3-next.0",
+    "@forge/util": "1.4.3",
     "@types/node-fetch": "^2.6.11",
     "node-fetch": "2.7.0"
   }