fix/params 🧊 add tests, rework regexp, bye old node

Author: debabin

packages/server/package.json

@@ -37,7 +37,7 @@
     "dist"
   ],
   "engines": {
-    "node": "^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0"
+    "node": "^16.0.0 || >=17.0.0"
   },
   "scripts": {
     "prepublishOnly": "git diff --exit-code",

packages/server/src/core/graphql/createGraphQLRoute/helpers/calculateGraphQLRouteConfigWeight/calculateGraphQLRouteConfigWeight.test.ts

@@ -46,28 +46,14 @@ describe('calculateGraphQLRouteConfigWeight', () => {
     ).toBe(3);
   });
 
-  it('Should add one for variables descriptor scalar value', () => {
-    expect(
-      calculateGraphQLRouteConfigWeight({
-        data: {},
-        entities: {
-          variables: {
-            checkMode: 'equals',
-            value: 'scalar'
-          }
-        } as any
-      })
-    ).toBe(1);
-  });
-
   it('Should count plain object variables without descriptor', () => {
     expect(
       calculateGraphQLRouteConfigWeight({
         data: {},
         entities: {
-          variables: { key: 'value' }
+          variables: { a: 'value', b: 'value' }
         }
       })
-    ).toBe(1);
+    ).toBe(2);
   });
 });

packages/server/src/core/graphql/createGraphQLRoute/helpers/matchGraphQLRequestArtifacts/matchGraphQLRequestArtifacts.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 
 import type { BaseUrl, GraphQLRequestArtifact } from '@/utils/types';
 
@@ -38,13 +38,15 @@ describe('matchGraphQLRequestArtifacts', () => {
     expect(matched).toHaveLength(0);
   });
 
