mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
🔃 refactor: Conslidate JSON Schema Conversion to Schema
This commit is contained in:
Danny Avila
parent
4bbdc4c402
commit
e4531d682d
3 changed files with 64 additions and 51 deletions
|
|
@ -2,7 +2,7 @@
|
|||
// zod.spec.ts
|
||||
import { z } from 'zod';
|
||||
import type { JsonSchemaType } from '~/types';
|
||||
import { resolveJsonSchemaRefs, convertJsonSchemaToZod } from './zod';
|
||||
import { resolveJsonSchemaRefs, convertJsonSchemaToZod, convertWithResolvedRefs } from './zod';
|
||||
|
||||
describe('convertJsonSchemaToZod', () => {
|
||||
describe('primitive types', () => {
|
||||
|
|
@ -10,7 +10,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
const schema: JsonSchemaType = {
|
||||
type: 'string',
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse('test')).toBe('test');
|
||||
expect(() => zodSchema?.parse(123)).toThrow();
|
||||
|
|
@ -21,7 +21,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
type: 'string',
|
||||
enum: ['foo', 'bar', 'baz'],
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse('foo')).toBe('foo');
|
||||
expect(() => zodSchema?.parse('invalid')).toThrow();
|
||||
|
|
@ -31,7 +31,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
const schema: JsonSchemaType = {
|
||||
type: 'number',
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse(123)).toBe(123);
|
||||
expect(() => zodSchema?.parse('123')).toThrow();
|
||||
|
|
@ -41,7 +41,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
const schema: JsonSchemaType = {
|
||||
type: 'boolean',
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse(true)).toBe(true);
|
||||
expect(() => zodSchema?.parse('true')).toThrow();
|
||||
|
|
@ -54,7 +54,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
type: 'array',
|
||||
items: { type: 'string' },
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse(['a', 'b', 'c'])).toEqual(['a', 'b', 'c']);
|
||||
expect(() => zodSchema?.parse(['a', 123, 'c'])).toThrow();
|
||||
|
|
@ -65,7 +65,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
type: 'array',
|
||||
items: { type: 'number' },
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse([1, 2, 3])).toEqual([1, 2, 3]);
|
||||
expect(() => zodSchema?.parse([1, '2', 3])).toThrow();
|
||||
|
|
@ -81,7 +81,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
age: { type: 'number' },
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse({ name: 'John', age: 30 })).toEqual({ name: 'John', age: 30 });
|
||||
expect(() => zodSchema?.parse({ name: 123, age: 30 })).toThrow();
|
||||
|
|
@ -96,7 +96,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
required: ['name'],
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse({ name: 'John' })).toEqual({ name: 'John' });
|
||||
expect(() => zodSchema?.parse({})).toThrow();
|
||||
|
|
@ -117,7 +117,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
required: ['user'],
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse({ user: { name: 'John', age: 30 } })).toEqual({
|
||||
user: { name: 'John', age: 30 },
|
||||
|
|
@ -135,7 +135,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse({ names: ['John', 'Jane'] })).toEqual({ names: ['John', 'Jane'] });
|
||||
expect(() => zodSchema?.parse({ names: ['John', 123] })).toThrow();
|
||||
|
|
@ -148,7 +148,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
type: 'object',
|
||||
properties: {},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse({})).toEqual({});
|
||||
});
|
||||
|
|
@ -157,7 +157,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
const schema = {
|
||||
type: 'invalid',
|
||||
} as unknown as JsonSchemaType;
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse('anything')).toBe('anything');
|
||||
expect(zodSchema?.parse(123)).toBe(123);
|
||||
|
|
@ -168,7 +168,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
type: 'string',
|
||||
enum: [],
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(zodSchema?.parse('test')).toBe('test');
|
||||
});
|
||||
|
|
@ -208,7 +208,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
required: ['id', 'user'],
|
||||
};
|
||||
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
const validData = {
|
||||
id: 1,
|
||||
|
|
@ -254,7 +254,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
name: { type: 'string' },
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
expect(zodSchema?.description).toBe('A test schema description');
|
||||
});
|
||||
|
||||
|
|
@ -272,7 +272,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
const shape = (zodSchema as z.ZodObject<any>).shape;
|
||||
expect(shape.name.description).toBe("The user's name");
|
||||
|
|
@ -307,7 +307,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
// Type assertions for better type safety
|
||||
const shape = zodSchema instanceof z.ZodObject ? zodSchema.shape : {};
|
||||
|
|
@ -352,7 +352,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
const shape = (zodSchema as z.ZodObject<any>).shape;
|
||||
expect(shape.tags.description).toBe('User tags');
|
||||
|
|
@ -375,7 +375,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
},
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
const shape = (zodSchema as z.ZodObject<any>).shape;
|
||||
expect(shape.role.description).toBe('User role in the system');
|
||||
|
|
@ -435,7 +435,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
};
|
||||
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
// Test top-level description
|
||||
expect(zodSchema?.description).toBe('User profile configuration');
|
||||
|
|
@ -476,7 +476,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
additionalProperties: true,
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
// Should accept the defined property
|
||||
expect(zodSchema?.parse({ name: 'John' })).toEqual({ name: 'John' });
|
||||
|
|
@ -501,7 +501,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
additionalProperties: { type: 'number' },
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
// Should accept the defined property
|
||||
expect(zodSchema?.parse({ name: 'John' })).toEqual({ name: 'John' });
|
||||
|
|
@ -527,7 +527,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
additionalProperties: false,
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
// Should accept the defined properties
|
||||
expect(zodSchema?.parse({ name: 'John', age: 30 })).toEqual({ name: 'John', age: 30 });
|
||||
|
|
@ -544,7 +544,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
age: { type: 'number' },
|
||||
},
|
||||
};
|
||||
const zodSchemaWithoutAdditionalProps = convertJsonSchemaToZod(schemaWithoutAdditionalProps);
|
||||
const zodSchemaWithoutAdditionalProps = convertWithResolvedRefs(schemaWithoutAdditionalProps);
|
||||
|
||||
expect(zodSchemaWithoutAdditionalProps?.parse({ name: 'John', age: 30 })).toEqual({
|
||||
name: 'John',
|
||||
|
|
@ -580,7 +580,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
additionalProperties: false,
|
||||
};
|
||||
const zodSchema = convertJsonSchemaToZod(schema);
|
||||
const zodSchema = convertWithResolvedRefs(schema);
|
||||
|
||||
const validData = {
|
||||
user: {
|
||||
|
|
@ -625,7 +625,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
];
|
||||
|
||||
emptyObjectSchemas.forEach((schema) => {
|
||||
expect(convertJsonSchemaToZod(schema, { allowEmptyObject: false })).toBeUndefined();
|
||||
expect(convertWithResolvedRefs(schema, { allowEmptyObject: false })).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
|
|
@ -636,7 +636,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
];
|
||||
|
||||
emptyObjectSchemas.forEach((schema) => {
|
||||
const result = convertJsonSchemaToZod(schema, { allowEmptyObject: true });
|
||||
const result = convertWithResolvedRefs(schema, { allowEmptyObject: true });
|
||||
expect(result).toBeDefined();
|
||||
expect(result instanceof z.ZodObject).toBeTruthy();
|
||||
});
|
||||
|
|
@ -649,7 +649,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
];
|
||||
|
||||
emptyObjectSchemas.forEach((schema) => {
|
||||
const result = convertJsonSchemaToZod(schema);
|
||||
const result = convertWithResolvedRefs(schema);
|
||||
expect(result).toBeDefined();
|
||||
expect(result instanceof z.ZodObject).toBeTruthy();
|
||||
});
|
||||
|
|
@ -663,8 +663,8 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
};
|
||||
|
||||
const resultWithFlag = convertJsonSchemaToZod(schema, { allowEmptyObject: false });
|
||||
const resultWithoutFlag = convertJsonSchemaToZod(schema);
|
||||
const resultWithFlag = convertWithResolvedRefs(schema, { allowEmptyObject: false });
|
||||
const resultWithoutFlag = convertWithResolvedRefs(schema);
|
||||
|
||||
expect(resultWithFlag).toBeDefined();
|
||||
expect(resultWithoutFlag).toBeDefined();
|
||||
|
|
@ -690,7 +690,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Convert with dropFields option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
dropFields: ['anyOf', 'oneOf'],
|
||||
});
|
||||
|
||||
|
|
@ -731,7 +731,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Convert with dropFields option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
dropFields: ['anyOf', 'oneOf'],
|
||||
});
|
||||
|
||||
|
|
@ -769,7 +769,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Convert with dropFields option for fields that don't exist
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
dropFields: ['anyOf', 'oneOf', 'nonExistentField'],
|
||||
});
|
||||
|
||||
|
|
@ -811,7 +811,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Convert with dropFields option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
dropFields: ['anyOf', 'oneOf'],
|
||||
});
|
||||
|
||||
|
|
@ -844,14 +844,14 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Test with allowEmptyObject: false
|
||||
const result1 = convertJsonSchemaToZod(schema, {
|
||||
const result1 = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: false,
|
||||
dropFields: ['anyOf'],
|
||||
});
|
||||
expect(result1).toBeUndefined();
|
||||
|
||||
// Test with allowEmptyObject: true
|
||||
const result2 = convertJsonSchemaToZod(schema, {
|
||||
const result2 = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: true,
|
||||
dropFields: ['anyOf'],
|
||||
});
|
||||
|
|
@ -870,7 +870,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
} as JsonSchemaType & { oneOf?: any };
|
||||
|
||||
// Convert with transformOneOfAnyOf option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
||||
|
|
@ -889,7 +889,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
} as JsonSchemaType & { anyOf?: any };
|
||||
|
||||
// Convert with transformOneOfAnyOf option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
||||
|
|
@ -925,7 +925,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
} as JsonSchemaType & { oneOf?: any };
|
||||
|
||||
// Convert with transformOneOfAnyOf option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
||||
|
|
@ -949,7 +949,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
} as JsonSchemaType & { oneOf?: any };
|
||||
|
||||
// Convert with transformOneOfAnyOf option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
||||
|
|
@ -1008,7 +1008,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// Convert with transformOneOfAnyOf option
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
||||
|
|
@ -1072,7 +1072,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
} as JsonSchemaType & { oneOf?: any; deprecated?: boolean };
|
||||
|
||||
// Convert with both options
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
transformOneOfAnyOf: true,
|
||||
dropFields: ['deprecated'],
|
||||
});
|
||||
|
|
@ -1109,7 +1109,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
};
|
||||
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: false,
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
|
@ -1138,7 +1138,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
};
|
||||
|
||||
const zodSchemaWithoutAllow = convertJsonSchemaToZod(schema, {
|
||||
const zodSchemaWithoutAllow = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: false,
|
||||
});
|
||||
|
||||
|
|
@ -1170,7 +1170,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
],
|
||||
};
|
||||
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: false,
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
|
@ -1242,7 +1242,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
},
|
||||
};
|
||||
|
||||
const zodSchema = convertJsonSchemaToZod(schema, {
|
||||
const zodSchema = convertWithResolvedRefs(schema, {
|
||||
allowEmptyObject: false,
|
||||
transformOneOfAnyOf: true,
|
||||
});
|
||||
|
|
@ -1321,6 +1321,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
};
|
||||
|
||||
// First test without resolving refs - should not work properly
|
||||
// Intentionally NOT using convertWithResolvedRefs here to test the behavior without ref resolution
|
||||
const zodSchemaUnresolved = convertJsonSchemaToZod(schemaWithRefs as any, {
|
||||
allowEmptyObject: true,
|
||||
transformOneOfAnyOf: true,
|
||||
|
|
@ -1352,6 +1353,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
'anyOf',
|
||||
);
|
||||
|
||||
// Already resolved manually above, so we use convertJsonSchemaToZod directly
|
||||
const zodSchemaResolved = convertJsonSchemaToZod(resolvedSchema as any, {
|
||||
allowEmptyObject: true,
|
||||
transformOneOfAnyOf: true,
|
||||
|
|
@ -1388,6 +1390,7 @@ describe('convertJsonSchemaToZod', () => {
|
|||
expect(resolved).toBeDefined();
|
||||
|
||||
// The circular reference should be broken with a simple object schema
|
||||
// Already resolved manually above, so we use convertJsonSchemaToZod directly
|
||||
const zodSchema = convertJsonSchemaToZod(resolved as any, {
|
||||
allowEmptyObject: true,
|
||||
transformOneOfAnyOf: true,
|
||||
|
|
|
|||
|
|
@ -459,3 +459,15 @@ export function convertJsonSchemaToZod(
|
|||
|
||||
return zodSchema;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function for tests that automatically resolves refs before converting to Zod
|
||||
* This ensures all tests use resolveJsonSchemaRefs even when not explicitly testing it
|
||||
*/
|
||||
export function convertWithResolvedRefs(
|
||||
schema: JsonSchemaType & Record<string, unknown>,
|
||||
options?: ConvertJsonSchemaToZodOptions,
|
||||
) {
|
||||
const resolved = resolveJsonSchemaRefs(schema);
|
||||
return convertJsonSchemaToZod(resolved, options);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue