search

Burgyn / MMLib.SwaggerForOcelot

This repo contains swagger extension for ocelot.
MIT License
354 stars 95 forks source link

Possible fix for error when swagger fails to load when there are multiple catch all routes #304

Closed Asaboha closed 3 months ago

Asaboha commented 3 months ago

if there are multiple catchAll routes with different paths (might be redundant)

for example downstream has single route 

GET: /api/test

but in ocelot has 2 matching upstream paths 

GET: /get/ocelot/config/{everything}
GET: /get/ocelot/config/**test**/{everything}

currently our application gets an error message thrown " Can not add property get to Newtonsoft.Json.Linq.JObject. Property with the same name already exists on object."

in SwaggerJsonTransformer.cs function "SwaggerJsonTransformer.cs" replaced route.UpstreamPath with "ConvertDownstreamPathToUpstreamPath" that's acatually used to generater Swagger doc Json properties names

Summary by CodeRabbit

update-docs[bot] commented 3 months ago

Thanks for opening this pull request! If you have implemented new functions, write about them in the readme file.

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@Asaboha has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 52 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 344f83a314cffdf20f4f75c9e45d74f4934414cf and 92310619b7aa4b4b384115d92c84dbec033505fe.

Walkthrough

The recent changes enhance the SwaggerJsonTransformer class by refining the RemoveRedundantRoutes method to include additional parameters for better route processing. New test resources and scenarios have been added to validate these modifications, particularly focusing on catch-all routes in Ocelot configurations. Overall, these updates improve the handling of API documentation generation, ensuring more accurate and robust route management.

Changes

Files Change Summary
src/MMLib.SwaggerForOcelot/Transformation/SwaggerJsonTransformer.cs Modified RemoveRedundantRoutes method signature to add downstreamPath and basePath, enhancing route evaluation.
tests/MMLib.SwaggerForOcelot.Tests/MMLib.SwaggerForOcelot.Tests.csproj Added two new embedded JSON resources for testing Ocelot routing scenarios.
tests/MMLib.SwaggerForOcelot.Tests/Resources/DifferentOcelotRoutesForOneDownstreamTransformedWithCatchAll.json, tests/MMLib.SwaggerForOcelot.Tests/Resources/DifferentOcelotRoutesForOneDownstreamWithCatchAll.json Defined new OpenAPI specifications for endpoints, enhancing API documentation clarity.
tests/MMLib.SwaggerForOcelot.Tests/SwaggerForOcelotMiddlewareShould.cs Introduced a new test method to validate transformation of routes with catch-all parameters, improving test coverage.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Middleware
    participant SwaggerJsonTransformer

    Client->>Middleware: Request API Documentation
    Middleware->>SwaggerJsonTransformer: Invoke Transform method
    SwaggerJsonTransformer->>SwaggerJsonTransformer: RemoveRedundantRoutes(routes, downstreamPath, basePath)
    SwaggerJsonTransformer-->>Middleware: Return transformed Swagger output
    Middleware-->>Client: Respond with API Documentation

Poem

šŸ‡ In fields of code, where changes bloom,
A rabbit hops, dispelling gloom.
With paths transformed and tests in line,
API docs now brightly shine!
Let's leap and cheer, for clarity's grace,
Together we thrive, in this coding space! šŸŒ¼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Burgyn commented 3 months ago

Hi @Asaboha,

why did you close this PR?

Asaboha commented 3 months ago

Not sure if this is a valid use case, I should I have raised an issue first that json exceptin is thrown if there are multiple catchAll routes