Skip to content

feat(schema): add duplicate DTO detection in schema exploration #3400

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 8 commits into from
Apr 17, 2025
Merged

feat(schema): add duplicate DTO detection in schema exploration #3400

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a4065cf
feat(schema): add duplicate DTO detection in schema exploration
Newbie012 Apr 14, 2025
2b0f1f9
refactor(schema): improve duplicate DTO detection logic to allow same…
Newbie012 Apr 14, 2025
86d3951
revert
Newbie012 Apr 14, 2025
8760948
revert
Newbie012 Apr 14, 2025
4e74c18
fix(schema): change duplicate DTO detection to log an error instead o…
Newbie012 Apr 14, 2025
8c7e888
Update lib/services/schema-object-factory.ts
Newbie012 Apr 14, 2025
fe83820
feat(schema): add Logger import to schema-object-factory for improved…
Newbie012 Apr 14, 2025
bbd9a14
refactor(schema): update error logging to use Logger instead of conso…
Newbie012 Apr 14, 2025
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
5 changes: 3 additions & 2 deletions lib/services/schema-object-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,10 @@ export class SchemaObjectFactory {
}

if (schemas[schemaName] && !isEqual(schemas[schemaName], typeDefinition)) {
throw new Error(
console.error(
`Duplicate DTO detected: "${schemaName}" is defined multiple times with different schemas.\n` +
`Consider using unique class names or applying @ApiExtraModels() decorator with custom schema names.`
`Consider using unique class names or applying @ApiExtraModels() decorator with custom schema names.\n` +
`Note: This will throw an error in the next major version.`
);
}

Expand Down
39 changes: 23 additions & 16 deletions test/services/schema-object-factory.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,8 @@ describe('SchemaObjectFactory', () => {
});
});

it('should throw an error when detecting duplicate DTOs with different schemas', () => {
it('should log an error when detecting duplicate DTOs with different schemas', () => {
const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
const schemas: Record<string, SchemasObject> = {};

class DuplicateDTO {
Expand All @@ -195,18 +196,22 @@ describe('SchemaObjectFactory', () => {
value: 'DuplicateDTO'
});

expect(() =>
schemaObjectFactory.exploreModelSchema(
DuplicateDTOWithDifferentSchema,
schemas
)
).toThrow(
'Duplicate DTO detected: "DuplicateDTO" is defined multiple times with different schemas.\n' +
'Consider using unique class names or applying @ApiExtraModels() decorator with custom schema names.'
schemaObjectFactory.exploreModelSchema(
DuplicateDTOWithDifferentSchema,
schemas
);

expect(consoleErrorSpy).toHaveBeenCalledWith(
`Duplicate DTO detected: "DuplicateDTO" is defined multiple times with different schemas.\n` +
`Consider using unique class names or applying @ApiExtraModels() decorator with custom schema names.\n` +
`Note: This will throw an error in the next major version.`
);

consoleErrorSpy.mockRestore();
});

it('should not throw an error when detecting duplicate DTOs with the same schemas', () => {
it('should not throw an error or log error when detecting duplicate DTOs with the same schemas', () => {
const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
const schemas: Record<string, SchemasObject> = {};

class DuplicateDTO {
Expand All @@ -225,12 +230,14 @@ describe('SchemaObjectFactory', () => {
value: 'DuplicateDTO'
});

expect(() =>
schemaObjectFactory.exploreModelSchema(
DuplicateDTOWithSameSchema,
schemas
)
).not.toThrow();
schemaObjectFactory.exploreModelSchema(
DuplicateDTOWithSameSchema,
schemas
);

expect(consoleErrorSpy).not.toHaveBeenCalled();

consoleErrorSpy.mockRestore();
});

it('should create openapi schema', () => {
Expand Down