Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(type-safe-api): faster code generation for python runtime #859

Merged
merged 2 commits into from
Oct 17, 2024
Merged

feat(type-safe-api): faster code generation for python runtime #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3478476
feat(type-safe-api): faster code generation for python runtime
cogwirrel Oct 17, 2024
3b9a057
Merge branch 'mainline' into feat/py-runtime-gen4
cogwirrel Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/type-safe-api/scripts/type-safe-api/custom/mock-data/generate-mock-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const resolveSchemaRef = (spec: OpenAPIV3.Document, ref: string): OpenAPIV3.Sche
return resolved;
};

const generateMockResponse = (
export const generateMockDataForSchema = (
spec: OpenAPIV3.Document,
args: GenerateProps,
schemaOrRef: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject,
Expand Down Expand Up @@ -75,11 +75,11 @@ const generateMockResponse = (
// Not isn't likely to occur in a Smithy-based project, but it could come up in OpenAPI
// To keep this simple we return either an object or a string - since by definition we just need to
// return a type that isn't the specified one.
const notResponse = generateMockResponse(spec, nextArgs, schema.not);
const notResponse = generateMockDataForSchema(spec, nextArgs, schema.not);
if (typeof notResponse === "object") {
return generateMockResponse(spec, nextArgs, { type: "string" });
return generateMockDataForSchema(spec, nextArgs, { type: "string" });
}
return generateMockResponse(spec, nextArgs, { type: "object" });
return generateMockDataForSchema(spec, nextArgs, { type: "object" });
}

if (schema.type === "integer") {
Expand Down Expand Up @@ -125,7 +125,7 @@ const generateMockResponse = (
}

return [...new Array(faker.number.int({ min: minItems, max: maxItems })).keys()].map(() =>
generateMockResponse(spec, nextArgs, (schema as OpenAPIV3.ArraySchemaObject).items));
generateMockDataForSchema(spec, nextArgs, (schema as OpenAPIV3.ArraySchemaObject).items));
}

// Type is an object, or allOf/oneOf/anyOf
Expand All @@ -137,7 +137,7 @@ const generateMockResponse = (

if (schema.allOf) {
// For allOf, combine the mocks together
return schema.allOf.map(s => generateMockResponse(spec, nextArgs, s) as object).reduce((allMocks, mock) => ({
return schema.allOf.map(s => generateMockDataForSchema(spec, nextArgs, s) as object).reduce((allMocks, mock) => ({
...allMocks,
...mock,
}), {});
Expand All @@ -149,22 +149,22 @@ const generateMockResponse = (
throw new Error(`oneOf / anyOf must define at least one subschema`);
}
// For oneOf / anyOf pick the first
return generateMockResponse(spec, nextArgs, (schema.oneOf || schema.anyOf)![0]);
return generateMockDataForSchema(spec, nextArgs, (schema.oneOf || schema.anyOf)![0]);
}

if (schema.type === "object") {
// Additional properties that aren't circular refs
if (!schema.properties && typeof schema.additionalProperties === "object" && !isRef(schema.additionalProperties)) {
return Object.fromEntries([...new Array(faker.number.int({ min: 0, max: args.maxArrayLength ?? 0 })).keys()]
.map(i => [`${faker.lorem.slug(1)}-${i}`, generateMockResponse(spec, nextArgs, schema.additionalProperties as OpenAPIV3.SchemaObject)]));
.map(i => [`${faker.lorem.slug(1)}-${i}`, generateMockDataForSchema(spec, nextArgs, schema.additionalProperties as OpenAPIV3.SchemaObject)]));
}

const requiredProperties = new Set(schema.required ?? []);
return Object.fromEntries(Object.entries(schema.properties ?? {}).filter(([k, v]) => {
// Filter out circular references we've seen if they are not required
// If they are required, we'll recursively include them until the max depth is hit
return requiredProperties.has(k) || !isRef(v);
}).map(([k, v]) => [k, generateMockResponse(
}).map(([k, v]) => [k, generateMockDataForSchema(
spec,
nextArgs,
v,
Expand Down Expand Up @@ -286,7 +286,7 @@ export default async (argv: string[]) => {
const schema = response?.content?.['application/json']?.schema;
if (schema) {
const mockResponseFilePath = path.join(outPath, `${method.toLowerCase()}${p.replace(/\//g, "-")}-${responseCode}.json`);
const mockResponse = generateMockResponse(spec, {
const mockResponse = generateMockDataForSchema(spec, {
faker,
maxArrayLength: args.maxArrayLength,
maxCircularReferenceDepth: 2,
Expand Down
Loading
Loading