Skip to content

feat: implement merging unions function with test cases #814

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

Merged
merged 2 commits into from
Jul 2, 2024
Merged

feat: implement merging unions function with test cases #814

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
391ccbc
feat: implement merging unions function with test cases
ad-world Jun 28, 2024
172a0dc
feat: separate sorting and stringify functions
ad-world Jun 28, 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
47 changes: 45 additions & 2 deletions packages/openapi-generator/src/optimize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,47 @@ export function foldIntersection(schema: Schema, optimize: OptimizeFn): Schema {
return result;
}

function mergeUnions(schema: Schema): Schema {
if (schema.type !== 'union') return schema;
else if (schema.schemas.length === 1) return schema.schemas[0]!;
else if (schema.schemas.length === 0) return { type: 'undefined' };

// Stringified schemas (i.e. hashes of the schemas) to avoid duplicates
const resultingSchemas: Set<string> = new Set();

// Function to make the result of JSON.stringify deterministic (i.e. keys are all sorted alphabetically)
const sortObj = (obj: object): object =>
obj === null || typeof obj !== 'object'
? obj
: Array.isArray(obj)
? obj.map(sortObj)
: Object.assign(
{},
...Object.entries(obj)
.sort(([keyA], [keyB]) => keyA.localeCompare(keyB))
.map(([k, v]) => ({ [k]: sortObj(v) })),
);

// Deterministic version of JSON.stringify
const deterministicStringify = (obj: object) => JSON.stringify(sortObj(obj));

schema.schemas.forEach((innerSchema) => {
if (innerSchema.type === 'union') {
const merged = mergeUnions(innerSchema);
resultingSchemas.add(deterministicStringify(merged));
} else {
resultingSchemas.add(deterministicStringify(innerSchema));
}
});

if (resultingSchemas.size === 1) return JSON.parse(Array.from(resultingSchemas)[0]!);

return {
type: 'union',
schemas: Array.from(resultingSchemas).map((s) => JSON.parse(s)),
};
}

export function simplifyUnion(schema: Schema, optimize: OptimizeFn): Schema {
if (schema.type !== 'union') {
return schema;
Expand Down Expand Up @@ -134,11 +175,13 @@ export function optimize(schema: Schema): Schema {
return newSchema;
} else if (schema.type === 'union') {
const simplified = simplifyUnion(schema, optimize);
const merged = mergeUnions(simplified);

if (schema.comment) {
return { ...simplified, comment: schema.comment };
return { ...merged, comment: schema.comment };
}

return simplified;
return merged;
} else if (schema.type === 'array') {
const optimized = optimize(schema.items);
if (schema.comment) {
Expand Down
157 changes: 157 additions & 0 deletions packages/openapi-generator/test/openapi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3298,3 +3298,160 @@ testCase('route with many response codes uses default status code descriptions',
}
}
});

const SCHEMA_WITH_REDUNDANT_UNIONS = `
import * as t from 'io-ts';
import * as h from '@api-ts/io-ts-http';

export const route = h.httpRoute({
path: '/foo',
method: 'GET',
request: h.httpRequest({
query: {
foo: t.union([t.string, t.string]),
bar: t.union([t.number, t.number, t.number]),
bucket: t.union([t.string, t.number, t.boolean, t.string, t.number, t.boolean]),
},
body: {
typeUnion: t.union([
t.type({ foo: t.string, bar: t.number }),
t.type({ bar: t.number, foo: t.string}),
]),
nestedTypeUnion: t.union([
t.type({ nested: t.type({ foo: t.string, bar: t.number }) }),
t.type({ nested: t.type({ foo: t.string, bar: t.number }) })
])
}
}),
response: {
200: t.union([t.string, t.string, t.union([t.number, t.number])]),
400: t.union([t.boolean, t.boolean, t.boolean])
},
})
`

Check notice

Code scanning / CodeQL

Semicolon insertion

Avoid automated semicolon insertion (95% of all statements in [the enclosing script](1) have an explicit semicolon).

testCase('route with reduntant response schemas', SCHEMA_WITH_REDUNDANT_UNIONS, {
openapi: '3.0.3',
info: {
title: 'Test',
version: '1.0.0'
},
paths: {
'/foo': {
get: {
parameters: [
{
in: 'query',
name: 'foo',
required: true,
schema: {
type: 'string'
}
},
{
in: 'query',
name: 'bar',
required: true,
schema: {
type: 'number'
}
},
{
in: 'query',
name: 'bucket',
required: true,
schema: {
oneOf: [
{ type: 'string' },
{ type: 'number' },
{ type: 'boolean' }
]
}
}
],
requestBody: {
content: {
'application/json': {
schema: {
properties: {
nestedTypeUnion: {
properties: {
nested: {
properties: {
bar: {
type: 'number'
},
foo: {
type: 'string'
}
},
required: [
'bar',
'foo'
],
type: 'object'
}
},
required: [
'nested'
],
type: 'object'
},
typeUnion: {
properties: {
bar: {
type: 'number'
},
foo: {
type: 'string'
}
},
required: [
'bar',
'foo'
],
type: 'object'
}
},
required: [
'typeUnion',
'nestedTypeUnion'
],
type: 'object'
}
}
}
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
oneOf: [{
type: 'string'
}, {
type: 'number'
}]
}
}
}
},
'400': {
description: 'Bad Request',
content: {
'application/json': {
schema: {
type: 'boolean'
}
}
}
}
}
}
}
},
components: {
schemas: {}
}
});