add a couple tests

6 · 6 · commit ea9c7af74bf3 · 2022-12-11T01:30:14.000-05:00
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -32,3 +32,6 @@ jobs:
 
       - name: ESLint
         run: yarn lint
+
+      - name: Test
+        run: yarn test
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "jest": "^29.3.1",
     "openai": "^3.1.0",
     "prettier": "^2.8.1",
+    "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.1",
     "tsconfig-paths-jest": "^0.0.1",
@@ -36,7 +37,8 @@
     "lint": "yarn lint:ts --cache",
     "lint:ci": "yarn lint:ts",
     "lint:ts": "eslint . --ext .js,.ts,.json",
-    "prettier:all": "prettier --write \"**/*.+(js|jsx|ts|tsx|json|css|html)\""
+    "prettier:all": "prettier --write \"**/*.+(js|jsx|ts|tsx|json|css|html)\"",
+    "test": "jest --config test/jest.config.js"
   },
   "dependencies": {
     "@upstash/redis": "^1.18.1"
diff --git a/src/cache.test.ts b/src/cache.test.ts
@@ -0,0 +1,39 @@
+import { getCacheKey } from './cache';
+import { objectHash } from './utils';
+
+jest.mock('./utils.ts');
+
+describe('cache', () => {
+  describe('getCacheKey', () => {
+    beforeEach(() => {
+      (objectHash as jest.Mock).mockReturnValue('unique-sha-hash');
+    });
+
+    it('returns a hash uniquely representing the params', async () => {
+      const params = {
+        method: 'POST',
+        path: '/v1/completions',
+        authHeader: 'api-key',
+        body: '{ "ok": true }',
+      };
+      const result = await getCacheKey(params);
+      expect(objectHash).toHaveBeenCalledWith(params);
+      expect(result).toEqual('unique-sha-hash');
+    });
+
+    it('removes null or empty values', async () => {
+      const params = {
+        method: 'POST',
+        path: '/v1/completions',
+        authHeader: null,
+        body: '',
+      };
+      const result = await getCacheKey(params);
+      expect(objectHash).toHaveBeenCalledWith({
+        method: 'POST',
+        path: '/v1/completions',
+      });
+      expect(result).toEqual('unique-sha-hash');
+    });
+  });
+});
diff --git a/src/cache.ts b/src/cache.ts
@@ -1,18 +1,6 @@
 import { Redis } from '@upstash/redis/cloudflare';
 import { Env } from './env';
-import { getHeadersAsObject } from './utils';
-
-export const objectHash = async (obj: Record<string, any>): Promise<string> => {
-  const stringifiedObj = JSON.stringify(obj);
-  const arrayBuffer = await crypto.subtle.digest(
-    {
-      name: 'SHA-256',
-    },
-    new TextEncoder().encode(stringifiedObj),
-  );
-  // https://github.com/cmackenzie1/holster/tree/main/workers/hash
-  return [...new Uint8Array(arrayBuffer)].map((x) => x.toString(16).padStart(2, '0')).join('');
-};
+import { getHeadersAsObject, objectHash } from './utils';
 
 interface GetCacheKeyProps {
   method: string;
diff --git a/src/utils.ts b/src/utils.ts
@@ -1,9 +1,22 @@
+// Return `Headers` as an Object:
 type HeadersObject = Record<string, string>;
-
 export const getHeadersAsObject = (headers: Headers): HeadersObject => {
   const headersObject: HeadersObject = {};
   for (const [key, value] of headers.entries()) {
     headersObject[key] = value;
   }
   return headersObject;
 };
+
+// Return a sha256 hash for a given Object:
+export const objectHash = async (obj: Record<string, any>): Promise<string> => {
+  const stringifiedObj = JSON.stringify(obj);
+  const arrayBuffer = await crypto.subtle.digest(
+    {
+      name: 'SHA-256',
+    },
+    new TextEncoder().encode(stringifiedObj),
+  );
+  // https://github.com/cmackenzie1/holster/tree/main/workers/hash
+  return [...new Uint8Array(arrayBuffer)].map((x) => x.toString(16).padStart(2, '0')).join('');
+};
diff --git a/test/jest.config.js b/test/jest.config.js
@@ -0,0 +1,9 @@
+module.exports = {
+  rootDir: '../',
+  transform: {
+    '\\.ts$': 'ts-jest',
+  },
+  clearMocks: true,
+  testEnvironment: 'node',
+  setupFilesAfterEnv: ['./test/jest.setup.ts'],
+};
diff --git a/test/jest.setup.ts b/test/jest.setup.ts
@@ -0,0 +1,3 @@
+jest.setTimeout(10000);
+
+export {};
diff --git a/yarn.lock b/yarn.lock
@@ -1303,6 +1303,13 @@ browserslist@^4.21.3:
     node-releases "^2.0.6"
     update-browserslist-db "^1.0.9"
 
+bs-logger@0.x:
+  version "0.2.6"
+  resolved "https://registry.yarnpkg.com/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8"
+  integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==
+  dependencies:
+    fast-json-stable-stringify "2.x"
+
 bser@2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/bser/-/bser-2.1.1.tgz#e6787da20ece9d07998533cfd9de6f5c38f4bc05"
@@ -2101,7 +2108,7 @@ fast-glob@^3.2.11, fast-glob@^3.2.9:
     merge2 "^1.3.0"
     micromatch "^4.0.4"
 
-fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0:
+fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633"
   integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==
@@ -2962,7 +2969,7 @@ jest-snapshot@^29.3.1:
     pretty-format "^29.3.1"
     semver "^7.3.5"
 
-jest-util@^29.3.1:
+jest-util@^29.0.0, jest-util@^29.3.1:
   version "29.3.1"
   resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.3.1.tgz#1dda51e378bbcb7e3bc9d8ab651445591ed373e1"
   integrity sha512-7YOVZaiX7RJLv76ZfHt4nbNEzzTRiMW/IiOG7ZOKmTXmoGBxUDefgMAxQubu6WPVqP5zSzAdZG0FfLcC7HOIFQ==
@@ -3124,6 +3131,11 @@ locate-path@^6.0.0:
   dependencies:
     p-locate "^5.0.0"
 
+lodash.memoize@4.x:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
+  integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==
+
 lodash.merge@^4.6.2:
   version "4.6.2"
   resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a"
@@ -3155,7 +3167,7 @@ make-dir@^3.0.0:
   dependencies:
     semver "^6.0.0"
 
-make-error@^1.1.1:
+make-error@1.x, make-error@^1.1.1:
   version "1.3.6"
   resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2"
   integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==
@@ -3697,18 +3709,18 @@ semiver@^1.1.0:
   resolved "https://registry.yarnpkg.com/semiver/-/semiver-1.1.0.tgz#9c97fb02c21c7ce4fcf1b73e2c7a24324bdddd5f"
   integrity sha512-QNI2ChmuioGC1/xjyYwyZYADILWyW6AmS1UH6gDj/SFUUUS4MBAWs/7mxnkRPc/F4iHezDP+O8t0dO8WHiEOdg==
 
-semver@^6.0.0, semver@^6.3.0:
-  version "6.3.0"
-  resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
-  integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
-
-semver@^7.0.0, semver@^7.3.5, semver@^7.3.7:
+semver@7.x, semver@^7.0.0, semver@^7.3.5, semver@^7.3.7:
   version "7.3.8"
   resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.8.tgz#07a78feafb3f7b32347d725e33de7e2a2df67798"
   integrity sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==
   dependencies:
     lru-cache "^6.0.0"
 
+semver@^6.0.0, semver@^6.3.0:
+  version "6.3.0"
+  resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
+  integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
+
 set-cookie-parser@^2.4.8:
   version "2.5.1"
   resolved "https://registry.yarnpkg.com/set-cookie-parser/-/set-cookie-parser-2.5.1.tgz#ddd3e9a566b0e8e0862aca974a6ac0e01349430b"
@@ -3958,6 +3970,20 @@ tr46@~0.0.3:
   resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
   integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==
 
+ts-jest@^29.0.3:
+  version "29.0.3"
+  resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.0.3.tgz#63ea93c5401ab73595440733cefdba31fcf9cb77"
+  integrity sha512-Ibygvmuyq1qp/z3yTh9QTwVVAbFdDy/+4BtIQR2sp6baF2SJU/8CKK/hhnGIDY2L90Az2jIqTwZPnN2p+BweiQ==
+  dependencies:
+    bs-logger "0.x"
+    fast-json-stable-stringify "2.x"
+    jest-util "^29.0.0"
+    json5 "^2.2.1"
+    lodash.memoize "4.x"
+    make-error "1.x"
+    semver "7.x"
+    yargs-parser "^21.0.1"
+
 ts-node@^10.9.1:
   version "10.9.1"
   resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.1.tgz#e73de9102958af9e1f0b168a6ff320e25adcff4b"
@@ -4245,7 +4271,7 @@ yallist@^4.0.0:
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
   integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
 
-yargs-parser@^21.1.1:
+yargs-parser@^21.0.1, yargs-parser@^21.1.1:
   version "21.1.1"
   resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35"
   integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+jest.setTimeout(10000);`
	`2`	`+`
	`3`	`+export {};`