Dashboard : permit to redirect to a custom screen (#8021)

[ClementBouvierN]

• In release notes :
  • In chapter : Features
  • Text : Dashboard : permit to redirect to a custom screen #8021 Dashboard : permit to redirect to a custom screen

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes update the UI configuration and navigation logic for the application. A new entry is added to the processStateRedirects array in the JSON configuration file, specifying a processId of "defaultProcess", stateId of "questionState", and screenId of "testId". The documentation has been revised to include new properties for loading custom CSS and JavaScript files, as well as to describe the new dashboard redirection configuration. Additionally, the navigation logic in the dashboard component has been enhanced; it now checks for the presence of a screenId and, if found, navigates to a custom screen, otherwise, it falls back to navigating via the menuId.

Possibly related PRs

• Dashboard : Add a link to business menu for certain process/states (#7547) #7573: This PR involves similar modifications to the processStateRedirects array, focusing on navigation logic based on process states.

Suggested reviewers

• freddidierRTE
• vlo-rte

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ccf9169 and b77691a.

📒 Files selected for processing (3)

• config/docker/ui-config/web-ui.json (1 hunks)
• src/docs/asciidoc/deployment/configuration/web-ui_configuration.adoc (1 hunks)
• ui/main/src/app/components/dashboard/dashboard.component.ts (1 hunks)

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

• GitHub Check: build
• GitHub Check: build

🔇 Additional comments (3)

config/docker/ui-config/web-ui.json (1)

167-171: LGTM! Clean implementation of dashboard state redirection.

The new entry correctly adds support for redirecting to a custom screen when clicking on the "questionState" state in the dashboard. The structure follows the documented pattern and integrates well with the existing configuration.

ui/main/src/app/components/dashboard/dashboard.component.ts (1)

113-117: LGTM! Good implementation of the redirection logic.

The updated conditional logic now properly handles both types of redirections - to custom screens via screenId and to business menus via menuId. The use of optional chaining (?.) provides defensive coding against potential null values. The implementation maintains backward compatibility with existing configurations.

src/docs/asciidoc/deployment/configuration/web-ui_configuration.adoc (1)

73-95: LGTM! Clear and comprehensive documentation.

The documentation clearly explains the new configuration properties, including customCssToLoad, customJsToLoad, and dashboard.processStateRedirects. The example JSON provided matches the actual implementation and shows both redirection types (menuId and screenId).

✨ Finishing Touches

• 📝 Generate Docstrings

---

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 generate docstrings to generate docstrings for this 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.

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud