fix: Text resource unsetting issues

[TomasEng]

Description

As discovered during manual testing, the text resource selector sometimes changes the value in its text field unexpectedly while the user is writing:
https://github.com/user-attachments/assets/ea0a526b-5b67-41c5-be8c-c821cc3aae14

The reason for this is that when the user changes the value so that it becomes invalid, onValueChange is called with an empty array, which in turn triggers a rerender with the option representing an unset value as selected.

Fixing this using the API from The Design System doesn't seem to be possible without complex workarounds. The Combobox component undertakes some unpredictable behaviour, and the fact that it's asynchronous adds to the complexity. It is also deprecated in The Design System, so it will probably not be improved. When we have upgraded The Design System and its Suggestion component is out of the experimental phase, we should update TextResourcePicker to use that component. Meanwhile, I have chosen to solve the current issue by removing the label of the unset option. I have placed it in the description instead, so that it is still visible.

Here is a demo:
https://github.com/user-attachments/assets/5dc64021-88c0-4186-9c06-502293b67124

Related Issue(s)

• Implement text reference handling in code list table #13739

Verification

• Your code builds clean without any errors or warnings
• Manual testing done (required)
• Relevant automated test added (if you find this hard, leave it and we'll help out)

Summary by CodeRabbit

• Bug Fixes

  • Updated the text resource picker to display an empty state when no text resource is selected, providing clearer feedback.
  • Enhanced handling of user input so that manual changes remain intact until a valid selection is made.

• Tests

  • Added a test to ensure the component faithfully reflects user input during changes.
  • Revised existing tests to match the updated default behavior and improve maintainability.

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

frontend/libs/studio-components/src/components/StudioTextResourcePicker/StudioTextResourcePicker.test.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-storybook".

(The package "eslint-plugin-storybook" was not found when loaded as a Node module from the directory "/frontend/libs/studio-components".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-storybook@latest --save-dev

The plugin "eslint-plugin-storybook" was referenced from the config file in "frontend/libs/studio-components/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

This pull request updates the StudioTextResourcePicker component and its tests. In the test file, the default assertion is modified to expect an empty string instead of a label, and a new test case is added to verify that user backspacing retains the entered value. In the component file, the default value prop is changed from [''] to an empty array when not provided, and the rendering of the no-text-resource option now uses aria-label and description props instead of a child element. There are no changes to the exported public interfaces.

Changes

File(s)	Change Summary
frontend/libs/studio-components/.../StudioTextResourcePicker.test.tsx	Updated test assertion for default value (expecting an empty string rather than the unset label) and added a test case to verify user input retention on backspacing.
frontend/libs/studio-components/.../StudioTextResourcePicker.tsx	Modified default value handling (changed from [''] to []) and updated the rendering of the no-text-resource option to use aria-label and description attributes.

Possibly related PRs

• fix: Support unsetting the text resource in the text resource picker #14496: Addresses modifications related to the handling of the noTextResourceOptionLabel and unsetting text resources.
• fix: summary2 override combobox crash #14512: Involves changes to the StudioCombobox to manage user input and state, which is closely connected to the updated user interactions in this PR.

Suggested labels

area/ui-editor, quality/testing, kind/bug, skip-manual-testing

Suggested reviewers

• ErlingHauan
• Jondyr

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.

---

📜 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 f64f2cd and 17c2409.

📒 Files selected for processing (1)

• frontend/libs/studio-components/src/components/StudioTextResourcePicker/StudioTextResourcePicker.test.tsx (4 hunks)

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

• frontend/libs/studio-components/src/components/StudioTextResourcePicker/StudioTextResourcePicker.test.tsx

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

• GitHub Check: Build environment and run e2e test
• GitHub Check: CodeQL
• GitHub Check: Testing

---

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. (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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.73%. Comparing base (e2cdf67) to head (5416e7d).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #14568      +/-   ##
==========================================
- Coverage   95.73%   95.73%   -0.01%     
==========================================
  Files        1906     1906              
  Lines       24844    24843       -1     
  Branches     2848     2848              
==========================================
- Hits        23785    23784       -1     
  Misses        799      799              
  Partials      260      260              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[wrt95]

One nitpick comment added 😄

[ErlingHauan]

Nice workaround. Tested in Storybook - I think it works great now.