@pbvision/fastify-firestore-service 0.0.16 → 0.0.18

package/README.md

@@ -14,7 +14,6 @@ provides a way to define APIs, including managing data.
 - [Components](#components)
   - [Customizing Component Registration](#customizing-component-registration)
 - [Unit testing](#unit-testing)
-  - [Setup](#setup)
 - [Generating SDKs](#generating-sdks)
   - [Swagger UI](#swagger-ui)
   - [OpenAPI SDKs](#openapi-sdks)
@@ -175,10 +174,6 @@ workflow with custom components. For example, to add a new type of component
    `makeService({ components: { ExampleComponent } })`
 
 # Unit testing
-## Setup
-Apps store data in Firestore. You must start the Firestore emulator before
-running tests. You can run `yarn start-local-db` to start the local emulator.
-
 # Generating SDKs
 ## Swagger UI
 This library generates an interactive Swagger UI for all APIs at /[service]/docs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",
@@ -11,9 +11,10 @@
   "scripts": {
     "build-doc": "./docs/build.sh",
     "debug": "./node_modules/nodemon/bin/nodemon.js --no-lazy --legacy-watch --watch ./src --watch ./examples --watch ./test --inspect=9229 ./node_modules/jest/bin/jest.js --coverage --config=./jest.config.json --runInBand",
-    "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json --coverage",
     "setup": "yarn install --frozen-lockfile && pip install -r requirements.txt",
-    "start-local-db": "./node_modules/@pbvision/firestore-orm/scripts/start-local-db.sh"
+    "start-local-db": "./node_modules/@pbvision/firestore-orm/scripts/start-local-db.sh",
+    "test": "yarn -s start-local-db && yarn -s test-without-starting-db",
+    "test-without-starting-db": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --config=./jest.config.json --coverage"
   },
   "contributors": [
     "David Underhill",
@@ -41,7 +42,7 @@
     "@fastify/static": "^6.12",
     "@fastify/swagger": "^8.1.0",
     "@fastify/swagger-ui": "^2.0.1",
-    "@pbvision/firestore-orm": "^0.0.6",
+    "@pbvision/firestore-orm": "^0.0.7",
     "@pbvision/schema": "^0.2.15",
     "@sentry/node": "^7.91.0",
     "fastify": "^4.10.0",

package/src/fetch-wrapper.js

@@ -3,23 +3,24 @@ import zlib from 'node:zlib'
 
 import realFetch from 'node-fetch'
 
-async function fetchWrapper (options, mockedFetch) {
-  const { compress = true, method = 'POST', url, qsParams, json } = options
-  let { body, headers } = options
+async function fetchWrapper (request, mockedFetch) {
+  const { compress = true, method = 'POST', url, qsParams, json } = request
+  let { body, headers } = request
   headers = { ...headers } // copy the headers before we change them
 
   // compress the body using brotli
   if (json) {
     headers['content-type'] = 'application/json'
-    body = JSON.stringify(options.json)
+    body = JSON.stringify(request.json)
   }
   if (body && compress) {
     body = zlib.brotliCompressSync(body)
     headers['content-encoding'] = 'br'
   }
 
-  // istanbul ignore next
-  const fetch = mockedFetch ?? fetchWrapper.__mock ?? realFetch
+  const fetch = (mockedFetch === false)
+    ? realFetch
+    : (mockedFetch ?? fetchWrapper.__mock ?? realFetch)
 
   // compute the full URL including search params
   let fullURL = url
@@ -29,7 +30,8 @@ async function fetchWrapper (options, mockedFetch) {
       fullURL += `?${qsStr}`
     }
   }
-  return fetch(fullURL, { body, headers, method, compress: false })
+  const options = { body, headers, method, compress: false }
+  return fetch(fullURL, options)
 }
 
 export default fetchWrapper

package/test/base-test.js

@@ -1,3 +1,4 @@
+import querystring from 'node:querystring'
 import zlib from 'node:zlib'
 
 import { jest } from '@jest/globals'
@@ -24,6 +25,15 @@ class BaseAppTest extends BaseTest {
     return func
   }
 
+  beforeEach () {
+    this.fetchMock = fetchWrapper.__mock
+    fetchWrapper.__mock.mockClear()
+
+    // default response is a weird error to help make it obvious the unit test
+    // author forgot to provide a custom mock value
+    this.fetchMock.mockResp('custom mock value not set', 555)
+  }
+
   async beforeAll () {
     const makeService = await this.getMakeServiceFunc()
     this.fastify = FASTIFY_CACHE ?? await makeService()
@@ -56,10 +66,6 @@ class BaseAppTest extends BaseTest {
       }
     })
   }
-
-  afterEach () {
-    fetchWrapper.__mock.mockReset()
-  }
 }
 
 function makeHeadersObj (headers) {
@@ -72,15 +78,15 @@ function makeHeadersObj (headers) {
 // so you can pass the output of app.post(), etc. as the promise here as is
 function makeNodeFetchMockValueFromPromise (promise) {
   const mockValue = new Promise(resolve => {
-    promise.then(desiredHttpResponse => {
-      let body = desiredHttpResponse.text || desiredHttpResponse.body || ''
+    promise.then(httpResponse => {
+      let body = httpResponse.text || httpResponse.body || ''
       const headers = {}
       if (typeof body !== 'string') {
         body = JSON.stringify(body)
         headers['content-type'] = 'application/json'
       }
       resolve({
-        status: desiredHttpResponse.status || 200,
+        status: httpResponse.status || 200,
         headers: makeHeadersObj(headers),
         text: async () => body
       })
@@ -92,8 +98,8 @@ function makeNodeFetchMockValueFromPromise (promise) {
 function makeNodeFetchMockValue (body, status, callback) {
   const mockValue = new Promise(resolve => {
     // setTimeout is used so that this promise does not synchronously resolve
-    // because unmocked got will NEVER return synchronously. This ensures
-    // functions which call got() never resolve synchronously (which can
+    // because unmocked fetch will NEVER return synchronously. This ensures
+    // functions which call fetch() never resolve synchronously (which can
     // change their behavior... e.g., allow them to throw when called,
     // instead of only rejecting later when await'ed).
     // https://github.com/facebook/jest/issues/6028 (since jest 21.x)
@@ -119,9 +125,7 @@ function makeNodeFetchMockValue (body, status, callback) {
 }
 
 function mockNodeFetch () {
-  const nodeFetchMock = jest.fn().mockImplementation(({ body }) => {
-    expect(body).toEqual(zlib.brotliCompressSync('321'))
-  })
+  const nodeFetchMock = jest.fn().mockImplementation()
 
   nodeFetchMock.mockResp = (body = '', statusCode = 200, callback) => {
     nodeFetchMock.mockReturnValue(makeNodeFetchMockValue(body, statusCode, callback))
@@ -135,13 +139,34 @@ function mockNodeFetch () {
    *   provides a mock response then an error will be thrown
    */
   nodeFetchMock.mockRespWithCallback = (...callbacks) => {
-    nodeFetchMock.mockImplementation(request => {
-      const { url, ...options } = request
+    nodeFetchMock.mockImplementation((fullURL, options) => {
+      // construct the fetchWrapper's request parameter from the fullURL and
+      // options passed as parameters to node-fetch
+      const [baseUrl, qsParams] = fullURL.split('?', 2)
+      const request = {
+        compress: options.headers['content-encoding'] === 'br',
+        method: options.method,
+        url: baseUrl,
+        qsParams: querystring.parse(qsParams),
+        headers: options.headers
+      }
+      delete request.headers['content-encoding']
+      const body = options.body
+        ? (request.compress
+            ? zlib.brotliDecompressSync(options.body)
+            : options.body)
+        : options.body
+      if (options.headers['content-type'] === 'application/json') {
+        delete options.headers['content-type']
+        request.json = JSON.parse(body)
+      } else {
+        request.body = body // may be undefined
+      }
+
       for (const callback of callbacks) {
         const desiredHTTPResponse = callback(request)
         if (desiredHTTPResponse === true) {
-          const unmockedFetch = jest.requireActual('../src/got')
-          return unmockedFetch(url, options)
+          return fetchWrapper(request, false)
         }
         if (desiredHTTPResponse) {
           if (desiredHTTPResponse.then) {
@@ -153,7 +178,7 @@ function mockNodeFetch () {
             desiredHTTPResponse.status || 200)
         }
       }
-      throw new Error(`un-mocked got() request: ${JSON.stringify(request)}`)
+      throw new Error(`un-mocked fetchWrapper() request: ${JSON.stringify(request)}`)
     })
   }
 
@@ -162,10 +187,11 @@ function mockNodeFetch () {
     let idx = 0
     function setupNextResponse () {
       if (idx < responses.length) {
-        nodeFetchMock.mockResp(...responses[idx], setupNextResponse)
-      } else if (idx > responses.length) {
+        const [body, code] = responses[idx]
+        nodeFetchMock.mockResp(body ?? '', code ?? 200, setupNextResponse)
+      } else {
         // exactly equal means we just got our last callback (okay)
-        throw new Error('more requests made than we had mock responses')
+        nodeFetchMock.mockResp('ran out of mocked responses', 556)
       }
       idx += 1
     }