@pbvision/fastify-firestore-service 0.0.9 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",
@@ -46,8 +46,7 @@
     "@sentry/node": "^7.91.0",
     "fastify": "^4.10.0",
     "fastify-plugin": "^4.5.1",
-    "got": "^14.0.0",
-    "pino": "8.17.2",
+    "node-fetch": "^3.3.2",
     "word-wrap": "^1.2.3"
   },
   "devDependencies": {
@@ -61,6 +60,7 @@
     "eslint-config-standard": "17.1.0",
     "eslint-import-resolver-webpack": "^0.13.8",
     "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-standard": "^5.0.0",
@@ -69,6 +69,7 @@
     "license-webpack-plugin": "^4.0.2",
     "nodemon": "^3.0.2",
     "standard": "^17.1.0",
+    "superagent": "^8",
     "superagent-defaults": "^0.1.14",
     "supertest": "^6.3.3",
     "tui-jsdoc-template": "^1.2.2",

package/src/api/api.js

@@ -3,7 +3,7 @@ import querystring from 'node:querystring'
 
 import S from '@pbvision/schema'
 
-import gotWrapper from '../got-wrapper.js'
+import fetchWrapper from '../fetch-wrapper.js'
 
 import {
   BadRequestException,
@@ -117,15 +117,6 @@ class API {
     return undefined
   }
 
-  /**
-   * Returns the full HTTP path to this API.
-   * @param {String} service The service this API belongs to.
-   * @public
-   */
-  static getFullPath (service) {
-    return `/${service}${this.PATH}`
-  }
-
   /* istanbul ignore next */
   /**
    * A human-readable description of what this API does. It is only used when
@@ -362,8 +353,7 @@ class API {
       headers,
       method,
       url,
-      searchParams: qsParams,
-      throwHttpErrors: false
+      qsParams
     }
     // istanbul ignore if
     if (body) {
@@ -373,19 +363,22 @@ class API {
         request.json = body
       }
     }
-    const resp = gotWrapper(request)
-    const resolvedResp = await resp
+    const resp = await fetchWrapper(request)
     const ret = {
-      code: resolvedResp.statusCode
+      code: resp.status,
+      isOk: resp.status >= 200 && resp.status <= 299
     }
-    ret.isOk = (ret.code === 200)
     const respBody = await resp.text()
     if (respBody) {
-      try {
-        ret.data = JSON.parse(respBody)
-      } catch (e) {
-        // istanbul ignore next
-        throw new Error(`JSON.parse failed on ${respBody} with reason ${e}.`)
+      if (resp.headers.get('content-type')?.startsWith('application/json')) {
+        try {
+          ret.data = JSON.parse(respBody)
+        } catch (e) {
+          // istanbul ignore next
+          throw new Error(`JSON.parse failed on ${respBody} with reason ${e}.`)
+        }
+      } else {
+        ret.data = respBody
       }
     }
     return ret
@@ -482,14 +475,14 @@ class API {
    * @package
    */
   static registerAPI (registrar) {
-    const { app, service } = registrar
+    const { app } = registrar
     if (this.setup) {
       app.register(this.setup)
     }
     const cls = this
     app.register(async (fastify) => {
       try {
-        await cls.registerAPIWithFastify(fastify, cls.getFullPath(service))
+        await cls.registerAPIWithFastify(fastify, cls.PATH)
       } catch (e) {
         if (e instanceof assert.AssertionError) {
           e.message = `${cls.name}: ${e.message}`
@@ -502,7 +495,7 @@ class API {
     if (this.CORS_ORIGIN) {
       // create an OPTIONS method API to support CORS preflight requests from
       // browsers
-      const path = cls.getFullPath(service)
+      const path = cls.PATH
       const { params, querystring } = cls.swaggerSchema
       const schema = { hide: true, params, querystring }
       app.options(path, { schema: pruneUndefined(schema) },

package/src/fetch-wrapper.js

@@ -0,0 +1,35 @@
+import querystring from 'node:querystring'
+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
+  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)
+  }
+  if (body && compress) {
+    body = zlib.brotliCompressSync(body)
+    headers['content-encoding'] = 'br'
+  }
+
+  // istanbul ignore next
+  const fetch = mockedFetch ?? fetchWrapper.__mock ?? realFetch
+
+  // compute the full URL including search params
+  let fullURL = url
+  if (qsParams) {
+    const qsStr = querystring.stringify(qsParams)
+    if (qsStr) {
+      fullURL += `?${qsStr}`
+    }
+  }
+  return fetch(fullURL, { body, headers, method, compress: false })
+}
+
+export default fetchWrapper

package/test/base-test.js

@@ -48,23 +48,34 @@ class BaseAppTest extends BaseTest {
   }
 }
 
+function makeHeadersObj (headers) {
+  return {
+    get: name => headers[name]
+  }
+}
+
 // the promise input conveniently matches the promise produced by supertest
 // so you can pass the output of app.post(), etc. as the promise here as is
 function makeGotMockValueFromPromise (promise) {
   const mockValue = new Promise(resolve => {
     promise.then(desiredHttpResponse => {
       let body = desiredHttpResponse.text || desiredHttpResponse.body || ''
+      const headers = {}
       if (typeof body !== 'string') {
         body = JSON.stringify(body)
+        headers['content-type'] = 'application/json'
       }
-      mockValue.text = async () => body
-      resolve({ statusCode: desiredHttpResponse.status || 200 })
+      resolve({
+        status: desiredHttpResponse.status || 200,
+        headers: makeHeadersObj(headers),
+        text: async () => body
+      })
     })
   })
   return mockValue
 }
 
-function makeGotMockValue (body, statusCode, callback) {
+function makeGotMockValue (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
@@ -73,21 +84,23 @@ function makeGotMockValue (body, statusCode, callback) {
     // instead of only rejecting later when await'ed).
     // https://github.com/facebook/jest/issues/6028 (since jest 21.x)
     setTimeout(() => {
-      mockValue.text = async () => {
-        if (callback) {
-          callback()
-        }
-        if (typeof body === 'string') {
-          return body
+      const headers = {}
+      resolve({
+        status,
+        headers: makeHeadersObj(headers),
+        text: async () => {
+          if (callback) {
+            callback()
+          }
+          if (typeof body === 'string') {
+            return body
+          }
+          headers['content-type'] = 'application/json'
+          return JSON.stringify(body)
         }
-        return JSON.stringify(body)
-      }
-      resolve({ statusCode })
+      })
     }, 0)
   })
-  mockValue.text = async () => {
-    throw new Error('cannot use text() before calling await() on the response')
-  }
   return mockValue
 }
 
@@ -109,11 +122,12 @@ function mockGot () {
    */
   gotMock.mockRespWithCallback = (...callbacks) => {
     gotMock.mockImplementation(request => {
+      const { url, ...options } = request
       for (const callback of callbacks) {
         const desiredHTTPResponse = callback(request)
         if (desiredHTTPResponse === true) {
           const unmockedGot = jest.requireActual('../src/got')
-          return unmockedGot(request)
+          return unmockedGot(url, options)
         }
         if (desiredHTTPResponse) {
           if (desiredHTTPResponse.then) {

package/src/got-wrapper.js

@@ -1,34 +0,0 @@
-import zlib from 'node:zlib'
-
-import realGot from 'got'
-
-function gotWrapper (options, mockedGot) {
-  options = {
-    decompress: true,
-    ...options
-  }
-  if (options.compress) {
-    // make a copy of the headers obj before we make changes to it
-    const headers = {
-      ...options.headers
-    }
-    options.headers = headers
-    if (options.body) {
-      options.body = zlib.brotliCompressSync(options.body)
-    }
-    if (options.json) {
-      headers['content-type'] = 'application/json'
-      options.body = zlib.brotliCompressSync(JSON.stringify(options.json))
-      delete options.json
-    }
-
-    if (options.body) {
-      headers['content-encoding'] = 'br'
-    }
-  }
-  // istanbul ignore next
-  const got = mockedGot ?? gotWrapper.__mocked_got ?? realGot
-  return got(options)
-}
-
-export default gotWrapper