chore: update tests so they exit gracefully and compute more accurate coverage (#682)

* chore: update tests so they exit gracefully and compute more accurate coverage

* disallow and remove floating promises

* use await instead of return for tus

Author: itslenny

.eslintrc.js

@@ -5,8 +5,10 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
     sourceType: 'module', // Allows for the use of imports
+    "project": "./tsconfig.json",
   },
   rules: {
+    '@typescript-eslint/no-floating-promises': 'error',
     '@typescript-eslint/no-explicit-any': 'warn',
     '@typescript-eslint/no-unused-vars': [
       'warn',

jest.sequencer.cjs

@@ -1,32 +1,28 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const Sequencer = require('@jest/test-sequencer').default
 
-// https://stackoverflow.com/a/68009048
-
-const isRLSTest = (test) => {
-  return test.path.includes('rls')
-}
-
-const isTusTest = (test) => {
-  return test.path.includes('tus')
-}
-
-const isS3Test = (test) => {
-  return test.path.includes('s3')
-}
+// order to sort tests based on name matching
+const testOrder = [
+  'jwt.test.ts', // needs to run before it is imported by other libraries for proper coverage
+  '*', // all other tests not matched
+  'tus.test.ts',
+  's3-protocol.test.ts',
+  'rls.test.ts',
+]
 
 class CustomSequencer extends Sequencer {
   sort(tests) {
-    const copyTests = Array.from(tests)
-    const normalTests = copyTests.filter((t) => !isRLSTest(t) && !isTusTest(t) && !isS3Test(t))
-    const tusTests = copyTests.filter((t) => isTusTest(t))
-    const s3Tests = copyTests.filter((t) => isS3Test(t))
-    const rlsTests = copyTests.filter((t) => isRLSTest(t))
-    return super
-      .sort(normalTests)
-      .concat(tusTests)
-      .concat(s3Tests)
-      .concat(rlsTests.sort((a, b) => (a.path > b.path ? 1 : -1)))
+    const testBuckets = {}
+    testOrder.forEach(k => {
+      testBuckets[k] = []
+    })
+
+    Array.from(tests).forEach(t => {
+      const fileName = t.path.split('/').pop()
+      const bucket = testBuckets[fileName] || testBuckets['*']
+      bucket.push(t)
+    })
+    return testOrder.flatMap(k => super.sort(testBuckets[k]))
   }
 }
 

package.json

@@ -13,8 +13,8 @@
     "migrations:types": "tsx src/scripts/migrations-types.ts",
     "docs:export": "tsx ./src/scripts/export-docs.ts",
     "test:dummy-data": "tsx -r dotenv/config ./src/test/db/import-dummy-data.ts",
-    "test": "npm run infra:restart && npm run test:dummy-data && jest --runInBand --forceExit",
-    "test:coverage": "npm run infra:restart && npm run test:dummy-data && jest --runInBand --coverage --forceExit",
+    "test": "npm run infra:restart && npm run test:dummy-data && jest --no-cache --runInBand",
+    "test:coverage": "npm run infra:restart && npm run test:dummy-data && jest --no-cache --runInBand --coverage",
     "eslint:check": "eslint 'src/**'",
     "infra:stop": "docker compose --project-directory . -f ./.docker/docker-compose-infra.yml down --remove-orphans",
     "infra:start": "docker compose --project-directory . -f ./.docker/docker-compose-infra.yml up -d && sleep 5 && npm run migration:run",

src/http/routes/admin/jwks.ts

@@ -3,6 +3,7 @@ import apiKey from '../../plugins/apikey'
 import { jwksManager } from '@internal/database'
 import { FromSchema } from 'json-schema-to-ts'
 import { UrlSigningJwkGenerator } from '@internal/auth/generators/jwk-generator'
+import { logSchema } from '@internal/monitoring'
 
 const addSchema = {
   body: {
@@ -126,15 +127,22 @@ export default async function routes(fastify: FastifyInstance) {
     }
   )
 
-  fastify.post('/jwks/generate-all-missing', (request, reply) => {
+  fastify.post('/jwks/generate-all-missing', async (request, reply) => {
     const { running, sent } = UrlSigningJwkGenerator.getGenerationStatus()
     if (running) {
       return reply
         .status(400)
         .send(`Generate missing jwks is already running, and has sent ${sent} items so far`)
     }
 
-    UrlSigningJwkGenerator.generateUrlSigningJwksOnAllTenants(request.signals.disconnect.signal)
+    UrlSigningJwkGenerator.generateUrlSigningJwksOnAllTenants(
+      request.signals.disconnect.signal
+    ).catch((e) => {
+      logSchema.error(request.log, 'Error generating url signing jwks for all tenants', {
+        type: 'jwk-generator',
+        error: e,
+      })
+    })
     return reply.send({ started: true })
   })
 

src/http/routes/tus/index.ts

@@ -235,8 +235,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_CREATE_UPLOAD}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
 
@@ -248,8 +248,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_CREATE_UPLOAD}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
 
@@ -261,8 +261,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_UPLOAD_PART}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
       fastify.patch(
@@ -276,8 +276,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_UPLOAD_PART}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
       fastify.head(
@@ -288,8 +288,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_GET_UPLOAD}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
       fastify.delete(
@@ -303,8 +303,8 @@ const authenticatedRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_DELETE_UPLOAD}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
     })
