chore: initiate async rest test using supertest

.gitignore

@@ -4,3 +4,5 @@ node_modules/
 dist/
 
 .autoenv.zsh
+yarn-error.log
+.cache

__tests__/fakerResolver01.spec.ts

@@ -0,0 +1,68 @@
+import os from 'os';
+import path from 'path';
+import fs from 'fs/promises';
+import request from 'supertest';
+import { Config } from '../src/types/config-combine';
+import { runForTest } from '../src/express';
+
+const config: Config = {
+  rest: {
+    sources: [
+      {
+        name: 'pokeapi',
+        origin: 'https://pokeapi.co',
+        transforms: {
+          '/api/v2/berry/:id': {
+            get: [
+              {
+                field: 'root.name',
+                resolvers: [
+                  {
+                    faker: 'name.firstName',
+                  },
+                ],
+              },
+            ],
+          },
+        },
+      },
+    ],
+  },
+};
+
+const homeDir = os.homedir();
+const cachePath = path.join(homeDir, '.warlock-cache');
+
+describe('faker resolver 1', () => {
+  beforeAll(() => {
+    return Promise.all([fs.rmdir(cachePath, { recursive: true })]);
+  });
+
+  const app = runForTest(config);
+
+  it('(MOCKPUBAPI01) should response 200 and cache miss', (done) => {
+    request(app)
+      .get('/https://pokeapi.co/api/v2/berry/1')
+      .expect(200)
+      .end((err, res) => {
+        if (err) return done(err);
+
+        expect(res.headers['x-warlock-cache']).toBe('MISS');
+        expect(typeof res?.body?.firmness?.name).toBe('string');
+        done();
+      });
+  });
+
+  it('(MOCKPUBAPI02) should response 200 and cache hit', (done) => {
+    request(app)
+      .get('/https://pokeapi.co/api/v2/berry/1')
+      .expect(200)
+      .end((err, res) => {
+        if (err) return done(err);
+
+        expect(res.headers['x-warlock-cache']).toBe('HIT');
+        expect(typeof res?.body?.firmness?.name).toBe('string');
+        done();
+      });
+  });
+});

__tests__/fakerResolver02.spec.ts

@@ -0,0 +1,70 @@
+import os from 'os';
+import path from 'path';
+import fs from 'fs/promises';
+import request from 'supertest';
+import { Config } from '../src/types/config-combine';
+import { runForTest } from '../src/express';
+
+const config: Config = {
+  rest: {
+    sources: [
+      {
+        name: 'pokeapi',
+        origin: 'https://pokeapi.co',
+        transforms: {
+          '/api/v2/berry/:id': {
+            get: [
+              {
+                field: 'root.name',
+                resolvers: [
+                  {
+                    faker: 'name.firstName',
+                  },
+                ],
+              },
+            ],
+          },
+        },
+      },
+    ],
+  },
+};
+
+const homeDir = os.homedir();
+const cachePath = path.join(homeDir, '.warlock-cache');
+
+describe('faker resolver 1', () => {
+  beforeAll(() => {
+    return Promise.all([fs.rmdir(cachePath, { recursive: true })]);
+  });
+
+  const app = runForTest(config);
+
+  it('(MOCKPUBAPI04) should response 200 and cache miss', (done) => {
+    request(app)
+      .get('/https://pokeapi.co/api/v2/berry/1')
+      .expect(200)
+      .end((err, res) => {
+        if (err) return done(err);
+
+        expect(res.headers['x-warlock-cache']).toBe('MISS');
+        expect(res?.body?.firmness?.name !== 'cheri').toBe(true);
+        expect(typeof res?.body?.firmness?.name).toBe('string');
+        done();
+      });
+  });
+
+  it('(MOCKPUBAPI05) should response 200 and cache hit', (done) => {
+    request(app)
+      .get('/https://pokeapi.co/api/v2/berry/1')
+      .expect(200)
+      .end((err, res) => {
+        if (err) return done(err);
+
+        expect(res.headers['x-warlock-cache']).toBe('HIT');
+        expect(res?.body?.firmness?.name !== 'cheri').toBe(true);
+        expect(typeof res?.body?.firmness?.name).toBe('string');
+        done();
+      });
+  });
+});

__tests__/fs.spec.ts

@@ -20,7 +20,6 @@ describe('fs utils buildDirPath with basePath', () => {
 });
 
 describe('fs utils createDir', () => {
-  console.log(process.cwd());
   // prerequisite step
   const basePath = process.cwd();
   const concatBasePathWith = buildDirPath(basePath);
@@ -40,6 +39,11 @@ describe('fs utils createDir', () => {
     const mkdirTest = createDir(dir);
     mkdirTest();
 
-    expect(E.fold((a: Error) => a.message, a => a)(mkdirTest())).toContain('file already exists');
+    expect(
+      E.fold(
+        (a: Error) => a.message,
+        (a) => a,
+      )(mkdirTest()),
+    ).toContain('file already exists');
   });
 });

jest.config.js

@@ -4,9 +4,10 @@ const { compilerOptions } = require('./tsconfig');
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  collectCoverageFrom: ['tests/**/*.{ts,tsx,js,jsx}'],
+  collectCoverageFrom: ['**/__tests__/**/*.spec.[jt]s?(x)'],
   transform: { '.(ts|tsx)$': 'ts-jest/dist' },
   transformIgnorePatterns: ['[/\\\\]node_modules[/\\\\].+\\.(js|jsx)$'],
