Skip to content

feature/change-welcome-to-from-styles - #637

Closed
klinch0 wants to merge 4 commits into
cozystack:mainfrom
klinch0:feature/change-welcome-to-from-styles
Closed

feature/change-welcome-to-from-styles#637
klinch0 wants to merge 4 commits into
cozystack:mainfrom
klinch0:feature/change-welcome-to-from-styles

Conversation

@klinch0

@klinch0 klinch0 commented Feb 19, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features
    • Enhanced dashboard welcome messages to automatically customize greetings based on locale settings.
    • Adjusted backend integration to dynamically enable additional authentication features when advanced security configurations are active.
    • Added a display name field for the ClusterKeycloakRealm to improve user-friendly representation based on locale.
    • Introduced conditional logic for dashboard dependencies based on OIDC configuration.

@dosubot dosubot Bot added the size/S This PR changes 10-29 lines, ignoring generated files label Feb 19, 2025
@coderabbitai

coderabbitai Bot commented Feb 19, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The changes update three configuration files related to the dashboard release. They introduce conditional logic in the customStyle section to set a localized welcome message based on the presence of a locale variable. One file also conditionally manages dependencies by adding keycloak-configure if the $oidcEnabled variable is true. No exported or public entities were altered.

Changes

File(s) Change Summary
packages/core/.../paas-full.yaml, packages/core/.../paas-hosted.yaml Enhanced the customStyle section by adding a conditional block. If a locale variable is defined, the .welcome element displays a locale-specific message; otherwise, it shows a generic message.
packages/core/.../paas-hosted.yaml Updated dependency management: conditionally adds keycloak-configure to the dashboard’s dependencies when $oidcEnabled is true.
packages/system/.../configure-kk.yaml Added a displayName field to ClusterKeycloakRealm, set to the value of the $locale variable, enhancing metadata representation.

Possibly related PRs

  • feature/add-wl #632: Modifications to the dashboard’s customStyle section with conditional logic for locale handling, similar to the changes introduced here.

Suggested labels

size:L

Suggested reviewers

  • kvaps
  • klinch0

Poem

I’m a little rabbit with a skip in my hop,
Crafting code changes that’ll never flop.
Conditional styles and dependencies align,
A welcome message that’s simply divine.
With carrots and code, we dance through the day—
Hoppily coding our troubles away!
🥕💻

📜 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 20a64ac and dea81f1.

📒 Files selected for processing (3)
  • packages/core/platform/bundles/paas-full.yaml (1 hunks)
  • packages/core/platform/bundles/paas-hosted.yaml (1 hunks)
  • packages/system/keycloak-configure/templates/configure-kk.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • packages/core/platform/bundles/paas-full.yaml
  • packages/core/platform/bundles/paas-hosted.yaml
  • 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.

@dosubot dosubot Bot added the kind/feature Categorizes issue or PR as related to a new feature label Feb 19, 2025
coderabbitai[bot]
coderabbitai Bot reviewed Feb 19, 2025
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/core/platform/bundles/paas-hosted.yaml (1)

184-192: Ensure Safe and Consistent Rendering of the Localized Welcome Message

The newly added conditional block in the customStyle section correctly displays a locale‐specific welcome message when $locale is present and falls back to a default when it isn’t. However, because the value of $locale is injected directly into the innerHTML, please verify that this variable is either sanitized or originates only from a trusted source to prevent potential XSS risks. Additionally, consider whether a helper (e.g., using a quoting/escaping function) could be used here so that similar functionality can be maintained consistently across multiple configuration files.

Example refactoring suggestion:

-            innerHTML: 'Welcome to, <span>{{ $locale }}</span>!';
+            innerHTML: 'Welcome to, <span>{{ quote $locale }}</span>!';

[security]

packages/core/platform/bundles/paas-full.yaml (1)

261-269: Validate and Maintain Consistency in the Custom Welcome Message

The conditional block added in the customStyle section (lines 261–269) mirrors the implementation in the hosted configuration, ensuring that a locale-specific welcome message is used when available. As with the hosted file, please ensure that the $locale value is properly sanitized or escaped (e.g., by using a quoting function) to avoid potential XSS issues when the string is injected into innerHTML. If this pattern is used in multiple places, consider abstracting it into a reusable helper template.

Example diff suggestion:

-            innerHTML: 'Welcome to, <span>{{ $locale }}</span>!';
+            innerHTML: 'Welcome to, <span>{{ quote $locale }}</span>!';

[security]

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc95159 and ff77eb4.

📒 Files selected for processing (2)
  • packages/core/platform/bundles/paas-full.yaml (1 hunks)
  • packages/core/platform/bundles/paas-hosted.yaml (1 hunks)

@klinch0
klinch0 force-pushed the feature/change-welcome-to-from-styles branch from 66509df to dea81f1 Compare February 19, 2025 12:17
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Feb 19, 2025
@themoriarti

Marian Koreniuk (themoriarti) commented Feb 20, 2025

Copy link
Copy Markdown
Collaborator

LGTM

@klinch0 klinch0 closed this Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@kvaps Andrei Kvapil (kvaps) Awaiting requested review from kvaps kvaps is a code owner
+2 more reviewers
@xy2 xy2 xy2 approved these changes
@themoriarti Marian Koreniuk (themoriarti) themoriarti approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

kind/feature Categorizes issue or PR as related to a new feature lgtm This PR has been approved by a maintainer size/S This PR changes 10-29 lines, ignoring generated files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@klinch0 @themoriarti @xy2