Improve infer path structure with user input (#2480)

opticdev · Nov 3, 2023 · 2910f7a · 2910f7a
1 parent 277361c
commit 2910f7a
Show file tree

Hide file tree

Showing 16 changed files with 367 additions and 1,057 deletions.
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "openapi-workspaces",
   "license": "MIT",
   "private": true,
-  "version": "0.50.16",
+  "version": "0.50.17",
   "workspaces": [
     "projects/json-pointer-helpers",
     "projects/openapi-io",

diff --git a/projects/fastify-capture/package.json b/projects/fastify-capture/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/fastify-capture",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.50.16",
+  "version": "0.50.17",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/json-pointer-helpers/package.json b/projects/json-pointer-helpers/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/json-pointer-helpers",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.50.16",
+  "version": "0.50.17",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/openapi-io/package.json b/projects/openapi-io/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-io",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.50.16",
+  "version": "0.50.17",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/openapi-utilities/package.json b/projects/openapi-utilities/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-utilities",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.50.16",
+  "version": "0.50.17",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/optic/package.json b/projects/optic/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/optic",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.50.16",
+  "version": "0.50.17",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/optic/src/commands/capture/actions/undocumented.ts b/projects/optic/src/commands/capture/actions/undocumented.ts
@@ -9,7 +9,7 @@ import {
   CapturedInteraction,
   CapturedInteractions,
 } from '../sources/captured-interactions';
-import { InferPathStructure } from '../operations/infer-path-structure';
+import { PathInference } from '../operations/path-inference';
 import {
   generateEndpointSpecPatches,
   generatePathAndMethodSpecPatches,
@@ -25,7 +25,7 @@ type MethodMap = Map<string, { add: Set<string>; ignore: Set<string> }>;
 
 export async function promptUserForPathPattern(
   interactions: CapturedInteractions,
-  inferredPathStructure: InferPathStructure,
+  pathInference: PathInference,
   options: { update: 'interactive' | 'automatic' }
 ) {
   const filteredInteractions: CapturedInteraction[] = [];
@@ -59,8 +59,7 @@ export async function promptUserForPathPattern(
     const pathInIgnore = [...ignore.values()].some((ignore) =>
       minimatch(path, ignore)
     );
-    const guessedPattern =
-      inferredPathStructure.includeObservedUrlPath(method, path) ?? path;
+    const guessedPattern = pathInference.getInferedPattern(path);
 
     if (pathInAdd) {
       filteredInteractions.push(interaction);
@@ -69,6 +68,7 @@ export async function promptUserForPathPattern(
       continue;
     } else if (options.update === 'automatic') {
       add.add(guessedPattern);
+      pathInference.addKnownPath(guessedPattern);
       filteredInteractions.push(interaction);
     } else {
       logger.info(`> ` + chalk.bold.blue(guessedPattern));
@@ -116,9 +116,11 @@ export async function promptUserForPathPattern(
 
       if (results.action === 'yes') {
         add.add(guessedPattern);
+        pathInference.addKnownPath(guessedPattern);
         filteredInteractions.push(interaction);
       } else if (results.action === 'no') {
         add.add(results.newPath);
+        pathInference.addKnownPath(results.newPath);
         filteredInteractions.push(interaction);
       } else if (results.action === 'skip') {
         continue;

diff --git a/projects/optic/src/commands/capture/capture.ts b/projects/optic/src/commands/capture/capture.ts
@@ -33,7 +33,7 @@ import { GroupedCaptures } from './interactions/grouped-interactions';
 import { OPTIC_URL_KEY } from '../../constants';
 import { uploadCoverage } from './actions/upload-coverage';
 import { resolveRelativePath } from '../../utils/capture';
-import { InferPathStructure } from './operations/infer-path-structure';
+import { PathInference } from './operations/path-inference';
 import { getSpinner } from '../../utils/spinner';
 import { flushEvents, trackEvent } from '../../segment';
 import { getOpticUrlDetails } from '../../utils/cloud-urls';
@@ -557,11 +557,10 @@ export async function processCaptures(
         'Learning path patterns for unmatched requests...'
       );
       options.bufferLogs ? bufferedOutput.push(summary) : logger.info(summary);
-      const inferredPathStructure =
-        await InferPathStructure.fromSpecAndInteractions(
-          spec.jsonLike,
-          captures.getUndocumentedInteractions()
-        );
+      const inferredPathStructure = await PathInference.fromSpecAndInteractions(
+        spec.jsonLike,
+        captures.getUndocumentedInteractions()
+      );
       const {
         interactions: filteredInteractions,
         ignorePaths: newIgnorePaths,