chore: remove swagger-parser validation (#140)

Author: vwong

.changeset/ripe-ads-lie.md

@@ -0,0 +1,5 @@
+---
+"@pactflow/openapi-pact-comparator": minor
+---
+
+Remove swagger-parser validation as it is very slow

package-lock.json

@@ -41,7 +41,6 @@
   "license": "Apache-2.0",
   "type": "module",
   "devDependencies": {
-    "@apidevtools/swagger-parser": "10.1.1",
     "@changesets/cli": "2.28.1",
     "@eslint/js": "9.23.0",
     "@pactflow/swagger-mock-validator": "14.5.0",

package.json

@@ -31,6 +31,8 @@ export class Comparator {
     this.#config = new Map(DEFAULT_CONFIG);
     this.#oas = oas;
 
+    parseOas(oas);
+
     const ajvOptions = {
       allErrors: true,
       discriminator: true,
@@ -51,7 +53,6 @@ export class Comparator {
 
   async *compare(pact: Pact): AsyncGenerator<Result> {
     if (!this.#router) {
-      await parseOas(this.#oas);
       for (const [key, value] of Object.entries(this.#oas.info)) {
         if (key.startsWith("x-opc-config-")) {
           this.#config.set(key.substring(13) as ConfigKeys, value);

src/compare/index.ts

@@ -1,6 +1,4 @@
 import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
-import SwaggerParser from "@apidevtools/swagger-parser";
-import { cloneDeep } from "lodash-es";
 
 const isSwagger2 = (oas: OpenAPIV2.Document): boolean =>
   Object.prototype.hasOwnProperty.call(oas, "swagger") &&
@@ -12,17 +10,15 @@ const isOpenApi3 = (oas: OpenAPIV3.Document): boolean =>
   typeof oas.openapi === "string" &&
   oas.openapi.indexOf("3.") === 0;
 
-export const parse = async (
-  oas: OpenAPIV2.Document | OpenAPIV3.Document,
-): Promise<void> => {
+export const parse = (oas: OpenAPIV2.Document | OpenAPIV3.Document): void => {
   if (
     !isSwagger2(oas as OpenAPIV2.Document) &&
     !isOpenApi3(oas as OpenAPIV3.Document)
   ) {
     throw new ParserError();
   }
 
-  await SwaggerParser.validate(cloneDeep(oas));
+  // FIXME: ideally, we validate the document here
 };
 
 export class ParserError extends Error {