feat: use mask (*) instead of parameter names while matching rest operations during comparison (#15)

* feat: use mask (*) instead of parameter names while matching rest operations during comparison

* fix: slugify removes * symbol

* fix: resolvers

* refactor: mapping types

* fix: resolved locally operations

* fix: version resolver cache key

* feat: add comparison.previousOperationId

* fix: remove includeSummary flag to avoid direct dashboards comparison

* fix: remove unnecessary fields

* fix: restore includeOperations flag to fix playwright tests

* fix: error messages

* feat: add comparison.previousOperationId

* refactor: move normalized id creation to apiBuilder method

* fix: small issues

* feat(ignore param name): Set dist tag

* feat(ignore param name): Added npm script to update dev deps. Skipped test suite

* fix: add missing apiType filtration

* refactor: align previousOperationMetadata

* fix(types): Updated type in accordance to implementation

* chore: remove unnecessary prerelease suffixes

---------

Co-authored-by: Sergei Komarov <[email protected]>
Co-authored-by: b41ex <[email protected]>

Author: 3 people

package-lock.json

@@ -15,7 +15,7 @@
       "require": "./dist/cjs/src/index.js"
     }
   },
-  "scripts": {
+  "scripts": {    
     "build": "tsc --module commonjs --outDir dist/cjs && vite build",
     "build:web": "vite build",
     "performance:build": "vite build --sourcemap=inline -c=vite.performance.config.ts",

package.json

@@ -19,7 +19,7 @@ import { OpenAPIV3 } from 'openapi-types'
 import { buildRestDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
-import { buildRestOperations } from './rest.operations'
+import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
 import { parseRestFile } from './rest.parser'
 
 import { ApiBuilder } from '../../types'
@@ -34,4 +34,5 @@ export const restApiBuilder: ApiBuilder<OpenAPIV3.Document> = {
   buildOperations: buildRestOperations,
   dumpDocument: dumpRestDocument,
   compareOperationsData: compareRestOperationsData,
+  createNormalizedOperationId: createNormalizedOperationId,
 }

src/apitypes/rest/index.ts

@@ -17,8 +17,14 @@
 import { OpenAPIV3 } from 'openapi-types'
 
 import { buildRestOperation } from './rest.operation'
-import { OperationsBuilder } from '../../types'
-import { createBundlingErrorHandler, removeComponents, removeFirstSlash, slugify } from '../../utils'
+import { OperationIdNormalizer, OperationsBuilder } from '../../types'
+import {
+  createBundlingErrorHandler,
+  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
+  removeComponents,
+  removeFirstSlash,
+  slugify,
+} from '../../utils'
 import { getOperationBasePath } from './rest.utils'
 import type * as TYPE from './rest.types'
 import { HASH_FLAG, INLINE_REFS_FLAG, MESSAGE_SEVERITY, NORMALIZE_OPTIONS, ORIGINS_SYMBOL } from '../../consts'
@@ -106,3 +112,8 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
   }
   return operations
 }
+
+export const createNormalizedOperationId: OperationIdNormalizer = (operation) => {
+  const { metadata: { path, method } } = operation
+  return slugify(`${path}-${method}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
+}

src/apitypes/rest/rest.operations.ts

@@ -18,13 +18,14 @@ import type { OpenAPIV3 } from 'openapi-types'
 
 import type { ApiOperation, NotificationMessage, VersionDocument } from '../../types'
 import { REST_DOCUMENT_TYPE, REST_KIND_KEY, REST_SCOPES } from './rest.consts'
+import { NormalizedPath } from '../../utils'
 
 export type RestScopeType = keyof typeof REST_SCOPES
 export type RestDocumentType = (typeof REST_DOCUMENT_TYPE)[keyof typeof REST_DOCUMENT_TYPE]
 export type CustomTags = Record<string, unknown>
 
 export interface RestOperationMeta {
-  path: string                            // `/packages/*/version/*`
+  path: NormalizedPath                    // `/packages/*/version/*`
   originalPath: string                    // `/packages/{packageId}/version/{version}`
   method: OpenAPIV3.HttpMethods           // `get` | `post` | ...
   tags?: string[]                         // operations tags

src/apitypes/rest/rest.types.ts

@@ -27,8 +27,6 @@ import {
   ResolvedDeprecatedOperations,
   ResolvedDocuments,
   ResolvedOperations,
-  ResolvedVersionOperationsHashMap,
-  VALIDATION_RULES_SEVERITY_LEVEL_WARNING,
   VersionId,
   VersionsComparison,
 } from './types'
@@ -288,7 +286,10 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     packageId = packageId ?? this.config.packageId
 
     if (this.canBeResolvedLocally(version, packageId)) {
-      const currentOperations = operationIds ? this.operationList.filter(({ operationId }) => operationIds.includes(operationId)) : this.operationList
+      const currentApiTypeOperations = this.operationList.filter((operation) => operation.apiType === apiType)
+      const currentOperations = operationIds
+        ? currentApiTypeOperations.filter(({ operationId }) => operationIds.includes(operationId))
+        : currentApiTypeOperations
       return { operations: currentOperations }
     }
 
@@ -417,6 +418,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       throw new Error('No versionResolver provided')
     }
 
+    // includeOperations=true is only used to extract unique apiTypes (see getUniqueApiTypesFromVersions)
+    // the operations map itself is no longer used in processor
     const versionContent = await versionResolver(packageId, version, true)
 
     if (!versionContent) {
@@ -495,10 +498,9 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     const operationsTypes: OperationTypes[] = []
 
     for (const apiType of this.existingOperationsApiTypes) {
-      const operationsHashMap = this.operationsHashMapByApiType(apiType)
       operationsTypes.push({
         apiType: apiType,
-        operations: operationsHashMap,
+        operationsCount: this.operations.size,
       })
     }
 
@@ -511,18 +513,6 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     return new Set(apiTypes)
   }
 
-  private operationsHashMapByApiType(operationsApiType: OperationsApiType): ResolvedVersionOperationsHashMap {
-    const hashMap: ResolvedVersionOperationsHashMap = {}
-
-    for (const { apiType, operationId, dataHash } of this.operations.values()) {
-      if (apiType === operationsApiType) {
-        hashMap[operationId] = dataHash
-      }
-    }
-
-    return hashMap
-  }
-
   async parseFile(fileId: string, source: Blob): Promise<File | null> {
     if (this.parsedFiles.has(fileId)) {
       return this.parsedFiles.get(fileId) ?? null