apify-schema-tools 3.1.0 → 3.2.0

package/test/middle-schema/compare-schemas.test.ts

@@ -0,0 +1,585 @@
+import { describe, expect, it } from "vitest";
+import { compareMiddleObjects } from "../../src/middle-schema/compare-schemas.js";
+import type { MiddleObject } from "../../src/middle-schema/schema.js";
+
+describe("Compare-schemas utilities", () => {
+	describe("compareMiddleObjects", () => {
+		const baseSchema: MiddleObject = {
+			doc: "Base schema",
+			isRequired: true,
+			isArray: false,
+			properties: {
+				name: {
+					doc: "User name",
+					isRequired: true,
+					isArray: false,
+					type: "string",
+				},
+				age: {
+					doc: undefined,
+					isRequired: false,
+					isArray: false,
+					type: "number",
+				},
+			},
+		};
+
+		it("should return true for identical schemas", () => {
+			const schemaA: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(true);
+		});
+
+		it("should return false for schemas with different number of properties", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+					email: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for schemas with different property names", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					fullName: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for schemas with different additionalProperties", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+				additionalProperties: {
+					doc: "Additional properties",
+					isRequired: true,
+					isArray: false,
+					type: "boolean",
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for properties with different types", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "string", // Different type
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for properties with different isRequired values", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: false, // Different isRequired
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for properties with different isArray values", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "User name",
+						isRequired: true,
+						isArray: true, // Different isArray
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false for properties with different documentation when ignoreDocs is false", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "Different documentation", // Different doc
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: undefined,
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB, false)).toBe(false);
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false); // Default is false
+		});
+
+		it("should return true for properties with different documentation when ignoreDocs is true", () => {
+			const schemaA = baseSchema;
+			const schemaB: MiddleObject = {
+				doc: "Test schema",
+				isRequired: true,
+				isArray: false,
+				properties: {
+					name: {
+						doc: "Different documentation", // Different doc
+						isRequired: true,
+						isArray: false,
+						type: "string",
+					},
+					age: {
+						doc: "Different age doc", // Different doc
+						isRequired: false,
+						isArray: false,
+						type: "number",
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB, true)).toBe(true);
+		});
+
+		it("should handle enum properties correctly", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						enum: ["active", "inactive", "pending"],
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						enum: ["active", "inactive", "pending"],
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(true);
+		});
+
+		it("should return false for enum properties with different values", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						enum: ["active", "inactive", "pending"],
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						enum: ["active", "inactive", "cancelled"], // Different enum value
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should handle nested object properties correctly", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					user: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						properties: {
+							name: {
+								doc: undefined,
+								isRequired: true,
+								isArray: false,
+								type: "string",
+							},
+							age: {
+								doc: undefined,
+								isRequired: false,
+								isArray: false,
+								type: "number",
+							},
+						},
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					user: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						properties: {
+							name: {
+								doc: undefined,
+								isRequired: true,
+								isArray: false,
+								type: "string",
+							},
+							age: {
+								doc: undefined,
+								isRequired: false,
+								isArray: false,
+								type: "number",
+							},
+						},
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(true);
+		});
+
+		it("should return false for nested schemas with different structures", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					user: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						properties: {
+							name: {
+								doc: undefined,
+								isRequired: true,
+								isArray: false,
+								type: "string",
+							},
+							age: {
+								doc: undefined,
+								isRequired: false,
+								isArray: false,
+								type: "number",
+							},
+						},
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					user: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						properties: {
+							name: {
+								doc: undefined,
+								isRequired: true,
+								isArray: false,
+								type: "string",
+							},
+							// Missing age property
+						},
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should handle union types correctly", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					value: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: ["string", "number"],
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					value: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: ["string", "number"],
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(true);
+		});
+
+		it("should return false for union types with different order", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					value: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: ["string", "number"],
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					value: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: ["number", "string"], // Different order
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false when comparing object property to basic var property", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					data: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						properties: {
+							name: {
+								doc: undefined,
+								isRequired: true,
+								isArray: false,
+								type: "string",
+							},
+						},
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					data: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: "string", // Basic var instead of object
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+
+		it("should return false when comparing enum property to basic var property", () => {
+			const schemaA: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						enum: ["active", "inactive"],
+					},
+				},
+			};
+			const schemaB: MiddleObject = {
+				doc: undefined,
+				isRequired: true,
+				isArray: false,
+				properties: {
+					status: {
+						doc: undefined,
+						isRequired: true,
+						isArray: false,
+						type: "string", // Basic var instead of enum
+					},
+				},
+			};
+
+			expect(compareMiddleObjects(schemaA, schemaB)).toBe(false);
+		});
+	});
+});