zudoku 0.0.0-reset-hash-value.ac516c6d → 0.0.0-z06bf8c86

package/src/lib/oas/graphql/circular.test.ts

@@ -0,0 +1,186 @@
+import { describe, expect, it } from "vitest";
+import {
+  CIRCULAR_REF,
+  handleCircularRefs,
+  SCHEMA_REF_PREFIX,
+} from "./circular.js";
+
+describe("handleCircularRefs", () => {
+  it("should return primitives unchanged", () => {
+    expect(handleCircularRefs(null)).toBe(null);
+    expect(handleCircularRefs(undefined)).toBe(undefined);
+    expect(handleCircularRefs(42)).toBe(42);
+    expect(handleCircularRefs("hello")).toBe("hello");
+    expect(handleCircularRefs(true)).toBe(true);
+  });
+
+  it("should handle simple objects without refs", () => {
+    const obj = { type: "string", description: "A string" };
+    const result = handleCircularRefs(obj);
+    expect(result).toEqual(obj);
+  });
+
+  it("should handle arrays", () => {
+    const arr = [{ type: "string" }, { type: "number" }];
+    const result = handleCircularRefs(arr);
+    expect(result).toEqual(arr);
+  });
+
+  it("should detect true circular references via object identity", () => {
+    const obj: Record<string, unknown> = { type: "object" };
+    obj.self = obj;
+
+    const result = handleCircularRefs(obj);
+    expect(result.type).toBe("object");
+    expect(result.self).toContain(CIRCULAR_REF);
+  });
+
+  it("should detect circular refs via __$ref path", () => {
+    const inner = { __$ref: "#/components/schemas/Node", type: "object" };
+    const obj = {
+      __$ref: "#/components/schemas/Node",
+      type: "object",
+      properties: {
+        child: inner,
+      },
+    };
+    (inner as Record<string, unknown>).properties = { parent: obj };
+
+    const result = handleCircularRefs(obj);
+    expect(result.properties.child).toBe(
+      `${SCHEMA_REF_PREFIX}#/components/schemas/Node`,
+    );
+  });
+
+  // Regression test for #1869
+  it("should NOT mark sibling refs to the same schema as circular", () => {
+    const timestampSchema1 = {
+      __$ref: "#/components/schemas/timestamp",
+      type: "string",
+      format: "date-time",
+    };
+    const timestampSchema2 = {
+      __$ref: "#/components/schemas/timestamp",
+      type: "string",
+      format: "date-time",
+    };
+
+    const obj = {
+      type: "object",
+      properties: {
+        created_at: timestampSchema1,
+        updated_at: timestampSchema2,
+      },
+    };
+
+    const result = handleCircularRefs(obj);
+
+    expect(result.properties.created_at).toEqual({
+      __$ref: "#/components/schemas/timestamp",
+      type: "string",
+      format: "date-time",
+    });
+    expect(result.properties.updated_at).toEqual({
+      __$ref: "#/components/schemas/timestamp",
+      type: "string",
+      format: "date-time",
+    });
+  });
+
+  it("should allow same ref path in different branches of the tree", () => {
+    const obj = {
+      type: "object",
+      properties: {
+        user: {
+          type: "object",
+          properties: {
+            id: { __$ref: "#/components/schemas/identifier", type: "string" },
+            name: { type: "string" },
+          },
+        },
+        post: {
+          type: "object",
+          properties: {
+            id: { __$ref: "#/components/schemas/identifier", type: "string" },
+            title: { type: "string" },
+          },
+        },
+      },
+    };
+
+    const result = handleCircularRefs(obj);
+
+    expect(result.properties.user.properties.id.type).toBe("string");
+    expect(result.properties.post.properties.id.type).toBe("string");
+    expect(result.properties.user.properties.id).not.toBe(
+      expect.stringContaining(SCHEMA_REF_PREFIX),
+    );
+    expect(result.properties.post.properties.id).not.toBe(
+      expect.stringContaining(SCHEMA_REF_PREFIX),
+    );
+  });
+
+  it("should handle shared object instances (same object, multiple references)", () => {
+    const sharedSchema = { type: "string", description: "Shared" };
+    const obj = {
+      type: "object",
+      properties: { field1: sharedSchema, field2: sharedSchema },
+    };
+
+    const result = handleCircularRefs(obj);
+
+    expect(result.properties.field1).toEqual({
+      type: "string",
+      description: "Shared",
+    });
+    expect(result.properties.field2).toEqual({
+      type: "string",
+      description: "Shared",
+    });
+  });
+
+  it("should handle nested arrays with refs", () => {
+    const obj = {
+      type: "object",
+      allOf: [
+        { __$ref: "#/components/schemas/Base", type: "object" },
+        { type: "object", properties: { extra: { type: "string" } } },
+      ],
+    };
+
+    const result = handleCircularRefs(obj);
+
+    expect(result.allOf[0]).toEqual({
+      __$ref: "#/components/schemas/Base",
+      type: "object",
+    });
+  });
+
+  it("should deduplicate shared object instances with __$ref", () => {
+    const shared = { __$ref: "#/components/schemas/Foo", type: "string" };
+    const obj = { a: shared, b: shared };
+    const result = handleCircularRefs(obj);
+
+    expect(result.a).toEqual({
+      __$ref: "#/components/schemas/Foo",
+      type: "string",
+    });
+    expect(result.b).toBe(`${SCHEMA_REF_PREFIX}#/components/schemas/Foo`);
+  });
+
+  it("should mark circular ref with property name from path", () => {
+    const parent: Record<string, unknown> = {
+      type: "object",
+      properties: {} as Record<string, unknown>,
+    };
+    const child: Record<string, unknown> = {
+      type: "object",
+      properties: { back: parent },
+    };
+    (parent.properties as Record<string, unknown>).child = child;
+
+    const result = handleCircularRefs(parent);
+
+    expect(result.properties.child.properties.back).toContain(CIRCULAR_REF);
+  });
+});