-  it('Should match query string ignoring whitespace', () => {
+  it('Should match equivalent queries with different insignificant whitespace', () => {
     const matched = matchGraphQLRequestArtifacts({
       artifacts: [makeArtifact({ query: 'query { User { name } }' })],
       meta: {
         path: '/',
         operationType: 'query',
-        query: 'query { User { name } }'
+        query: `query  {
+          User  {  name  }
+        }`
       }
     });
     expect(matched).toHaveLength(1);
@@ -123,6 +125,39 @@ describe('matchGraphQLRequestArtifacts', () => {
     expect(matched).toHaveLength(1);
   });
 
+  it('Should match operation name regexp with case-insensitive flag', () => {
+    const matched = matchGraphQLRequestArtifacts({
+      artifacts: [makeArtifact({ operationName: /^getusers$/i })],
+      meta: {
+        path: '/',
+        operationType: 'query',
+        operationName: 'GetUsers'
+      }
+    });
+    expect(matched).toHaveLength(1);
+  });
+
+  it('Should skip artifact with neither query nor operationName', () => {
+    const warn = vi.spyOn(console, 'warn');
+    const artifact = makeArtifact({});
+
+    const matched = matchGraphQLRequestArtifacts({
+      artifacts: [artifact],
+      meta: {
+        path: '/',
+        operationType: 'query',
+        operationName: 'GetUsers'
+      }
+    });
+
+    expect(matched).toHaveLength(0);
+    expect(warn).toHaveBeenCalledWith(
+      `[mock-config] GraphQL artifact with no query or operationName was skipped: ${JSON.stringify(
+        artifact
+      )}`
+    );
+  });
+
   it('Should fail operation name regexp when pattern does not match', () => {
     const matched = matchGraphQLRequestArtifacts({
       artifacts: [makeArtifact({ operationName: /^Other$/ })],

packages/server/src/core/graphql/createGraphQLRoute/helpers/matchGraphQLRequestArtifacts/matchGraphQLRequestArtifacts.ts

@@ -1,3 +1,5 @@
+import { parse, print, stripIgnoredCharacters } from 'graphql';
+
 import type { GraphQLRequestArtifact } from '@/utils/types';
 
 import { normalizeUrl } from '@/utils/helpers';
@@ -25,7 +27,10 @@ export const matchGraphQLRequestArtifacts = ({
 
     if (artifact.query) {
       if (!meta.query) return false;
-      return artifact.query.replace(/\s+/g, '') === meta.query.replace(/\s+/g, '');
+      return (
+        stripIgnoredCharacters(print(parse(artifact.query))) ===
+        stripIgnoredCharacters(print(parse(meta.query)))
+      );
     }
 
     if (artifact.operationName) {
@@ -35,5 +40,10 @@ export const matchGraphQLRequestArtifacts = ({
         : artifact.operationName === meta.operationName;
     }
 
-    throw new Error('Unmatched graphql request');
+    console.warn(
+      `[mock-config] GraphQL artifact with no query or operationName was skipped: ${JSON.stringify(
+        artifact
+      )}`
+    );
+    return false;
   });

packages/server/src/core/rest/createRestRoute/helpers/calculateRestRouteConfigWeight/calculateRestRouteConfigWeight.test.ts

@@ -74,10 +74,10 @@ describe('calculateRestRouteConfigWeight', () => {
       calculateRestRouteConfigWeight({
         data: {},
         entities: {
-          body: { key: 'value' }
+          body: { a: 'value', b: 'value' }
         }
       })
-    ).toBe(1);
+    ).toBe(2);
   });
 
   it('Should add one for non-plain body array', () => {

packages/server/src/core/rest/createRestRoute/helpers/matchRestRequestArtifacts/matchRestRequestArtifacts.test.ts

@@ -79,7 +79,7 @@ describe('matchRestRequestArtifacts', () => {
     const matched = matchRestRequestArtifacts({
       artifacts: [
         makeArtifact({
-          baseUrl: '/api/',
+          baseUrl: '/api',
           path: '/users/:id'
         })
       ],

packages/server/src/core/rest/createRestRoute/helpers/matchRestRequestArtifacts/matchRestRequestArtifacts.ts

@@ -27,10 +27,10 @@ export const matchRestRequestArtifacts = ({ artifacts, meta }: MatchRestRequestA
     if (artifact.method !== meta.method) return false;
 
     if (artifact.path instanceof RegExp) {
-      if (artifact.baseUrl === '/') return artifact.path.test(meta.path);
+      if (artifact.baseUrl === '/') return new RegExp(artifact.path).test(meta.path);
       const tail = meta.path === artifact.baseUrl ? '' : meta.path.slice(artifact.baseUrl.length);
       if (!tail) return false;
-      return artifact.path.test(tail);
+      return new RegExp(artifact.path).test(tail);
     }
 
     return generatePathRegex(urlJoin(artifact.baseUrl, artifact.path)).test(meta.path);

packages/server/src/core/rest/createRestRoute/helpers/prepareRestRequestArtifacts/prepareRestRequestArtifacts.test.ts

@@ -32,6 +32,15 @@ describe('prepareRestRequestArtifacts', () => {
     expect(prepared[1].path).toBe('/users/:id');
   });
 
+  it('Should prefer more specific path over higher route weight', () => {
+    const prepared = prepareRestRequestArtifacts([
+      makeArtifact({ path: '/users/:id', weight: 100 }),
+      makeArtifact({ path: '/users/me', weight: 1 })
+    ]);
+    expect(prepared[0].path).toBe('/users/me');
+    expect(prepared[1].path).toBe('/users/:id');
+  });
+
   it('Should not reorder two non-parameterized paths', () => {
     const prepared = prepareRestRequestArtifacts([
       makeArtifact({ path: '/first' }),

packages/server/src/core/rest/createRestRoute/helpers/prepareRestRequestArtifacts/prepareRestRequestArtifacts.ts

@@ -2,6 +2,7 @@ import type { RestRequestArtifact } from '@/utils/types';
 
 export const prepareRestRequestArtifacts = (requestArtifacts: RestRequestArtifact[]) => {
   const sortedByPathRequestArtifacts = requestArtifacts
+    .toSorted((first, second) => second.weight - first.weight)
     .toSorted(({ path: firstPath }, { path: secondPath }) => {
       // ✅ important:
       // do not compare RegExp paths and non-parameterized paths
@@ -31,8 +32,6 @@ export const prepareRestRequestArtifacts = (requestArtifacts: RestRequestArtifac
         return +isFirstPathPartParameter - +isSecondPathPartParameter;
       }
       return 0;
-    })
-    .toSorted((first, second) => second.weight - first.weight);
-
+    });
   return sortedByPathRequestArtifacts;
 };