fix(Form): Avoid stale value in StringField #2300
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**Summary of changes:** - Introduced and updated logic for form field actions, particularly for handling "RAW" value wrapping in fields. - Refactored the PasswordField and StringField components to support toggling RAW wrapping, improved error handling, and added test coverage for these features. - Extracted isRawString function to add unit tests. - Simplified `useFieldValue` hook logic. fix: KaotoIO#2295 fix: KaotoIO#2296
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue in the StringField component where stale values persisted by ensuring that field values (including their RAW wrapping) update correctly.
- Introduced a new utility (isRawString) with unit tests.
- Refactored the useFieldValue hook to simplify value and RAW state management.
- Updated the StringField and PasswordField components (and corresponding tests) to support toggling RAW wrapping and improved clear functionality.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/ui/src/utils/is-raw-string.ts | Added a new utility function to detect RAW-wrapped strings. |
| packages/ui/src/utils/is-raw-string.test.ts | Added tests for the isRawString utility. |
| packages/ui/src/utils/index.ts | Exported the new isRawString utility. |
| packages/ui/src/components/Visualization/Canvas/FormV2/hooks/field-value.ts | Simplified useFieldValue hook by removing the wrapValueWithRaw method and integrating RAW state updates into onChange. |
| packages/ui/src/components/Visualization/Canvas/FormV2/hooks/field-value.test.tsx | Updated tests to reflect changes in the hook implementation. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/StringField.tsx | Refactored to allow additional utility components and added support for toggling raw wrapping using the new hook behavior. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/StringField.test.tsx | Added tests for additional utility and onRemove functionality. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/PasswordField.tsx | Updated similar to StringField, ensuring proper toggle and clear behavior for RAW values. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/PasswordField.test.tsx | Added tests for onRemove and error display in PasswordField. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/FieldActions.tsx | Updated FieldActions to use the passed toggleRawValueWrap function and include appropriate aria-labels and titles. |
| packages/ui/src/components/Visualization/Canvas/FormV2/fields/FieldActions.test.tsx | Added/updated tests to validate FieldActions behavior including the RAW toggle functionality. |
| onPropertyChange(propertyName, value); | ||
| setIsRaw(checkIfWrappedWithRaw(value)); | ||
| }; | ||
| const [isRaw, setIsRaw] = useState<boolean>(isRawString(value)); |
There was a problem hiding this comment.
Consider adding a useEffect to update the 'isRaw' state whenever the derived 'value' from the model changes, to prevent any potential state mismatch between external updates and the local hook state.
Copilot uses AI. Check for mistakes.
|
lhein
approved these changes
May 26, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2300 +/- ##
============================================
+ Coverage 82.53% 82.55% +0.02%
Complexity 468 468
============================================
Files 530 531 +1
Lines 17150 17161 +11
Branches 3587 3567 -20
============================================
+ Hits 14155 14168 +13
+ Misses 2912 2739 -173
- Partials 83 254 +171 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
While handling #1653, the update caused the
StringFieldto keep stale values because of how thevaluewas handled in theuseFieldValuehook.Fix
The fix is to keep the
valueupdated by theStringFieldin case of addingRAW()or cleaning the property altogether. This allows React to rerender theStringFieldcomponent, avoiding stale data.Changes
isRawStringfunction to add unit tests.useFieldValuehook logic.fix: #2295
fix: #2296