fix: mock issue resolve for similar templated requests (stoplightio#2564

)
stainless-api · Jul 19, 2024 · b8e9fd8 · b8e9fd8
1 parent 68e4f35
commit b8e9fd8
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 8 deletions.
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -10,7 +10,7 @@
     "@stoplight/json": "^3.18.1",
     "@stoplight/json-schema-ref-parser": "9.2.7",
     "@stoplight/prism-core": "^5.8.0",
-    "@stoplight/prism-http": "^5.8.2",
+    "@stoplight/prism-http": "^5.8.3",
     "@stoplight/prism-http-server": "^5.8.2",
     "@stoplight/types": "^14.1.0",
     "chalk": "^4.1.2",

diff --git a/packages/http-server/package.json b/packages/http-server/package.json
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@stoplight/prism-core": "^5.8.0",
-    "@stoplight/prism-http": "^5.8.2",
+    "@stoplight/prism-http": "^5.8.3",
     "@stoplight/types": "^14.1.0",
     "fast-xml-parser": "^4.2.0",
     "fp-ts": "^2.11.5",

diff --git a/packages/http/package.json b/packages/http/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/prism-http",
-  "version": "5.8.2",
+  "version": "5.8.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Stoplight <support@stoplight.io>",

diff --git a/packages/http/src/router/__tests__/index.spec.ts b/packages/http/src/router/__tests__/index.spec.ts
@@ -316,7 +316,7 @@ describe('http router', () => {
           );
         });
 
-        test('given a concrete servers and templated paths should match first resource', () => {
+        test('given a concrete servers and templated paths should match second resource', () => {
           const templatedPathA = '/{x}/y';
           const templatedPathB = '/a/{z}';
           const url = 'concrete.com';
@@ -334,7 +334,7 @@ describe('http router', () => {
                 },
               },
             }),
-            resource => expect(resource).toBe(firstResource)
+            resource => expect(resource).toBe(secondResource)
           );
         });
 

diff --git a/packages/http/src/router/index.ts b/packages/http/src/router/index.ts
@@ -2,6 +2,7 @@ import { IPrismComponents } from '@stoplight/prism-core';
 import { IHttpOperation, IServer } from '@stoplight/types';
 import * as E from 'fp-ts/Either';
 import * as A from 'fp-ts/Array';
+import * as O from 'fp-ts/Ord';
 import { pipe } from 'fp-ts/function';
 import { IHttpConfig, IHttpRequest, ProblemJsonError } from '../types';
 import {
@@ -14,16 +15,42 @@ import {
 import { matchBaseUrl } from './matchBaseUrl';
 import { matchPath } from './matchPath';
 import { IMatch, MatchType } from './types';
+import { isTemplated } from './matchPath';
+
+// matching score is calcualated for resources based upon their match with given request
+// matchScore is introduced to sort the resources in case we get multiple matches for given request.
+const calculateMatchScore = (endpoint: string, request: string) => {
+  const endpointParts = endpoint.split('/');
+  const requestParts = request.split('/');
+  let score = 0;
+  for (let i = 0; i < endpointParts.length; i++) {
+    if (endpointParts[i] === requestParts[i]) {
+      score++;
+    } else if (isTemplated(endpointParts[i])) {
+      score += 0.5;
+    } else {
+      break;
+    }
+  }
+  return score;
+};
+
+
+//sort endpoints based on match score
+const sortEndpointsByMatch = (endpoints:IHttpOperation[], request: string) => {
+  return A.sort(O.contramap((endpoint: IHttpOperation) => calculateMatchScore(endpoint.path, request))(O.ordNumber))(endpoints).reverse();
+};
 
 const route: IPrismComponents<IHttpOperation, IHttpRequest, unknown, IHttpConfig>['route'] = ({ resources, input }) => {
   const { path: requestPath, baseUrl: requestBaseUrl } = input.url;
+  const sortedResources = sortEndpointsByMatch(resources, requestPath);
 
   if (!requestPath.startsWith('/')) {
     return E.left(new Error(`The request path '${requestPath}' must start with a slash.`));
   }
 
   return pipe(
-    resources,
+    sortedResources,
     E.fromPredicate(A.isNonEmpty, () =>
       ProblemJsonError.fromTemplate(
         NO_RESOURCE_PROVIDED_ERROR,
@@ -101,7 +128,7 @@ const route: IPrismComponents<IHttpOperation, IHttpRequest, unknown, IHttpConfig
       }
 
       if (requestBaseUrl) {
-        if (resources.every(resource => !resource.servers || resource.servers.length === 0)) {
+        if (sortedResources.every(resource => !resource.servers || resource.servers.length === 0)) {
           return E.left(
             ProblemJsonError.fromTemplate(
               NO_SERVER_CONFIGURATION_PROVIDED_ERROR,

diff --git a/packages/http/src/router/matchPath.ts b/packages/http/src/router/matchPath.ts
@@ -9,7 +9,7 @@ function fragmentize(path: string): string[] {
   return path.split('/').slice(1).map(decodePathFragment);
 }
 
-function isTemplated(pathFragment: string) {
+export function isTemplated(pathFragment: string) {
   return /{(.+)}/.test(pathFragment);
 }