package/src/lib/oas/graphql/circular.ts

@@ -3,6 +3,7 @@ import { GraphQLJSON } from "graphql-type-json";
 import type { RecordAny } from "../../util/traverse.js";
 
 export const CIRCULAR_REF = "$[Circular Reference]";
+export const SCHEMA_REF_PREFIX = "$ref:";
 
 const OPENAPI_PROPS = new Set([
   "properties",
@@ -13,19 +14,34 @@ const OPENAPI_PROPS = new Set([
   "oneOf",
 ]);
 
-const handleCircularRefs = (
+export const handleCircularRefs = (
   // biome-ignore lint/suspicious/noExplicitAny: Allow any type
   obj: any,
   visited = new WeakSet(),
   refs = new WeakMap(),
   path: string[] = [],
+  seenRefPaths = new Set<string>(),
   // biome-ignore lint/suspicious/noExplicitAny: Allow any type
 ): any => {
   if (obj === null || typeof obj !== "object") return obj;
 
+  const refPath = obj.__$ref;
+
+  // Check if this object has a __$ref marker (set during schema code generation)
+  // If we've already fully processed this ref path, return a reference marker
+  // instead of the full data to avoid JSON.stringify serializing duplicates
+  if (typeof refPath === "string" && seenRefPaths.has(refPath)) {
+    return SCHEMA_REF_PREFIX + refPath;
+  }
+
   if (visited.has(obj)) {
     const cached = refs.get(obj);
-    if (cached) return cached;
+    if (cached) {
+      return typeof refPath === "string"
+        ? // If already processed, return ref marker to avoid duplicate serialization
+          SCHEMA_REF_PREFIX + refPath
+        : cached;
+    }
     const circularProp = path.find((p) => !OPENAPI_PROPS.has(p)) || path[0];
 
     return [CIRCULAR_REF, circularProp].filter(Boolean).join(":");
@@ -33,19 +49,42 @@ const handleCircularRefs = (
 
   visited.add(obj);
 
+  // Add refPath BEFORE recursing to detect cycles within this branch
+  // This will be removed after processing to allow siblings with the same ref
+  if (typeof refPath === "string") {
+    seenRefPaths.add(refPath);
+  }
+
+  let result: RecordAny | RecordAny[];
   if (Array.isArray(obj)) {
-    const result = obj.map((item, index) =>
-      handleCircularRefs(item, visited, refs, [...path, index.toString()]),
+    result = obj.map((item, index) =>
+      handleCircularRefs(
+        item,
+        visited,
+        refs,
+        [...path, index.toString()],
+        seenRefPaths,
+      ),
     );
-    refs.set(obj, result);
-    return result;
+  } else {
+    result = {};
+    for (const [key, value] of Object.entries(obj)) {
+      result[key] = handleCircularRefs(
+        value,
+        visited,
+        refs,
+        [...path, key],
+        seenRefPaths,
+      );
+    }
   }
+  refs.set(obj, result);
 
-  const result: RecordAny = {};
-  for (const [key, value] of Object.entries(obj)) {
-    result[key] = handleCircularRefs(value, visited, refs, [...path, key]);
+  // Remove refPath after processing so sibling refs aren't incorrectly marked
+  if (typeof refPath === "string") {
+    seenRefPaths.delete(refPath);
   }
-  refs.set(obj, result);
+
   return result;
 };
 

package/src/lib/oas/graphql/index.ts

@@ -473,7 +473,9 @@ const OperationItem = builder
                     name,
                     ...(typeof value === "string" ? { value } : value),
                   }))
-                : [],
+                : content.example !== undefined
+                  ? [{ name: "", value: content.example }]
+                  : [],
               encoding: Object.entries(content.encoding ?? {}).map(
                 ([name, value]) => ({ name, ...value }),
               ),
@@ -490,7 +492,7 @@ const OperationItem = builder
               statusCode,
               description: response.description,
               content: Object.entries(response.content ?? {}).map(
-                ([mediaType, { schema, examples }]) => ({
+                ([mediaType, { schema, examples, example }]) => ({
                   mediaType,
                   schema,
                   examples: examples
@@ -498,7 +500,9 @@ const OperationItem = builder
                         name,
                         ...(typeof value === "string" ? { value } : value),
                       }))
-                    : [],
+                    : example !== undefined
+                      ? [{ name: "", value: example }]
+                      : [],
                 }),
               ),
               headers: response.headers,

package/src/lib/oas/parser/index.ts

@@ -1,6 +1,6 @@
-import { merge as mergeAllOf } from "allof-merge";
 import { GraphQLError } from "graphql/error/index.js";
 import { OpenAPIV3, type OpenAPIV3_1 } from "openapi-types";
+import { flattenAllOfProcessor } from "../../util/flattenAllOf.js";
 import { dereference, type JSONSchema } from "./dereference/index.js";
 import { upgradeSchema } from "./upgrade/index.js";
 
@@ -25,6 +25,8 @@ export type TagObject = DeepOmitReference<OpenAPIV3_1.TagObject>;
 export type ExampleObject = DeepOmitReference<OpenAPIV3_1.ExampleObject>;
 export type EncodingObject = DeepOmitReference<OpenAPIV3_1.EncodingObject>;
 export type SchemaObject = DeepOmitReference<OpenAPIV3_1.SchemaObject>;
+export type ArraySchemaObject =
+  DeepOmitReference<OpenAPIV3_1.ArraySchemaObject>;
 export type ServerObject = DeepOmitReference<OpenAPIV3_1.ServerObject>;
 
 export const HttpMethods = Object.values(OpenAPIV3.HttpMethods);
@@ -101,7 +103,12 @@ export const validate = async (schemaInput: unknown) => {
 
   const dereferenced = await dereference(schema);
   const upgraded = upgradeSchema(dereferenced);
-  const merged = mergeAllOf(upgraded) as OpenAPIDocument;
 
-  return merged;
+  const flattened = await flattenAllOfProcessor({
+    schema: upgraded,
+    file: "schema.json",
+    dereference: async (schema) => schema,
+  });
+
+  return flattened;
 };

package/src/lib/plugins/api-keys/ProtectedRoute.tsx

@@ -11,15 +11,19 @@ export const ProtectedRoute = () => {
     return null;
   }
 
+  if (!auth.isAuthEnabled) {
+    return (
+      <div className="flex flex-col justify-center gap-2 items-center h-1/2">
+        <DeveloperHint className="max-w-[600px]">
+          Authentication needs to be enabled for API keys to work. Enable it in
+          your Zudoku configuration under <code>authentication</code>.
+        </DeveloperHint>
+      </div>
+    );
+  }
+
   return auth.isAuthenticated ? (
     <Outlet />
-  ) : !auth.isAuthEnabled ? (
-    <div className="flex flex-col justify-center gap-2 items-center h-1/2">
-      <DeveloperHint className="max-w-[600px]">
-        Authentication needs to be enabled for API keys to work. Enable it in
-        your Zudoku configuration under <code>authentication</code>.
-      </DeveloperHint>
-    </div>
   ) : (
     <div className="flex flex-col justify-center gap-2 items-center h-1/2">
       Please login first to view this page