chore: cache abstraction

.eslintrc.js

@@ -12,6 +12,7 @@ module.exports = {
     '@typescript-eslint/no-var-requires': 'off',
     'react/prop-types': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
   },
   env: {
     browser: true,

jest.config.js

@@ -8,6 +8,7 @@ module.exports = {
   transform: { '.(ts|tsx)$': 'ts-jest/dist' },
   transformIgnorePatterns: ['[/\\\\]node_modules[/\\\\].+\\.(js|jsx)$'],
   testMatch: ['**/__tests__/**/*.spec.[jt]s?(x)'],
+  testTimeout: 15000,
   globals: {
     'ts-jest': {
       tsconfig: 'tsconfig.json',

package.json

@@ -141,6 +141,7 @@
     "git-notify": "0.2.3",
     "html-webpack-plugin": "4.5.0",
     "husky": "5.0.9",
+    "hyper-ts": "^0.6.1",
     "identity-obj-proxy": "3.0.0",
     "is-ci": "3.0.0",
     "jest": "^26.6.3",
@@ -182,6 +183,7 @@
     "tslib": "^2.1.0",
     "typescript": "^4.2.3",
     "url-loader": "4.1.1",
+    "uuid": "^8.3.2",
     "web-vitals": "^1.0.1",
     "webpack": "4.44.2",
     "webpack-dev-server": "3.11.1",

src/express/coreMiddleware.ts

@@ -4,11 +4,9 @@ import restMiddleware from './restMiddleware';
 import graphqlMiddleware from './grapqhlMiddleware';
 
 import { parseUrl } from '../utils';
-import { ICacheDependency } from '../libs/cache';
+import { ICache } from '../libs/cache';
 
-const coreMiddleware = (cache: ICacheDependency): RequestHandler => (
-  ...handler
-) => {
+const coreMiddleware = (cache: ICache): RequestHandler => (...handler) => {
   const [req, , next] = handler;
   const maybeUrl = parseUrl(req.path.slice(1));
 

src/express/index.ts

@@ -13,9 +13,7 @@ import { logger } from '../logger';
 import event from '../cli/event';
 import apiRoutes from './routes/api';
 
-import LMDB, {
-  _createCacheDirectoryThenGeneratePathOptions,
-} from '../libs/lmdb';
+import { createCacheInstance } from '../libs/cache';
 import { buildDirPath } from '../utils/fs';
 import { WARLOCK_CACHE_DIR_NAME } from '../constant';
 
@@ -26,25 +24,34 @@ const forms = multer();
 
 const CACHE_BASE_PATH = os.homedir();
 
-const lmdbOpts = pipe(
-  WARLOCK_CACHE_DIR_NAME,
-  buildDirPath(CACHE_BASE_PATH),
-  _createCacheDirectoryThenGeneratePathOptions,
+const CACHE_PATH = pipe(WARLOCK_CACHE_DIR_NAME, buildDirPath(CACHE_BASE_PATH));
+
+const cacheInstance = createCacheInstance(
+  IS_TEST_ENV
+    ? {
+        type: 'memory',
+        options: {
+          max: 50,
+        },
+      }
+    : {
+        type: 'file',
+        options: {
+          path: CACHE_PATH,
+          maxDbs: 1,
+        },
+      },
 );
 
-const lmdbInstance = new LMDB(lmdbOpts);
-
-export const purgeCache = () => {
-  const maybePurgedCache = lmdbInstance.reset();
+export const purgeCache = () =>
   E.fold(
     (e) => {
       !IS_TEST_ENV && logger.error(e);
     },
     () => {
       !IS_TEST_ENV && logger.info('cache purged');
     },
-  )(maybePurgedCache);
-};
+  )(cacheInstance.reset());
 
 event.on('purge', purgeCache);
 
@@ -55,10 +62,10 @@ app.use(bodyParser.urlencoded({ extended: true }));
 app.use(bodyParser.json());
 app.use('/api', apiRoutes);
 
-app.use(coreMiddleware(lmdbInstance));
+app.use(coreMiddleware(cacheInstance));
 app.use(resolverMiddleware);
 app.use((_, res) => {
-  if (typeof res.locals && Object.keys(res.locals).length === 0) {
+  if (typeof res.locals === 'object' && Object.keys(res.locals).length === 0) {
     return res.sendFile(path.join(__dirname, '../../www/index.html'));
   }
 
@@ -92,11 +99,12 @@ export const cleanup = () => {
   console.info('shutdown signal is received');
   console.info('will shutdown in 250ms');
 
+  cacheInstance?.close?.();
+
   setTimeout(() => {
     console.info('shutting down...');
-    lmdbInstance.close();
     process.exit();
-  }, 10);
+  }, 250);
 };
 
 process.on('SIGINT', cleanup);

src/express/restMiddleware.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'express';
 import axios, { Method } from 'axios';
 import * as E from 'fp-ts/Either';
-import { ICacheDependency } from '../libs/cache';
+import { ICache } from '../libs/cache';
 import { getCacheKey, encode, decode } from '../libs/cacheHttp';
 import { concatHeaders } from '../libs/http';
 import { logger, debugable } from '../logger';
@@ -13,12 +13,14 @@ const instance = axios.create({
   validateStatus: () => true,
 });
 
-const restMiddleware = (cache: ICacheDependency) => (
-  url: URL,
-): RequestHandler => (req, res, next) => {
+const restMiddleware = (cache: ICache) => (url: URL): RequestHandler => (
+  req,
+  res,
+  next,
+) => {
   const cacheKey = getCacheKey(req);
   const responseWithCache = (cacheKey: string) => {
-    const cachedResponse = decode(cache.get(cacheKey));
+    const cachedResponse = decode(cache.get(cacheKey) ?? '{}');
     if (E.isRight(cachedResponse)) {
       const _cachedResponse = cachedResponse.right;
       res.locals = _cachedResponse?.data;

src/index.ts

@@ -1 +1,9 @@
+import express from 'express';
+
+import { parserMiddleware } from './middleware';
+
 export * from './types';
+export const app = express();
+
+// body parser and multer
+app.use(parserMiddleware);

src/libs/cache.ts

@@ -1,56 +1,35 @@
-import { Reader } from 'fp-ts/lib/Reader';
-import { pipe } from 'fp-ts/lib/pipeable';
-import { IO } from 'fp-ts/lib/IO';
+import LRU, { LRUOption } from './lru';
 import * as E from 'fp-ts/Either';
-import { fromNullable, Option } from 'fp-ts/lib/Option';
 
-import { sortURLSearchParams } from '../utils/url';
-import { toString, hashStr } from '../utils/generic';
+import LMDB, { LMDBOptions } from './lmdb';
 
-// @TODO Cache suppose to be modular, where we can select whether the cache will be stored on the memory, db, or file
-// type CacheOption = {
-//   store: 'memory' | 'db' | 'file',
-//   max: number,
-//   ttl: number,
-//   logger: () => void,
-// }
-
-export interface ICacheDependency {
+export interface ICache {
   has: (key: string) => boolean;
-  get: (key: string) => string;
+  get: (key: string) => string | undefined;
   set: (key: string, value: string) => boolean;
-  reset: () => E.Either<Error, null> | void;
+  reset: () => E.Either<Error, null>;
+  close?: () => void;
 }
 
-export interface ICache {
-  setItem: <T>(key: string, value: unknown) => E.Either<unknown, T>;
-  getItem: <T>(key: string) => E.Either<unknown, T>;
+export interface MemoryOption {
+  type: 'memory';
+  options: LRUOption;
 }
 
-export const getItem = (
-  key: string,
-): Reader<ICacheDependency, IO<Option<string>>> => (deps) => () =>
-  fromNullable(deps.get(key));
-
-export const hasItem = (key: string): Reader<ICacheDependency, IO<boolean>> => (
-  deps,
-) => () => deps.has(key);
-
-export const setItem = (
-  key: string,
-  value: string,
-): Reader<ICacheDependency, IO<boolean>> => (deps) => () =>
-  deps.set(key, value);
+export interface FileOption {
+  type: 'file';
+  options: LMDBOptions;
+}
 
-export const getGetRequest = (url: URL) =>
-  pipe(sortURLSearchParams(url), toString, hashStr, (key) => (deps) =>
-    getItem(key)(deps),
-  );
+export type CacheOptions = MemoryOption | FileOption;
 
-export const hasGetRequest = (url: URL) =>
-  pipe(sortURLSearchParams(url), toString, hashStr, hasItem);
+export const createCacheInstance = (options: CacheOptions): ICache => {
+  if (options.type === 'memory') {
+    return new LRU(options.options);
+  }
+  if (options.type === 'file') {
+    return new LMDB(options.options);
+  }
 
-export const setGetRequest = (url: URL, responsePayload: string) =>
-  pipe(sortURLSearchParams(url), toString, hashStr, (key) => (deps) =>
-    setItem(key, responsePayload)(deps),
-  );
+  return new LRU({ max: 50 });
+};

src/libs/lmdb.ts

@@ -4,14 +4,14 @@ import { pipe } from 'fp-ts/function';
 import * as E from 'fp-ts/Either';
 import * as O from 'fp-ts/Option';
 
-import { ICacheDependency } from './cache';
+import { ICache } from './cache';
 import { createDirIfNotExist, removeDirIfExist } from '../utils/fs';
 
-interface LMDBOptions {
+export interface LMDBOptions {
   path: string;
   maxDbs: number;
 }
-export default class LMDB implements ICacheDependency {
+export default class LMDB implements ICache {
   'env': any;
   'dbi': any;
   'txn': any;

src/libs/lru.ts

@@ -0,0 +1,36 @@
+import LRUBase from 'lru-cache';
+import * as E from 'fp-ts/Either';
+import { ICache } from './cache';
+
+export interface LRUOption {
+  max: number;
+}
+
+export default class LRU implements ICache {
+  env: LRUBase<string, string>;
+
+  constructor(options: LRUOption) {
+    this.env = new LRUBase(options.max);
+  }
+
+  public get = (key: string) => {
+    return this.env.get(key);
+  };
+
+  public set = (key: string, value: string) => {
+    return this.env.set(key, value);
+  };
+
+  public has = (key: string) => {
+    return this.env.has(key);
+  };
+
+  public reset = () => {
+    this.env.reset();
+    return E.right(null);
+  };
+
+  public close = () => {
+    return null;
+  };
+}

src/middleware/errorHandler.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 // @TODO {proxy} need following @types/koa-bodyparser
 const errorHandler = async (ctx, next) => {
   return next().catch((err) => {

src/middleware/index.ts

@@ -0,0 +1 @@
+export * from './parser';

src/middleware/parser.ts

@@ -0,0 +1,12 @@
+import { Router } from 'express';
+import bodyParser from 'body-parser';
+import multer from 'multer';
+
+const forms = multer();
+
+const router = Router();
+router.use(forms.any());
+router.use(bodyParser.urlencoded({ extended: true }));
+router.use(bodyParser.json());
+
+export const parserMiddleware = router;

src/store.ts

@@ -0,0 +1,11 @@
+import * as O from 'fp-ts/Option';
+
+import { ICache } from './libs/cache';
+import { Config } from './types';
+
+export interface Store {
+  config: Config;
+  cacheStorage: ICache;
+  locals: Record<string, O.Option<unknown>>;
+  getLocal: (key: string) => O.Option<unknown>;
+}

yarn.lock

@@ -10112,6 +10112,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/husky/-/husky-5.0.9.tgz#6d38706643d66ed395bcd4ee952d02e3f15eb3a3"
   integrity sha512-0SjcaY21a+IRdx7p7r/X33Vc09UR2m8SbP8yfkhUX2/jAmwcz+GR7i9jXkp2pP3GfX23JhMkVP6SWwXB18uXtg==
 
+hyper-ts@^0.6.1:
+  version "0.6.1"
+  resolved "https://registry.yarnpkg.com/hyper-ts/-/hyper-ts-0.6.1.tgz#a219ec6a170b5d6c7d665561c0a5b1e0b50c758b"
+  integrity sha512-rhtf4s/VdDQSxKRvgFm4AVMPyuyOdAyeoZ641r3+fHnHyrRk9oSwHzVI8KjR1FFN9fUvSZQdGzgA7/p8eV+I6Q==
+
 [email protected], iconv-lite@^0.4.24:
   version "0.4.24"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b"
@@ -17396,7 +17401,7 @@ uuid@^3.3.2, uuid@^3.4.0:
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee"
   integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==
 
-uuid@^8.3.0:
+uuid@^8.3.0, uuid@^8.3.2:
   version "8.3.2"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
   integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==