feat(setting): add upgrade-responder-url setting #3591

derekbit · 2025-02-19T04:32:10Z

Which issue(s) this PR fixes:

What this PR does / why we need it:

Special notes for your reviewer:

Additional documentation or context

coderabbitai · 2025-02-19T04:32:17Z

Walkthrough

This pull request modifies how the upgrade responder URL is managed. In the controller, the previously hardcoded URL is removed and replaced by dynamically fetching the URL from the datastore within the CheckLatestAndStableLonghornVersions method. Additionally, a new setting is introduced in the types definition to support this dynamic configuration. The update ensures that the URL for the upgrade service can be configured externally without altering the code, while maintaining consistent error handling during the retrieval and usage process.

Changes

Files	Change Summary
`controller/setting_controller.go`	Removed the hardcoded `checkUpgradeURL` constant. Updated `CheckLatestAndStableLonghornVersions` to retrieve the upgrade responder URL dynamically from datastore.
`types/setting.go`	Added new constant `SettingNameUpgradeResponderURL` and corresponding setting definition `SettingDefinitionUpgradeResponderURL` with a default URL value.

Sequence Diagram(s)

sequenceDiagram
    participant SC as SettingController
    participant DS as DataStore
    participant US as Upgrade Service

    SC->>DS: Retrieve upgradeResponderURL setting
    DS-->>SC: Return dynamic URL
    SC->>US: Send HTTP POST request to URL
    US-->>SC: Return version information

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

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.

Longhorn 10437 Signed-off-by: Derek Su <derek.su@suse.com>

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

controller/setting_controller.go (1)
1159-1166: LGTM with a security suggestion.

The change to make the upgrade responder URL configurable improves flexibility. However, consider adding URL validation to ensure only trusted URLs are used.

Add URL validation before using it in the HTTP POST request:
 upgradeResponderURL, err := sc.ds.GetSettingValueExisted(types.SettingNameUpgradeResponderURL)
 if err != nil {
     return "", "", err
 }
+
+// Validate the URL
+if _, err := url.ParseRequestURI(upgradeResponderURL); err != nil {
+    return "", "", fmt.Errorf("invalid upgrade responder URL: %v", err)
+}

 r, err := http.Post(upgradeResponderURL, "application/json", &content)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a07ce94 and 33382f7.

📒 Files selected for processing (2)

controller/setting_controller.go (1 hunks)
types/setting.go (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

types/setting.go

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: Build binaries
GitHub Check: Summary

derekbit · 2025-02-19T04:51:46Z

@mergify backport v1.8.x

mergify · 2025-02-19T04:51:53Z

backport v1.8.x

✅ Backports have been created

#3592 feat(setting): add upgrade-responder-url setting (backport #3591) has been created for branch v1.8.x

innobead · 2025-02-19T08:35:10Z

types/setting.go

@@ -585,6 +588,16 @@ var (
 		Default:     "true",
 	}

+	SettingDefinitionUpgradeResponderURL = SettingDefinition{
+		DisplayName: "Upgrade Responder URL",
+		Description: "The upgrade responder notifies users the available versions of Longhorn for upgrade",


cc @longhorn/doc

Just to clarify, the notification actually mentions the available versions? Or is it a generic notification that a new version (relevant to what is installed) is available?

jillian-maroket

I have a question about the Upgrade Responder URL description.

jillian-maroket · 2025-02-19T09:02:05Z

types/setting.go

@@ -585,6 +588,16 @@ var (
 		Default:     "true",
 	}

+	SettingDefinitionUpgradeResponderURL = SettingDefinition{
+		DisplayName: "Upgrade Responder URL",
+		Description: "The upgrade responder notifies users the available versions of Longhorn for upgrade",


Just to clarify, the notification actually mentions the available versions? Or is it a generic notification that a new version (relevant to what is installed) is available?

derekbit requested review from innobead and c3y1huang February 19, 2025 04:32

derekbit self-assigned this Feb 19, 2025

feat(setting): add upgrade-responder-url setting

33382f7

Longhorn 10437 Signed-off-by: Derek Su <derek.su@suse.com>

derekbit force-pushed the issue-10437 branch from a07ce94 to 33382f7 Compare February 19, 2025 04:34

coderabbitai bot reviewed Feb 19, 2025

View reviewed changes

c3y1huang approved these changes Feb 19, 2025

View reviewed changes

derekbit merged commit 9924f9d into longhorn:master Feb 19, 2025
9 checks passed

mergify bot mentioned this pull request Feb 19, 2025

feat(setting): add upgrade-responder-url setting (backport #3591) #3592

Merged

derekbit mentioned this pull request Feb 19, 2025

[IMPROVEMENT] Support configurable upgrade-responder URL longhorn/longhorn#10437

Open

innobead reviewed Feb 19, 2025

View reviewed changes

jillian-maroket reviewed Feb 19, 2025

View reviewed changes

coderabbitai bot mentioned this pull request Feb 19, 2025

docs: update description for upgradeResponderURL #3594

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(setting): add upgrade-responder-url setting #3591

feat(setting): add upgrade-responder-url setting #3591

derekbit commented Feb 19, 2025

coderabbitai bot commented Feb 19, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

derekbit commented Feb 19, 2025

mergify bot commented Feb 19, 2025 •

edited

Loading

innobead Feb 19, 2025

jillian-maroket Feb 19, 2025

jillian-maroket left a comment

jillian-maroket Feb 19, 2025

feat(setting): add upgrade-responder-url setting #3591

feat(setting): add upgrade-responder-url setting #3591

Conversation

derekbit commented Feb 19, 2025

Which issue(s) this PR fixes:

What this PR does / why we need it:

Special notes for your reviewer:

Additional documentation or context

coderabbitai bot commented Feb 19, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

derekbit commented Feb 19, 2025

mergify bot commented Feb 19, 2025 • edited Loading

✅ Backports have been created

innobead Feb 19, 2025

Choose a reason for hiding this comment

jillian-maroket Feb 19, 2025

Choose a reason for hiding this comment

jillian-maroket left a comment

Choose a reason for hiding this comment

jillian-maroket Feb 19, 2025

Choose a reason for hiding this comment

coderabbitai bot commented Feb 19, 2025 •

edited

Loading

mergify bot commented Feb 19, 2025 •

edited

Loading