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

fix: don't crash when trying to add an already registrer type #2695

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −5
Open

fix: don't crash when trying to add an already registrer type #2695

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 10 additions & 5 deletions src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SchemaRepository.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,17 @@ public void RegisterType(Type type, string schemaId)
{
var conflictingType = _reservedIds.First(entry => entry.Value == schemaId).Key;

throw new InvalidOperationException(
$"Can't use schemaId \"${schemaId}\" for type \"${type}\". " +
$"The same schemaId is already used for type \"${conflictingType}\"");
if(conflictingType != type)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if(conflictingType != type)
if (conflictingType != type)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@martincostello ok, what's the best course of action ? Do i create a new WebSites with only the problematic endpoint (that should not crash anymore) ? Do i add a new endpoint / controller (in that case in which WebSites, Projects ? )

Thanks for your help.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lowest-effort approach (hopefully) should be to add to one of the existing SwaggerGen tests that declares an endpoint in code and then checks the behaviour of what was generated. If you add a test that throws an exception without your change, then passes after it's made with the correct eventual behaviour should make us happy from a regression testing point of view 😄

I would consider adding a new project a "last resort" as they're relatively heavyweight and are typically used for end-to-end scenarios, rather than testing specific scenarios.

{
throw new InvalidOperationException(
$"Can't use schemaId \"${schemaId}\" for type \"${type}\". " +
$"The same schemaId is already used for type \"${conflictingType}\"");
}
}
else
{
_reservedIds.Add(type, schemaId);
}

_reservedIds.Add(type, schemaId);
}

public bool TryLookupByType(Type type, out OpenApiSchema referenceSchema)
Expand Down