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.

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

Do not use condition endpoint when running locally #383

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

Ceredron
Copy link
Collaborator

@Ceredron Ceredron commented Oct 23, 2024

Description

Altinn Notifications condition endpoint does not and cannot work with localhost

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)
  • All tests run green

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • New Features

    • Enhanced flexibility in handling environment-specific conditions with nullable Uri return type for the condition endpoint.
  • Bug Fixes

    • Improved handling of localhost scenarios by returning null for condition endpoints when applicable.

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve modifications to the InitializeCorrespondencesHandler class within the Altinn.Correspondence.Application.InitializeCorrespondences namespace. The CreateConditonEndpoint method's return type has been updated from Uri to Uri?, enabling it to return a nullable Uri. A conditional check has been added to return null if the conditionEndpoint's host is "localhost". The method construction and checks have been refined, while the CreateMessageFromToken method and other functionalities remain unchanged.

Changes

File Path Change Summary
src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs Method signature updated: private Uri CreateConditonEndpoint(string correspondenceId) to private Uri? CreateConditionEndpoint(string correspondenceId). Conditional check added for "localhost".

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0f29a8a and d64e364.

📒 Files selected for processing (1)
  • src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs

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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs (1)

369-372: Consider making the localhost check configurable.

While the current implementation works well, consider making the localhost check more flexible by moving it to configuration. This would allow easier testing and configuration for different environments.

Example approach:

  1. Add a configuration setting in GeneralSettings:
public class GeneralSettings
{
    public string[] DisableConditionEndpointHosts { get; set; } = new[] { "localhost" };
}
  1. Update the check to use configuration:
-        if (conditionEndpoint.Host == "localhost")
+        if (_generalSettings.DisableConditionEndpointHosts.Contains(conditionEndpoint.Host))
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2937050 and 0f29a8a.

📒 Files selected for processing (1)
  • src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
src/Altinn.Correspondence.Application/InitializeCorrespondences/InitializeCorrespondencesHandler.cs (1)

366-374: LGTM! Clean implementation of localhost check.

The implementation correctly prevents the use of condition endpoint in local environment by returning null when the host is localhost. This aligns well with the PR objective.

@Ceredron Ceredron merged commit 3ca143a into main Oct 23, 2024
6 checks passed
@Ceredron Ceredron deleted the fix/notification-localhost-conditionendpoint branch October 23, 2024 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants