test(next-drupal): reorganize Jest tests

Fixes #608
chapter-three · Feb 20, 2024 · 709cd80 · 709cd80
1 parent dbb6e91
commit 709cd80
Show file tree

Hide file tree

Showing 29 changed files with 9,268 additions and 6,661 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -8,3 +8,6 @@ indent_size = 2
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[{*.diff,*.patch}]
+trim_trailing_whitespace = false
diff --git a/package.json b/package.json
@@ -61,13 +61,13 @@
     "faker": "^6.6.6",
     "husky": "^8.0.3",
     "isomorphic-fetch": "^3.0.0",
-    "jest": "^27.5.1",
+    "jest": "^29.7.0",
     "lerna": "^8.0.1",
     "lint-staged": "^15.0.2",
     "prettier": "^3.0.3",
     "start-server-and-test": "^1.15.5",
-    "ts-jest": "^27.1.5",
-    "ts-node": "^10.9.1",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
     "tsup": "^7.3.0",
     "turbo": "^1.10.15",
     "typescript": "^5.2.2",

diff --git a/packages/next-drupal-query/jest.config.cjs b/packages/next-drupal-query/jest.config.cjs
@@ -1,23 +1,27 @@
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
   preset: "ts-jest/presets/js-with-ts",
   testEnvironment: "node",
   setupFiles: ["dotenv/config"],
   setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
   testMatch: ["**/tests/**/*.test.{ts,tsx}"],
-  globals: {
-    "ts-jest": {
-      isolatedModules: true,
-    },
+  transform: {
+    "^.+\\.tsx?$": [
+      "ts-jest",
+      {
+        isolatedModules: true,
+      },
+    ],
   },
+  testLocationInResults: true,
   coverageProvider: "v8",
   collectCoverage: true,
   collectCoverageFrom: ["./src/**"],
   coverageReporters: ["lcov", "text", "text-summary"],
   coverageThreshold: {
     global: {
       statements: 85.11,
-      branches: 58,
+      branches: 67.56,
       functions: 70,
       lines: 85.11,
     },

diff --git a/packages/next-drupal-query/tests/__snapshots__/index.test.ts.snap b/packages/next-drupal-query/tests/__snapshots__/index.test.ts.snap
@@ -1,13 +1,13 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`formatData it formats data 1`] = `
-Object {
+{
   "name": "First Last",
 }
 `;
 
 exports[`getData it accepts data options 1`] = `
-Object {
+{
   "author": "shadcn",
   "id": "ID",
   "title": "Title of Article",
@@ -16,14 +16,14 @@ Object {
 `;
 
 exports[`getData it accepts placeholder options 1`] = `
-Object {
+{
   "email": "[email protected]",
   "name": "shadcn",
 }
 `;
 
 exports[`getData it returns data for a query 1`] = `
-Object {
+{
   "author": "shadcn",
   "id": "id",
   "title": "Title of Article",
@@ -32,52 +32,52 @@ Object {
 `;
 
 exports[`getData it returns data when both data and placeholder is defined 1`] = `
-Object {
+{
   "email": "[email protected]",
 }
 `;
 
 exports[`getData it returns formatted data if a formatter is defined 1`] = `
-Object {
+{
   "email": "[email protected]",
   "name": "First Last",
 }
 `;
 
 exports[`getData it returns placeholder data if a query does not define data 1`] = `
-Object {
+{
   "name": "shadcn",
 }
 `;
 
 exports[`getParams it accepts params options 1`] = `
-Object {
-  "fields": Object {
+{
+  "fields": {
     "resource": "foo,bar",
   },
-  "filter": Object {},
-  "include": Array [],
-  "sort": Array [],
+  "filter": {},
+  "include": [],
+  "sort": [],
 }
 `;
 
 exports[`getParams it allows params to be nested 1`] = `
-Object {
-  "fields": Object {},
-  "filter": Object {},
+{
+  "fields": {},
+  "filter": {},
   "include": "field_image,uid",
-  "page": Object {
+  "page": {
     "limit": 10,
   },
-  "sort": Array [],
+  "sort": [],
 }
 `;
 
 exports[`getParams it returns params for a query 1`] = `
-Object {
-  "fields": Object {},
-  "filter": Object {},
+{
+  "fields": {},
+  "filter": {},
   "include": "field_image,uid",
-  "sort": Array [],
+  "sort": [],
 }
 `;
diff --git a/packages/next-drupal/jest.config.cjs b/packages/next-drupal/jest.config.cjs
@@ -1,15 +1,19 @@
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
   setupFiles: ["dotenv/config"],
   setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
   testMatch: ["**/tests/**/*.test.{ts,tsx}"],
-  globals: {
-    "ts-jest": {
-      isolatedModules: true,
-    },
+  transform: {
+    "^.+\\.tsx?$": [
+      "ts-jest",
+      {
+        isolatedModules: true,
+      },
+    ],
   },
+  testLocationInResults: true,
   coverageProvider: "v8",
   collectCoverage: true,
   collectCoverageFrom: ["./src/**"],
@@ -22,10 +26,10 @@ module.exports = {
   coverageReporters: ["lcov", "text", "text-summary"],
   coverageThreshold: {
     global: {
-      statements: 82.07,
-      branches: 86.9,
-      functions: 80.76,
-      lines: 82.07,
+      statements: 97.21,
+      branches: 92.25,
+      functions: 100,
+      lines: 97.21,
     },
   },
 }
diff --git a/packages/next-drupal/src/client.ts b/packages/next-drupal/src/client.ts
@@ -338,9 +338,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -383,9 +381,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -423,9 +419,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -457,9 +451,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     return response.status === 204
   }
@@ -502,9 +494,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -735,9 +725,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -1073,6 +1061,7 @@ export class DrupalClient {
     response: NextApiResponse,
     options?: Parameters<NextApiResponse["setDraftMode"]>[0]
   ) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const { slug, resourceVersion, plugin, secret, scope, ...draftData } =
       request.query
     const useDraftMode = options?.enable
@@ -1192,9 +1181,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const data = await response.json()
 
@@ -1265,9 +1252,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const data = await response.json()
 
@@ -1307,9 +1292,7 @@ export class DrupalClient {
       withAuth: options.withAuth,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const json = await response.json()
 
@@ -1407,9 +1390,7 @@ export class DrupalClient {
       body,
     })
 
-    if (!response?.ok) {
-      await this.handleJsonApiErrors(response)
-    }
+    await this.throwIfJsonApiErrors(response)
 
     const result: AccessToken = await response.json()
 
@@ -1476,7 +1457,7 @@ export class DrupalClient {
     throw error
   }
 
-  private async handleJsonApiErrors(response: Response) {
+  private async throwIfJsonApiErrors(response: Response) {
     if (!response?.ok) {
       const errors = await this.getErrorsFromResponse(response)
       throw new JsonApiErrors(errors, response.status)

diff --git a/packages/next-drupal/src/draft.ts b/packages/next-drupal/src/draft.ts
@@ -34,6 +34,7 @@ export async function enableDraftMode(
   }
 
   // Send Drupal's data to the draft-mode page.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   const { secret, scope, plugin, ...draftData } = Object.fromEntries(
     searchParams.entries()
   )

diff --git a/packages/next-drupal/tests/.eslintrc.json b/packages/next-drupal/tests/.eslintrc.json
@@ -0,0 +1,11 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "overrides": [
+    {
+      "files": ["*.test.ts"],
+      "rules": {
+        "@typescript-eslint/ban-ts-comment": "off"
+      }
+    }
+  ]
+}