@forge/cache 0.3.2-next.0 → 0.4.0-next.2

package/README.md

@@ -12,9 +12,13 @@ const result = await cacheClient.setIfNotExists("hello", "3", { ttlSeconds: 10 }
 
 const result = await cacheClient.get("hello");
 
+const result = await cacheClient.getAndSet("hello", "3", { ttlSeconds: 10 });
+
 const result = await cacheClient.incrementAndGet("hello");
 
 const result = await cacheClient.decrementAndGet("hello");
 
 const result = await cacheClient.delete("hello");
+
+const result = await cacheClient.scan("hello*", { cursor: "10", count: 10 });
 ```

package/out/__test__/cache.test.js

@@ -155,11 +155,22 @@ describe('Cache', () => {
     describe('get', () => {
         it('handles success', async () => {
             const { cache, fetch } = buildCache();
-            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ value: 'asdfasdf' }), status: 200 });
+            fetch.mockResolvedValueOnce({
+                ok: true,
+                text: async () => JSON.stringify({ response: 'asdfasdf' }),
+                status: 200
+            });
             const result = await cache.get('key');
             expect(result).toEqual('asdfasdf');
             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.get('key');
+            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 });
@@ -167,6 +178,42 @@ describe('Cache', () => {
             expect(fetch.mock.lastCall).toMatchSnapshot();
         });
     });
+    describe('getAndSet', () => {
+        it('handles success', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({
+                ok: true,
+                text: async () => JSON.stringify({ response: 'oldValue' }),
+                status: 200
+            });
+            const result = await cache.getAndSet('key', 'newValue');
+            expect(result).toEqual('oldValue');
+            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.getAndSet('key', 'value');
+            expect(result).toBeNull();
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles success with ttl', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({
+                ok: true,
+                text: async () => JSON.stringify({ response: 'oldValue' }),
+                status: 200
+            });
+            await cache.getAndSet('key', 'newValue', { ttlSeconds: 100 });
+            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.getAndSet('key', 'value', { ttlSeconds: 100 })).rejects.toMatchError(new api_1.HttpError('403: Not allowed'));
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+    });
     describe('incrementAndGet', () => {
         it('handles success', async () => {
             const { cache, fetch } = buildCache();
@@ -226,4 +273,36 @@ describe('Cache', () => {
             expect(fetch.mock.lastCall).toMatchSnapshot();
         });
     });
+    describe('scan', () => {
+        it('handles success', async () => {
+            const { cache, fetch } = buildCache();
+            const expectedResponse = { cursor: '0', keys: ['key1', 'key2'] };
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify(expectedResponse), status: 200 });
+            const actualResponse = await cache.scan('key*');
+            expect(actualResponse).toEqual(expectedResponse);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles success with cursor', async () => {
+            const { cache, fetch } = buildCache();
+            const expectedResponse = { cursor: '0', keys: ['key2'] };
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify(expectedResponse), status: 200 });
+            const actualResponse = await cache.scan('key*', { cursor: '1' });
+            expect(actualResponse).toEqual(expectedResponse);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+        it('handles success with count', async () => {
+            const { cache, fetch } = buildCache();
+            const expectedResponse = { cursor: '0', keys: ['key1'] };
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify(expectedResponse), status: 200 });
+            const actualResponse = await cache.scan('key*', { count: 1 });
+            expect(actualResponse).toEqual(expectedResponse);
+            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.scan('key*', { cursor: '0', count: 2 })).rejects.toMatchError(new api_1.HttpError('403: Not allowed'));
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
+    });
 });

package/out/cache.d.ts

@@ -11,10 +11,17 @@ export declare class Cache {
     setIfNotExists(key: string, value: string, opt?: {
         ttlSeconds: number;
     }): Promise<'OK' | null>;
-    get(key: string): Promise<string>;
+    get(key: string): Promise<string | null>;
+    getAndSet(key: string, value: string, opt?: {
+        ttlSeconds: number;
+    }): Promise<string | null>;
     incrementAndGet(key: string): Promise<number>;
     decrementAndGet(key: string): Promise<number>;
     delete(key: string): Promise<number>;
+    scan(pattern: string, opt?: {
+        cursor?: string;
+        count?: number;
+    }): Promise<JSON>;
 }
 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,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAGzE,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,CAAC;IAOjC,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;CAMlD;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,CA2BpG;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,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAGzE,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,IAAI,CAAC;CAM7F;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,CA2BpG;AAED,wBAAgB,OAAO,UAItB"}

package/out/cache.js

@@ -40,7 +40,12 @@ class Cache {
     }
     async get(key) {
         const response = await this.client('rms/store/get', this.buildRequest({ key }));
-        const { value: result } = await getResponseBody(response);
+        const { response: result } = await getResponseBody(response);
+        return result;
+    }
+    async getAndSet(key, value, opt) {
+        const response = await this.client('rms/store/getset', this.buildRequest(Object.assign({ key, value }, opt)));
+        const { response: result } = await getResponseBody(response);
         return result;
     }
     async incrementAndGet(key) {
@@ -58,6 +63,11 @@ class Cache {
         const { response: result } = await getResponseBody(response);
         return result;
     }
+    async scan(pattern, opt) {
+        const { cursor, count } = opt || {};
+        const response = await this.client('rms/store/scan', this.buildRequest({ cursor, pattern, count }));
+        return await getResponseBody(response);
+    }
 }
 exports.Cache = Cache;
 function getFetchRmsRuntimeV1() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cache",
-  "version": "0.3.2-next.0",
+  "version": "0.4.0-next.2",
   "description": "Forge Cache methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -16,10 +16,10 @@
   },
   "devDependencies": {
     "@types/node": "14.18.59",
-    "@types/node-fetch": "^2.6.4",
+    "@types/node-fetch": "^2.6.5",
     "node-fetch": "2.7.0"
   },
   "dependencies": {
-    "@forge/api": "^2.19.1-next.0"
+    "@forge/api": "^2.19.1-next.1"
   }
 }