feat(fetch): make it easier to generate typed clients for testing

Author: djMax

package.json

@@ -52,35 +52,35 @@
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
-    "@openapi-typescript-infra/coconfig": "^4.0.2",
-    "@openapi-typescript-infra/service": "^2.0.1",
+    "@openapi-typescript-infra/coconfig": "^4.1.0",
+    "@openapi-typescript-infra/service": "^2.6.3",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/commit-analyzer": "^10.0.4",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^11.0.4",
-    "@types/lodash": "^4.14.197",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
-    "@vitest/coverage-v8": "^0.34.2",
+    "@semantic-release/release-notes-generator": "^11.0.7",
+    "@types/lodash": "^4.14.198",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
+    "@vitest/coverage-v8": "^0.34.4",
     "coconfig": "^0.13.3",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-jest": "^27.2.3",
+    "eslint-plugin-import": "^2.28.1",
     "ts-node": "^10.9.1",
-    "vitest": "^0.34.2"
+    "vitest": "^0.34.4"
   },
   "dependencies": {
     "@types/supertest": "^2.0.12",
-    "eslint": "^8.47.0",
+    "eslint": "^8.49.0",
     "find-up": "^6.3.0",
     "lodash": "^4.17.21",
     "pino-pretty": "^10.2.0",
     "read-pkg-up": "^7.0.1",
     "rest-api-support": "^1.16.3",
     "supertest": "^6.3.3",
+    "supertest-fetch": "^1.5.0",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   },
   "packageManager": "[email protected]"
 }

src/index.ts

@@ -1,6 +1,8 @@
 import path from 'path';
 import assert from 'assert';
 
+import request from 'supertest';
+import { makeFetch } from 'supertest-fetch';
 // We are going to test Typescript files, so use the ts-node
 // register hook to allow require to resolve these modules
 import { register } from 'ts-node';
@@ -99,6 +101,22 @@ export function getExistingApp<SLocals extends ServiceLocals = ServiceLocals>()
   return app as ServiceExpress<SLocals>;
 }
 
+class RequestTestingHelpers {
+  _fetch: ReturnType<typeof makeFetch>;
+
+  constructor(private app: ServiceExpress) {
+    this._fetch = makeFetch(app as unknown as Parameters<typeof makeFetch>[0]);
+  }
+
+  get request() {
+    return request(this.app);
+  }
+
+  get fetch() {
+    return this._fetch as unknown as typeof fetch;
+  }
+}
+
 export async function getReusableApp<
   SLocals extends ServiceLocals = ServiceLocals,
   RLocals extends RequestLocals = RequestLocals,
@@ -107,21 +125,23 @@ export async function getReusableApp<
     | Partial<ServiceStartOptions<SLocals, RLocals>>
     | ServiceFactory<SLocals, RLocals>,
   cwd?: string,
-): Promise<ServiceExpress<SLocals>> {
+): Promise<ServiceExpress<SLocals> & { test: RequestTestingHelpers }> {
   const logFn = (error: Error) => {
     // eslint-disable-next-line no-console
     console.error('Could not start app', error);
     throw error;
   };
-  let typedApp = app as ServiceExpress<SLocals>;
+  let typedApp = app as ServiceExpress<SLocals> & { test: RequestTestingHelpers };
 
   try {
     const options = await readOptions(cwd || process.cwd(), initialOptions).catch(logFn);
     if (!app || appService !== options.service) {
-      typedApp = await startApp(options).catch(logFn);
+      const untypedApp = await startApp(options).catch(logFn);
+      typedApp = Object.assign(untypedApp, {
+        test: new RequestTestingHelpers(untypedApp),
+      });
       appService = options.service as ServiceFactory<ServiceLocals, RequestLocals>;
       app = typedApp;
-      return typedApp;
     }
     return typedApp;
   } catch (error) {