@@ -341,8 +341,8 @@ const publicRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_OPTIONS}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
 
@@ -358,8 +358,8 @@ const publicRoutes = fastifyPlugin(
             operation: { type: `${ROUTE_OPERATIONS.TUS_OPTIONS}${options.operation || ''}` },
           },
         },
-        (req, res) => {
-          options.tusServer.handle(req.raw, res.raw)
+        async (req, res) => {
+          await options.tusServer.handle(req.raw, res.raw)
         }
       )
     })

src/internal/testing/generators/array.ts

@@ -7,19 +7,19 @@ export async function eachParallel<T>(times: number, fn: (index: number) => Prom
   return Promise.all(promises)
 }
 
-export function pickRandomFromArray<T>(arr: T[]): T {
-  return arr[Math.floor(Math.random() * arr.length)]
-}
+// export function pickRandomFromArray<T>(arr: T[]): T {
+//   return arr[Math.floor(Math.random() * arr.length)]
+// }
 
-export function pickRandomRangeFromArray<T>(arr: T[], range: number): T[] {
-  if (arr.length <= range) {
-    return arr
-  }
+// export function pickRandomRangeFromArray<T>(arr: T[], range: number): T[] {
+//   if (arr.length <= range) {
+//     return arr
+//   }
 
-  const result = new Set<T>()
-  while (result.size < range) {
-    result.add(pickRandomFromArray(arr))
-  }
+//   const result = new Set<T>()
+//   while (result.size < range) {
+//     result.add(pickRandomFromArray(arr))
+//   }
 
-  return Array.from(result)
-}
+//   return Array.from(result)
+// }

src/scripts/export-docs.ts

@@ -13,4 +13,4 @@ import app from '../app'
   await fs.writeFile('static/api.json', response.body)
 
   await storageApp.close()
-})()
+})().catch(console.error)

src/scripts/migrate-call.ts

@@ -9,4 +9,4 @@ import { getConfig } from '../config'
     databaseUrl: databaseURL,
     upToMigration: dbMigrationFreezeAt,
   })
-})()
+})().catch(console.error)

src/scripts/orphan-client.ts

@@ -177,9 +177,9 @@ async function writeStreamToJsonArray(
 }
 
 main()
-  .catch((e) => {
-    console.error('Error:', e)
-  })
   .then(() => {
     console.log('Done')
   })
+  .catch((e) => {
+    console.error('Error:', e)
+  })

src/storage/backend/s3/adapter.ts

@@ -154,13 +154,7 @@ export class S3Backend implements StorageBackendAdapter {
       },
     })
 
-    signal?.addEventListener(
-      'abort',
-      () => {
-        upload.abort()
-      },
-      { once: true }
-    )
+    signal?.addEventListener('abort', () => upload.abort(), { once: true })
 
     if (tracingFeatures?.upload) {
       upload.on('httpUploadProgress', (progress: Progress) => {