You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
After calling form.deleteField('fieldName'), the field is removed from form.state.values, but after a moment it returns with defaultValue and appears at the end of the values object.
The problem occurred due to React lifecycle and the logic in FieldApi.mount()
Sequence of events:
User clicks delete -> form.deleteField('field') executes -> value is remo ved from form.state.values -> field metadata is removed - cool, but
React detects state change -> component re-renders
During re-render the field is still in the DOM (not unmounted)
React calls FieldApi.update() or lifecycle hooks -> this calls setFieldValue
In FieldApi.mount() there was logic:
if ((this.options.defaultValue as unknown) !== undefined) {
this.form.setFieldValue(this.name, this.options.defaultValue as never, {
dontUpdateMeta: true,
})
}
I think this uncoditionally restored defaultValue on every mount.update
PS: Even if we add a check in mount() - setFieldValue can be called from other places (e.g., from FieldApi.update() during React lifecycle).
I added a mechanism for tracking intentionally deleted fields to prevent their their accidental restoration.
Added _deletedFields: Set<string> in FormApi - it stores names of fields that were intentionally deleted by the user
deleteField() adds the field to _deletedFields
setFieldValue() blocks operations on deleted fields
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
An automatically generated fix could have helped fix failing tasks for this run, but Self-healing CI is disabled for this workspace. Visit workspace settings to enable it and get automatic fixes in future runs.
To disable these notifications, a workspace admin can disable them in workspace settings.
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.
🎯 Changes
Fixes: #1808
If this idea make sense, I will add tests
After calling
form.deleteField('fieldName'), the field is removed fromform.state.values, but after a moment it returns with defaultValue and appears at the end of the values object.The problem occurred due to React lifecycle and the logic in
FieldApi.mount()Sequence of events:
delete->form.deleteField('field')executes -> value is remo ved fromform.state.values-> field metadata is removed - cool, butFieldApi.update()or lifecycle hooks -> this callssetFieldValueFieldApi.mount()there was logic:I think this uncoditionally restored
defaultValueon every mount.updatePS: Even if we add a check in
mount()-setFieldValuecan be called from other places (e.g., fromFieldApi.update()during React lifecycle).I added a mechanism for tracking intentionally deleted fields to prevent their their accidental restoration.
_deletedFields: Set<string>inFormApi- it stores names of fields that were intentionally deleted by the userdeleteField()adds the field to_deletedFieldssetFieldValue()blocks operations on deleted fields✅ Checklist
pnpm test:pr.🚀 Release Impact