@forge/cache 0.7.0-next.1 → 0.7.0-next.3

package/README.md

@@ -21,4 +21,10 @@ const result = await cacheClient.decrementAndGet("hello");
 const result = await cacheClient.delete("hello");
 
 const result = await cacheClient.scan("hello*", { cursor: "10", count: 10 });
+
+const result = await cacheClient.leftPush("list", "3");
+
+const result = await cacheClient.rightPop("list");
+
+const result = await cacheClient.listLength("list");
 ```

package/out/__test__/cache.test.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const api_1 = require("@forge/api");
 const cache_1 = require("../cache");
+jest.mock('node-fetch');
+const fetchMock = node_fetch_1.default;
 describe('connect', () => {
-    let fetchMock;
     describe('v1', () => {
         beforeEach(() => {
-            fetchMock = jest.fn();
+            jest.resetAllMocks();
+            jest.clearAllMocks();
             global['api'] = { requestRmsStore: fetchMock };
         });
         afterAll(() => {
@@ -18,12 +22,7 @@ describe('connect', () => {
         });
     });
     describe('v2', () => {
-        let fetchMock;
-        let orgFetch;
         beforeEach(() => {
-            fetchMock = jest.fn();
-            orgFetch = global['fetch'];
-            global['fetch'] = fetchMock;
             global['__forge_runtime__'] = {
                 proxy: {
                     token: 'token',
@@ -39,9 +38,6 @@ describe('connect', () => {
                 }
             };
         });
-        afterAll(() => {
-            global['fetch'] = orgFetch;
-        });
         it('chooses the v2 fetch based on runtime', async () => {
             const cacheClient = (0, cache_1.connect)();
             await cacheClient['client']('asdf');
@@ -50,16 +46,6 @@ describe('connect', () => {
     });
 });
 describe('createFetch', () => {
-    let fetchMock;
-    let orgFetch;
-    beforeEach(() => {
-        fetchMock = jest.fn();
-        orgFetch = global['fetch'];
-        global['fetch'] = fetchMock;
-    });
-    afterAll(() => {
-        global['fetch'] = orgFetch;
-    });
     it('fetch fails when rms config is not available', async () => {
         global['__forge_runtime__'] = {
             proxy: {
@@ -88,8 +74,8 @@ describe('createFetch', () => {
         const fetch = (0, cache_1.createFetchRmsRuntimeV2)();
         await fetch('path');
         const [absoluteUrl, options] = (_a = fetchMock.mock.lastCall) !== null && _a !== void 0 ? _a : ['', {}];
-        expect(absoluteUrl).toEqual('https://dev.services.atlassian.com/path');
-        expect((options === null || options === void 0 ? void 0 : options.agent)['keepAlive']).toBeTruthy();
+        expect(absoluteUrl.toString()).toEqual('https://rms/path');
+        expect((options === null || options === void 0 ? void 0 : options.agent)['passthrough']['keepAlive']).toBeTruthy();
         expect(options === null || options === void 0 ? void 0 : options.headers).toMatchObject({
             Authorization: 'Bearer token',
             Host: 'rockmelon-storage.dev.atl-paas.net',
@@ -305,4 +291,63 @@ describe('Cache', () => {
             expect(fetch.mock.lastCall).toMatchSnapshot();
         });
     });
+    describe('leftPush', () => {
+        it('handles success', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 1 }), status: 200 });
+            const result = await cache.leftPush('list', 'value');
+            expect(result).toEqual(1);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles failure', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: false, text: async () => 'Not allowed', status: 403 });
+            await expect(cache.leftPush('list', 'value')).rejects.toMatchError(new api_1.HttpError('403: Not allowed'));
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+    });
+    describe('rightPop', () => {
+        it('handles success', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 'value' }), status: 200 });
+            const result = await cache.rightPop('list');
+            expect(result).toEqual('value');
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles success when key does not exist', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: null }), status: 200 });
+            const result = await cache.rightPop('list');
+            expect(result).toBeNull();
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles failure', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: false, text: async () => 'Not allowed', status: 403 });
+            await expect(cache.rightPop('list')).rejects.toMatchError(new api_1.HttpError('403: Not allowed'));
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+    });
+    describe('listLength', () => {
+        it('handles success', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 2 }), status: 200 });
+            const result = await cache.listLength('list');
+            expect(result).toBe(2);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles success when key does not exist', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 0 }), status: 200 });
+            const result = await cache.listLength('list');
+            expect(result).toBe(0);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles failure', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: false, text: async () => 'Not allowed', status: 403 });
+            await expect(cache.listLength('list')).rejects.toMatchError(new api_1.HttpError('403: Not allowed'));
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+    });
 });

package/out/cache.d.ts

@@ -26,6 +26,9 @@ export declare class Cache {
         cursor?: string;
         count?: number;
     }): Promise<ScanResult>;
+    leftPush(key: string, value: string): Promise<number>;
+    rightPop(key: string): Promise<string | null>;
+    listLength(key: string): Promise<number>;
 }
 export declare function getFetchRmsRuntimeV1(): ((path: string, options?: RequestInit) => Promise<Response>) | undefined;
 export declare function createFetchRmsRuntimeV2(): (path: string, options?: RequestInit) => Promise<Response>;

package/out/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAkB,EAAE,WAAW,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAInF,oBAAY,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAEzE,oBAAY,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAGF,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAYtE;AAED,qBAAa,KAAK;IACJ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAGtF,OAAO,CAAC,YAAY;IAUP,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5E,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAO9F,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOxC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO3F,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOpC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC;CAMnG;AAED,wBAAgB,oBAAoB,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAE/G;AAID,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CA4BpG;AAED,wBAAgB,OAAO,UAItB"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAkB,EAAE,WAAW,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAInF,oBAAY,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAEzE,oBAAY,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAGF,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAYtE;AAED,qBAAa,KAAK;IACJ,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAGtF,OAAO,CAAC,YAAY;IAUP,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5E,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAO9F,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOxC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO3F,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOpC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAOrF,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO7C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAMtD;AAED,wBAAgB,oBAAoB,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAG/G;AAID,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CA0BpG;AAED,wBAAgB,OAAO,UAItB"}

package/out/cache.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.connect = exports.createFetchRmsRuntimeV2 = exports.getFetchRmsRuntimeV1 = exports.Cache = exports.getResponseBody = void 0;
+const tslib_1 = require("tslib");
 const https_1 = require("https");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const api_1 = require("@forge/api");
 async function getResponseBody(response) {
     const responseText = await response.text();
@@ -68,6 +70,21 @@ class Cache {
         const response = await this.client('rms/store/scan', this.buildRequest({ cursor, pattern, count }));
         return await getResponseBody(response);
     }
+    async leftPush(key, value) {
+        const response = await this.client('rms/store/lpush', this.buildRequest({ key, value }));
+        const { response: result } = await getResponseBody(response);
+        return result;
+    }
+    async rightPop(key) {
+        const response = await this.client('rms/store/rpop', this.buildRequest({ key }));
+        const { response: result } = await getResponseBody(response);
+        return result;
+    }
+    async listLength(key) {
+        const response = await this.client('rms/store/llen', this.buildRequest({ key }));
+        const { response: result } = await getResponseBody(response);
+        return result;
+    }
 }
 exports.Cache = Cache;
 function getFetchRmsRuntimeV1() {
@@ -82,8 +99,9 @@ function createFetchRmsRuntimeV2() {
         if (!(rms === null || rms === void 0 ? void 0 : rms.url) || !(rms === null || rms === void 0 ? void 0 : rms.host)) {
             throw new Error('RMS config not available.');
         }
-        const rmsFullUrl = new URL(rms.url) + path;
-        return await global['fetch'](rmsFullUrl, Object.assign(Object.assign({}, options), { agent, headers: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.headers), { Authorization: `Bearer ${proxy.token}`, Host: rms.host, 'x-b3-traceid': tracing.traceId, 'x-b3-spanid': tracing.spanId }) }));
+        const rmsAgent = new String('FORGE_PRODUCT_REQUEST');
+        rmsAgent['passthrough'] = agent;
+        return await (0, node_fetch_1.default)(new URL(path, 'https://rms/'), Object.assign(Object.assign({}, options), { agent: rmsAgent, headers: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.headers), { Authorization: `Bearer ${proxy.token}`, Host: rms.host, 'x-b3-traceid': tracing.traceId, 'x-b3-spanid': tracing.spanId }) }));
     };
 }
 exports.createFetchRmsRuntimeV2 = createFetchRmsRuntimeV2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cache",
-  "version": "0.7.0-next.1",
+  "version": "0.7.0-next.3",
   "description": "Forge Cache methods",
   "author": "Atlassian",
   "license": "UNLICENSED",