migrate to allof-merge library to improve merging

sserrata · sserrata · commit f10ceb8f0560 · 2024-10-10T14:06:19.000-04:00
diff --git a/packages/docusaurus-plugin-openapi-docs/package.json b/packages/docusaurus-plugin-openapi-docs/package.json
@@ -42,11 +42,11 @@
     "@docusaurus/utils": "^3.5.0",
     "@docusaurus/utils-validation": "^3.5.0",
     "@redocly/openapi-core": "^1.10.5",
+    "allof-merge": "^0.6.6",
     "chalk": "^4.1.2",
     "clsx": "^1.1.1",
     "fs-extra": "^9.0.1",
     "json-pointer": "^0.6.2",
-    "json-schema-merge-allof": "^0.8.1",
     "json5": "^2.2.3",
     "lodash": "^4.17.20",
     "mustache": "^4.2.0",
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts
@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { merge } from "allof-merge";
 import clsx from "clsx";
 import isEmpty from "lodash/isEmpty";
 
@@ -19,41 +21,18 @@ import { getQualifierMessage, getSchemaName } from "./schema";
 import { create, guard } from "./utils";
 import { SchemaObject } from "../openapi/types";
 
-const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
-
 let SCHEMA_TYPE: "request" | "response";
 
 /**
  * Returns a merged representation of allOf array of schemas.
  */
