add-extra-redirect-uri #579

klinch0 · 2025-01-16T07:51:21Z

Summary by CodeRabbit

New Features
- Enhanced Keycloak configuration with support for additional redirect URIs
- Added flexibility to specify extra redirect URI through configuration

coderabbitai · 2025-01-16T07:51:28Z

Walkthrough

The pull request introduces a new variable $extraRedirectUris in the Keycloak configuration template. This variable retrieves and splits a comma-separated list from the cozyConfig ConfigMap under the key extra-keycloak-redirect-uri-for-dashboard. It conditionally appends additional redirect URIs to the redirectUris list of the kubeapps-client KeycloakClient specification, enhancing configurability while maintaining the existing structure and logic.

Changes

File	Change Summary
`packages/system/keycloak-configure/templates/configure-kk.yaml`	Added `$extraRedirectUris` variable to conditionally include multiple extra redirect URIs from `cozyConfig` ConfigMap

Poem

🐰 A Rabbit's Ode to Flexible Config 🔧

In YAML's realm, a new path unfurls,
An extra URI, my config now twirls.
Flexibility dances with gentle might,
Redirect with ease, make configurations bright!

Hop, hop, hooray! 🎉

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4618e5 and 77378de.

📒 Files selected for processing (1)

packages/system/keycloak-configure/templates/configure-kk.yaml (2 hunks)

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

packages/system/keycloak-configure/templates/configure-kk.yaml

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.

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f1c2a4 and e4618e5.

📒 Files selected for processing (1)

packages/system/keycloak-configure/templates/configure-kk.yaml (2 hunks)

🔇 Additional comments (1)

packages/system/keycloak-configure/templates/configure-kk.yaml (1)

194-196: Consider validating the URI format.

While the implementation correctly adds the extra redirect URI, there's no validation of the URI format. This could lead to invalid configurations if the ConfigMap contains malformed URIs.

Consider:

Adding validation in the template:
 {{- if $extraRedirectUri }}
+  {{- if and (regexMatch "^https?://" $extraRedirectUri) }}
     - "{{ $extraRedirectUri }}"
+  {{- end }}
 {{- end }}
Document the expected URI format in the ConfigMap:
apiVersion: v1
kind: ConfigMap
metadata:
  name: cozystack
  namespace: cozy-system
data:
  # Format: http(s)://<host>[:<port>]/path
  extra-keycloak-redirect-uri-for-dashboard: "https://example.com/callback"
Let's verify the current usage:

coderabbitai · 2025-01-16T07:53:42Z

packages/system/keycloak-configure/templates/configure-kk.yaml

@@ -1,5 +1,6 @@
 {{- $cozyConfig := lookup "v1" "ConfigMap" "cozy-system" "cozystack" }}
 {{- $host := index $cozyConfig.data "root-host" }}
+{{- $extraRedirectUri := index $cozyConfig.data "extra-keycloak-redirect-uri-for-dashboard" }}


🛠️ Refactor suggestion

Add error handling for ConfigMap key lookup.

The direct index lookup of extra-keycloak-redirect-uri-for-dashboard could fail if the key doesn't exist in the ConfigMap. Consider using a safer approach.

-{{- $extraRedirectUri := index $cozyConfig.data "extra-keycloak-redirect-uri-for-dashboard" }} +{{- $extraRedirectUri := default "" (dig "data" "extra-keycloak-redirect-uri-for-dashboard" nil $cozyConfig) }}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

{{- $extraRedirectUri := index $cozyConfig.data "extra-keycloak-redirect-uri-for-dashboard" }}

{{- $extraRedirectUri := default "" (dig "data" "extra-keycloak-redirect-uri-for-dashboard" nil $cozyConfig) }}

kvaps

LGTM

klinch0 requested a review from kvaps as a code owner January 16, 2025 07:51

dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jan 16, 2025

coderabbitai bot reviewed Jan 16, 2025

View reviewed changes

dosubot bot added the enhancement New feature or request label Jan 16, 2025

add extra uris

77378de

klinch0 force-pushed the feature/add-extra-redirect-uri branch from e4618e5 to 77378de Compare January 16, 2025 09:26

kvaps approved these changes Jan 16, 2025

View reviewed changes

kvaps merged commit 8193d78 into cozystack:main Jan 16, 2025
1 check passed

dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 16, 2025

coderabbitai bot mentioned this pull request Jan 16, 2025

fix #580

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

add-extra-redirect-uri #579

add-extra-redirect-uri #579

Uh oh!

klinch0 commented Jan 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 16, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Jan 16, 2025

Uh oh!

kvaps left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	{{- $extraRedirectUri := index $cozyConfig.data "extra-keycloak-redirect-uri-for-dashboard" }}
	{{- $extraRedirectUri := default "" (dig "data" "extra-keycloak-redirect-uri-for-dashboard" nil $cozyConfig) }}

Uh oh!

add-extra-redirect-uri #579

add-extra-redirect-uri #579

Uh oh!

Conversation

klinch0 commented Jan 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

kvaps left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

klinch0 commented Jan 16, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)