Fix: Update GetScheme method in SwaggerServiceDiscoveryProvider

[rabdulatif]

This PR updates the GetScheme method in the SwaggerServiceDiscoveryProvider

Summary by CodeRabbit

• New Features
  • Enhanced URI scheme determination for improved service configuration handling.
• Bug Fixes
  • Updated logic to ensure the correct scheme is used when the service scheme is unspecified.

[update-docs]

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

[coderabbitai]

Walkthrough

The changes in this pull request focus on the SwaggerServiceDiscoveryProvider class within the SwaggerServiceDiscoveryProvider.cs file. Key modifications include the addition of a using directive for Ocelot.Configuration and updates to the GetScheme method's signature to accept a new parameter, ServiceProviderConfiguration. The GetSwaggerUri method has been adjusted to incorporate this new parameter, enhancing the logic for determining the URI scheme based on configuration. The overall control flow remains unchanged.

Changes

File Path	Change Summary
src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs	- Added using directive for Ocelot.Configuration. - Updated GetScheme method to accept ServiceProviderConfiguration conf. - Modified GetSwaggerUri to pass the new conf parameter to GetScheme. - Adjusted URI construction logic to default to configuration's scheme if service scheme is empty.

Possibly related issues

• Missing Scheme in URI for Swagger when using PollConsul Service Discovery with Ocelot #307: The changes address the issue of missing scheme in the URI for Swagger when using PollConsul, ensuring that the scheme is set correctly in the GetSwaggerUri method.

Possibly related PRs

• Fix missing URI scheme in Swagger when using PollConsul service discovery #308: This PR modifies the GetSwaggerUri method in the SwaggerServiceDiscoveryProvider class, directly related to the changes made in the main PR regarding the handling of the URI scheme.

Suggested reviewers

• Burgyn

Poem

🐰 In the land of code where bunnies play,
A scheme was missing, oh what a fray!
With a hop and a tweak, the URI's bright,
Now Swagger's shining, all is right!
Let's cheer for the changes, a joyous delight! 🎉

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs (2)

Line range hint 127-137: Refactor GetScheme method for improved readability

The current implementation of the GetScheme method uses nested ternary operators and a switch expression, which can make the code hard to read and maintain. Refactoring it into a more readable format will enhance maintainability.

You can refactor the method as follows:

-private string GetScheme(ServiceHostAndPort service, RouteOptions route, ServiceProviderConfiguration conf)
-    => (route is not null && !route.DownstreamScheme.IsNullOrEmpty())
-        ? route.DownstreamScheme
-        : !service.Scheme.IsNullOrEmpty()
-            ? service.Scheme
-            : service.DownstreamPort
-                switch
-                {
-                    443 => Uri.UriSchemeHttps,
-                    80 => Uri.UriSchemeHttp,
-                    _ => conf?.Scheme ?? "http"
-                };
+private string GetScheme(ServiceHostAndPort service, RouteOptions route, ServiceProviderConfiguration conf)
+{
+    if (route is not null && !route.DownstreamScheme.IsNullOrEmpty())
+    {
+        return route.DownstreamScheme;
+    }
+    else if (!service.Scheme.IsNullOrEmpty())
+    {
+        return service.Scheme;
+    }
+    else
+    {
+        return service.DownstreamPort switch
+        {
+            443 => Uri.UriSchemeHttps,
+            80 => Uri.UriSchemeHttp,
+            _ => conf?.Scheme ?? "http",
+        };
+    }
+}

---

137-137: Consider defaulting to HTTPS for enhanced security

In cases where the scheme is not specified in the route, service, or configuration, the default scheme is set to "http". For improved security, consider defaulting to "https" to ensure secure communication by default.

Apply this change to update the default scheme:

-    _ => conf?.Scheme ?? "http"
+    _ => conf?.Scheme ?? "https"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8a25f0c and b8f2713.

📒 Files selected for processing (1)

• src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs (5 hunks)

[rabdulatif]

#309