@forge/api 2.11.1 → 2.12.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/api
 
+## 2.12.0-next.1
+
+### Patch Changes
+
+- 82ea466: Add metrics for NodeJS runtime
+
+## 2.12.0-next.0
+
+### Minor Changes
+
+- 60a3be66: Add NodeJS runtime support for unauthenticated product requests via the api object
+
 ## 2.11.1
 
 ### Patch Changes

package/out/api/fetch.d.ts

@@ -3,7 +3,9 @@ import { RequestInfo, RequestInit, Response } from 'node-fetch';
 import { Url } from 'url';
 import { FetchAPI } from '..';
 declare type FetchFunction = (url: RequestInfo | Url, options: RequestInit | undefined) => Promise<Response>;
-export declare const createProxyFetch: (provider: 'app' | 'user' | undefined, remote: 'jira' | 'confluence' | 'stargate' | 'bitbucket') => FetchFunction;
+declare type ProxyUrlProvider = 'app' | 'user' | 'none';
+declare type ProxyUrlRemote = 'jira' | 'confluence' | 'stargate' | 'bitbucket';
+export declare const createProxyFetch: (provider: ProxyUrlProvider, remote: ProxyUrlRemote) => FetchFunction;
 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,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAK9B,aAAK,aAAa,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,EAAE,OAAO,EAAE,WAAW,GAAG,SAAS,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAIrG,eAAO,MAAM,gBAAgB,aACjB,KAAK,GAAG,MAAM,GAAG,SAAS,UAC5B,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,KACvD,aAwBF,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,aAsCrF,CAAC;AAuBF,wBAAgB,iBAAiB,IAAI,QAAQ,CAoB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -8,22 +8,54 @@ const runtime_1 = require("./runtime");
 const polyfill_response_1 = require("./polyfill-response");
 const egress_1 = require("@forge/egress");
 const errors_1 = require("./errors");
+const perf_hooks_1 = require("perf_hooks");
+const FORGE_PROXY_UPSTREAM_LATENCY_HEADER = 'forge-proxy-upstream-latency';
 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 = (provider, remote) => {
+    if (provider === 'none') {
+        return `api.${remoteToMetric[remote]}`;
+    }
+    return `api.${providerToMetric[provider]}.${remoteToMetric[remote]}`;
+};
 const createProxyFetch = (provider, remote) => {
     return async (url, options) => {
-        const { proxy } = (0, runtime_1.getRuntime)();
+        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 response = await (0, node_fetch_1.default)(proxyRequest);
-        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);
+        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'));
             }
-            throw new errors_1.ProxyRequestError(response.status, response.headers.get('forge-proxy-error'));
+            return response;
+        }
+        finally {
+            timer.stop();
         }
-        return response;
     };
 };
 exports.createProxyFetch = createProxyFetch;
@@ -41,8 +73,8 @@ const wrapExternalEgress = (url, options) => {
 function getNodeRuntimeAPI() {
     return {
         fetch: (0, _1.wrapWithRouteUnwrapper)(wrapExternalEgress),
-        requestJira: throwNotImplementedError,
-        requestConfluence: throwNotImplementedError,
+        requestJira: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)('none', 'jira')),
+        requestConfluence: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)('none', 'confluence')),
         requestBitbucket: throwNotImplementedError,
         asUser: () => ({
             requestJira: (0, _1.wrapRequestProduct)((0, exports.createProxyFetch)('user', 'jira')),

package/out/api/runtime.d.ts

@@ -1,3 +1,4 @@
+import type { Metrics } from '@forge/util/packages/metrics-interface';
 export declare type ForgeRuntime = {
     proxy: {
         token: string;
@@ -8,6 +9,7 @@ export declare type ForgeRuntime = {
     lambdaContext: {
         awsRequestId: string;
     };
+    metrics: Metrics;
 };
 export declare function getRuntime(): ForgeRuntime;
 //# 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":"AAKA,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;CACH,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,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "2.11.1",
+  "version": "2.12.0-next.1",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,13 +12,14 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
+    "@forge/util": "1.2.1",
     "nock": "^10.0.6",
     "@types/node": "^12.12.63"
   },
   "dependencies": {
-    "@forge/auth": "^0.0.1",
-    "@forge/egress": "^1.1.2",
-    "@forge/storage": "^1.3.2",
+    "@forge/auth": "0.0.1",
+    "@forge/egress": "1.1.2",
+    "@forge/storage": "1.3.2",
     "@types/node-fetch": "^2.5.7",
     "node-fetch": "2.6.7"
   }