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

feat(web): WHODAS - Allow for overwriting question text in CMS #17838

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Feb 5, 2025

WHODAS - Allow for overwriting question text in CMS

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Enabled custom text labels for answer options in the questionnaire. If custom text is provided for an answer, it is displayed; otherwise, the default label is used. This enhancement offers more flexibility and clarity when selecting options.

@RunarVestmann RunarVestmann requested review from a team as code owners February 5, 2025 15:58
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

The changes introduce an optional text property for each answer option within the Question interface in the WHODAS component. The WHODASForm component now checks if an answer option has a text property and uses it as the radio button label; if not, it falls back to the existing label generation using formatMessage.

Changes

File(s) Change Summary
apps/web/components/.../Calculator.tsx Added optional text property to the answerOptions in the Question interface; updated WHODASForm to use text for radio button labels if present, otherwise fallback to formatMessage.

Sequence Diagram(s)

sequenceDiagram
    participant WF as WHODASForm
    participant AO as AnswerOption
    participant FM as formatMessage

    WF->>AO: Check if "text" property exists
    alt Text is provided
        AO-->>WF: Return text value
    else Text is not provided
        WF->>FM: Retrieve label via formatMessage
        FM-->>WF: Return formatted label
    end
    WF->>WF: Render radio button with label
Loading

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • mannipje

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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.

Copy link

nx-cloud bot commented Feb 5, 2025

View your CI Pipeline Execution ↗ for commit 5deb90e.

Command Status Duration Result
nx run-many --target=build --projects=web --par... ✅ Succeeded 6m 43s View ↗
nx run-many --target=lint --projects=web --para... ✅ Succeeded 1m 3s View ↗
nx run-many --projects web --target test --para... ✅ Succeeded 15s View ↗
nx run-many --target=codegen/frontend-client --... ✅ Succeeded 12s View ↗
nx run-many --target=codegen/backend-schema --a... ✅ Succeeded 21s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-05 16:15:34 UTC

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

🧹 Nitpick comments (1)
apps/web/components/connected/WHODAS/Calculator.tsx (1)

93-99: Consider extracting label generation logic.

The label generation logic could be extracted into a separate function for better maintainability and reusability.

+const getAnswerLabel = (
+  option: { text?: string; score: number },
+  answerIndex: number,
+  formatMessage: IntlFormatters['formatMessage']
+) => {
+  return (
+    (option.text?.trim() || '') ||
+    formatMessage(
+      m.answerLabel[String(answerIndex) as keyof typeof m.answerLabel]
+    )
+  )
+}

-                  const label =
-                    option.text ||
-                    formatMessage(
-                      m.answerLabel[
-                        String(answerIndex) as keyof typeof m.answerLabel
-                      ],
-                    )
+                  const label = getAnswerLabel(option, answerIndex, formatMessage)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c81f657 and 5deb90e.

📒 Files selected for processing (1)
  • apps/web/components/connected/WHODAS/Calculator.tsx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`apps/**/*`: "Confirm that the code adheres to the following...

apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
  • apps/web/components/connected/WHODAS/Calculator.tsx
🔇 Additional comments (2)
apps/web/components/connected/WHODAS/Calculator.tsx (2)

34-40: LGTM! Type-safe implementation of the text override feature.

The optional text property is correctly typed and aligns with TypeScript best practices.


93-99: Consider adding validation for empty text.

While the implementation is correct, consider adding validation to handle empty strings in the text property to ensure consistent label display.

-                  const label =
-                    option.text ||
-                    formatMessage(
-                      m.answerLabel[
-                        String(answerIndex) as keyof typeof m.answerLabel
-                      ],
-                    )
+                  const label = 
+                    (option.text?.trim() || '') ||
+                    formatMessage(
+                      m.answerLabel[
+                        String(answerIndex) as keyof typeof m.answerLabel
+                      ],
+                    )
✅ Verification successful

Error: No shell scripts or web queries found


Enhance Label Validation for Consistent UI Behavior

  • The current logic returns option.text without checking for empty or whitespace strings, which may lead to unwanted UI behavior.
  • Using a trimmed check (e.g., option.text?.trim()) ensures that even strings containing only spaces fall back to the formatted default from m.answerLabel.
  • Consider extracting this label-generation logic into a separate function for improved maintainability and reusability.

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.

1 participant