+  testMatch: ['**/__tests__/**/*.spec.[jt]s?(x)'],
   globals: {
     'ts-jest': {
       tsconfig: 'tsconfig.json',

package.json

@@ -31,7 +31,7 @@
     "build:cjs": "cross-env BABEL_ENV=cjs babel src --extensions '.ts,.tsx' -d dist/cjs --source-maps",
     "build_:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
     "test": "concurrently yarn:test:*",
-    "test:unit": "jest",
+    "test:unit": "NODE_ENV=test jest",
     "test:type": "tsc --noEmit",
     "test:lint": "yarn lint src/**/*.ts",
     "test:format": "yarn format src/**/*.ts",
@@ -72,7 +72,8 @@
     "sort-keys": "^4.2.0",
     "sort-object": "^3.0.3",
     "sort-object-keys": "^1.1.3",
-    "ts-node": "^9.1.1"
+    "ts-node": "^9.1.1",
+    "url-pattern": "^1.0.3"
   },
   "devDependencies": {
     "@babel/core": "^7.12.17",
@@ -92,6 +93,7 @@
     "@types/lru-cache": "^5.1.0",
     "@types/md5": "^2.3.0",
     "@types/node": "^14.14.28",
+    "@types/supertest": "^2.0.10",
     "@warungpintar/warpin-scripts": "*",
     "babel-jest": "^26.6.3",
     "babel-plugin-inline-json-import": "^0.3.2",
@@ -109,6 +111,7 @@
     "ora": "5.3.0",
     "pinst": "2.1.4",
     "should": "^13.2.3",
+    "supertest": "^6.1.3",
     "ts-jest": "^26.5.1",
     "winston": "3.3.3"
   },

src/cli/runServer.ts

@@ -8,7 +8,7 @@ import { getConfig } from '../config';
 import { fileWatcher } from './watcher';
 import { logger } from '../logger';
 import { getPatResolvers } from '../utils';
-import { PATH_RESOLVER_DIRECTORI } from '../constant';
+import { PATH_RESOLVER_DIR } from '../constant';
 
 const runServer = (config: string, port: number) => {
   const filePath = path.join(process.cwd(), config ?? '.warlock.yaml');
@@ -26,7 +26,7 @@ const runServer = (config: string, port: number) => {
           minify: true,
           platform: 'node',
           format: 'cjs',
-          outfile: path.join(PATH_RESOLVER_DIRECTORI, resolverPath),
+          outfile: path.join(PATH_RESOLVER_DIR, resolverPath),
         });
       });
       logger.info('building resolvers');
@@ -43,7 +43,7 @@ const runServer = (config: string, port: number) => {
             minify: true,
             platform: 'node',
             format: 'cjs',
-            outfile: path.join(PATH_RESOLVER_DIRECTORI, resolverPath),
+            outfile: path.join(PATH_RESOLVER_DIR, resolverPath),
           });
           logger.info('restaring server');
         })(path.join(process.cwd(), resolverPath));

src/constant.ts

@@ -1,6 +1,6 @@
 import path from 'path';
 
-export const PATH_RESOLVER_DIRECTORI = path.join(
+export const PATH_RESOLVER_DIR = path.join(
   process.cwd(),
   'node_modules/.warlock-resolvers',
 );

src/express/index.ts

@@ -47,6 +47,11 @@ export const run = ({ port, config }: IRun) => {
   });
 };
 
+export const runForTest = (config: Config) => {
+  app.set('config', config);
+  return app;
+};
+
 const cleanup = () => {
   console.info('shutdown signal is received');
   console.info('will shutdown in 250ms');

src/resolvers/path.ts

@@ -2,7 +2,9 @@
 import path from 'path';
 import { flow } from 'fp-ts/function';
 import { Request, Response } from 'express';
-import { PATH_RESOLVER_DIRECTORI } from '../constant';
+import { PATH_RESOLVER_DIR } from '../constant';
+
+const isTestEnv = process.env.NODE_ENV === 'test';
 
 export type Context = {
   res: Response;
@@ -11,7 +13,10 @@ export type Context = {
 
 export const pathResolver = (filePath: string, context: Context) =>
   flow((data: any) => {
-    const functionPath = path.join(PATH_RESOLVER_DIRECTORI, filePath);
+    const functionPath = path.join(
+      isTestEnv ? process.cwd() : PATH_RESOLVER_DIR,
+      filePath,
+    );
     // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
     delete require.cache[functionPath];
     const mockFunction = require(functionPath);

src/utils/resolver.ts

@@ -1,5 +1,6 @@
 import * as O from 'fp-ts/Option';
 import { findFirst, reduce } from 'fp-ts/Array';
+import UrlPattern from 'url-pattern';
 import { Config } from '../types/config-combine';
 import {
   fakerResolver,
@@ -54,8 +55,18 @@ export const parseModule = (url: URL) => (config: Module[]) =>
   findFirst((module: Module) => module.origin === url.origin)(config);
 
 export const parseModulePathHandler = (url: URL) => (module: Module) => {
-  if (module.transforms[url.pathname]) {
-    return O.some(module.transforms[url.pathname]);
+  const pathHandlerKey = Object.keys(module.transforms).find((item) => {
+    if (item === url.pathname) return true;
+
+    const pattern = new UrlPattern(item);
+
+    if (pattern.match(url.pathname)) return true;
+
+    return false;
+  });
+
+  if (pathHandlerKey) {
+    return O.some(module.transforms[pathHandlerKey]);
   }
 
   return O.none;

tsconfig.json

@@ -10,7 +10,8 @@
   ],
   "include": [
     "src",
-    "__tests__/"
+    "__tests__/**/*.spec.ts",
+    "__tests__/fakerResolver01.ts"
   ],
   "exclude": [
     "node_modules",