-export function mergeAllOf(allOf: SchemaObject[]) {
-  const mergedSchemas = jsonSchemaMergeAllOf(allOf, {
-    resolvers: {
-      readOnly: function () {
-        return true;
-      },
-      writeOnly: function () {
-        return true;
-      },
-      example: function () {
-        return true;
-      },
-      "x-examples": function () {
-        return true;
-      },
-    },
-    ignoreAdditionalProperties: true,
-  });
-
-  const mergedRequired = allOf.reduce((acc, cur) => {
-    if (Array.isArray(cur.required)) {
-      const next = [...acc, ...cur.required];
-      return next;
-    }
-    return acc;
-  }, [] as any);
+export function mergeAllOf(allOf: SchemaObject) {
+  const onMergeError = (msg: string) => {
+    console.warn(msg);
+  };
 
-  return { mergedSchemas, mergedRequired };
+  const mergedSchemas = merge(allOf, { onMergeError });
+  return mergedSchemas;
 }
 
 /**
@@ -271,10 +250,7 @@ function createItems(schema: SchemaObject) {
 
   if (schema.items?.allOf !== undefined) {
     // TODO: figure out if and how we should pass merged required array
-    const {
-      mergedSchemas,
-    }: { mergedSchemas: SchemaObject; mergedRequired: string[] | boolean } =
-      mergeAllOf(schema.items?.allOf);
+    const mergedSchemas = mergeAllOf(schema.items) as SchemaObject;
 
     // Handles combo anyOf/oneOf + properties
     if (
@@ -684,60 +660,52 @@ function createEdges({
   }
 
   if (schema.allOf !== undefined) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      schema.allOf
-    );
-    delete schema.allOf;
-    const combinedSchemas = { ...schema, ...mergedSchemas };
+    const mergedSchemas = mergeAllOf(schema) as SchemaObject;
 
     if (SCHEMA_TYPE === "request") {
-      if (combinedSchemas.readOnly && combinedSchemas.readOnly === true) {
+      if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
         return undefined;
       }
     }
 
     if (SCHEMA_TYPE === "response") {
-      if (combinedSchemas.writeOnly && combinedSchemas.writeOnly === true) {
+      if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
         return undefined;
       }
     }
 
-    const mergedSchemaName = getSchemaName(combinedSchemas);
-
-    if (name === "eventName") {
-      console.log(mergedSchemaName, combinedSchemas);
-    }
+    const mergedSchemaName = getSchemaName(mergedSchemas);
 
     if (
-      combinedSchemas.oneOf !== undefined ||
-      combinedSchemas.anyOf !== undefined
+      mergedSchemas.oneOf !== undefined ||
+      mergedSchemas.anyOf !== undefined
     ) {
       return createDetailsNode(
         name,
         mergedSchemaName,
-        combinedSchemas,
+        mergedSchemas,
         required,
-        combinedSchemas.nullable
+        mergedSchemas.nullable
       );
     }
 
-    if (combinedSchemas.properties !== undefined) {
+    if (mergedSchemas.properties !== undefined) {
       return createDetailsNode(
         name,
         mergedSchemaName,
-        combinedSchemas,
+        mergedSchemas,
         required,
-        combinedSchemas.nullable
+        mergedSchemas.nullable
       );
     }
 
-    if (combinedSchemas.additionalProperties !== undefined) {
+    if (mergedSchemas.additionalProperties !== undefined) {
       return createDetailsNode(
         name,
         mergedSchemaName,
-        combinedSchemas,
+        mergedSchemas,
         required,
-        combinedSchemas.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -746,9 +714,9 @@ function createEdges({
       return createDetailsNode(
         name,
         mergedSchemaName,
-        combinedSchemas,
+        mergedSchemas,
         required,
-        combinedSchemas.nullable
+        mergedSchemas.nullable
       );
     }
 
@@ -757,8 +725,8 @@ function createEdges({
       name,
       required: Array.isArray(required) ? required.includes(name) : required,
       schemaName: mergedSchemaName,
-      qualifierMessage: getQualifierMessage(combinedSchemas),
-      schema: combinedSchemas,
+      qualifierMessage: getQualifierMessage(mergedSchemas),
+      schema: mergedSchemas,
     });
   }
 
@@ -815,7 +783,7 @@ export function createNodes(
   }
 
   if (schema.allOf !== undefined) {
-    const { mergedSchemas } = mergeAllOf(schema.allOf);
+    const mergedSchemas = mergeAllOf(schema) as SchemaObject;
 
     if (
       mergedSchemas.oneOf !== undefined ||
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/createRequestExample.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/createRequestExample.ts
@@ -66,9 +66,7 @@ function sampleRequestFromProp(name: string, prop: any, obj: any): any {
   } else if (prop.anyOf) {
     obj[name] = sampleRequestFromSchema(prop.anyOf[0]);
   } else if (prop.allOf) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      prop.allOf
-    );
+    const mergedSchemas = mergeAllOf(prop.allOf) as SchemaObject;
     sampleRequestFromProp(name, mergedSchemas, obj);
   } else {
     obj[name] = sampleRequestFromSchema(prop);
@@ -107,8 +105,7 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
     }
 
     if (allOf) {
-      const { mergedSchemas }: { mergedSchemas: SchemaObject } =
-        mergeAllOf(allOf);
+      const mergedSchemas = mergeAllOf(allOf) as SchemaObject;
       if (mergedSchemas.properties) {
         for (const [key, value] of Object.entries(mergedSchemas.properties)) {
           if ((value.readOnly && value.readOnly === true) || value.deprecated) {
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/createResponseExample.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/createResponseExample.ts
@@ -66,9 +66,7 @@ function sampleResponseFromProp(name: string, prop: any, obj: any): any {
   } else if (prop.anyOf) {
     obj[name] = sampleResponseFromSchema(prop.anyOf[0]);
   } else if (prop.allOf) {
-    const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      prop.allOf
-    );
+    const mergedSchemas = mergeAllOf(prop) as SchemaObject;
     sampleResponseFromProp(name, mergedSchemas, obj);
   } else {
     obj[name] = sampleResponseFromSchema(prop);
@@ -87,8 +85,7 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
     }
 
     if (allOf) {
-      const { mergedSchemas }: { mergedSchemas: SchemaObject } =
-        mergeAllOf(allOf);
+      const mergedSchemas = mergeAllOf(allOf) as SchemaObject;
       if (mergedSchemas.properties) {
         for (const [key, value] of Object.entries(mergedSchemas.properties)) {
           if (
diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json
@@ -39,6 +39,7 @@
     "@docusaurus/theme-common": "^3.5.0",
     "@hookform/error-message": "^2.0.1",
     "@reduxjs/toolkit": "^1.7.1",
+    "allof-merge": "^0.6.6",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ResponseSchema/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ResponseSchema/index.tsx
@@ -104,7 +104,7 @@ const ResponseSchemaComponent: React.FC<Props> = ({
                         )}
                       </div>
                       <ul style={{ marginLeft: "1rem" }}>
-                        <SchemaNode schema={firstBody} schemaType="request" />
+                        <SchemaNode schema={firstBody} schemaType="response" />
                       </ul>
                     </Details>
                   </TabItem>
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx
diff --git a/yarn.lock b/yarn.lock
