feat: Support component deletion via component: null #528
+122
−8
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,7 +60,22 @@ | |
| "description": "A list containing all UI components for the surface.", | ||
| "minItems": 1, | ||
| "items": { | ||
| "oneOf": [ | ||
| { | ||
| "$ref": "standard_catalog.json#/$defs/anyComponent" | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "description": "A tombstone to remove a component. Omit the 'component' property to indicate deletion.", | ||
| "properties": { | ||
| "id": { | ||
| "$ref": "common_types.json#/$defs/ComponentId" | ||
| } | ||
| }, | ||
| "required": ["id"], | ||
| "additionalProperties": false | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -125,7 +125,7 @@ | |
| "id": "btn_primary", | ||
| "component": "Button", | ||
| "child": "txt_primary", | ||
| "action": { "event": { "name": "submit" } }, | ||
| "variant": "primary" | ||
| }, | ||
| { "id": "txt_primary", "component": "Text", "text": "Submit" } | ||
|
|
@@ -144,7 +144,7 @@ | |
| "id": "btn_borderless", | ||
| "component": "Button", | ||
| "child": "txt_borderless", | ||
| "action": { "event": { "name": "cancel" } }, | ||
| "variant": "borderless" | ||
| }, | ||
| { "id": "txt_borderless", "component": "Text", "text": "Cancel" } | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| { | ||
| "schema": "server_to_client.json", | ||
| "tests": [ | ||
| { | ||
| "description": "UpdateComponents with component deletion (tombstone)", | ||
| "valid": true, | ||
| "data": { | ||
| "updateComponents": { | ||
| "surfaceId": "test_surface", | ||
| "components": [ | ||
| { | ||
| "id": "item_to_delete" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "description": "UpdateComponents mixing update and deletion", | ||
| "valid": true, | ||
| "data": { | ||
| "updateComponents": { | ||
| "surfaceId": "test_surface", | ||
| "components": [ | ||
| { | ||
| "id": "new_item", | ||
| "component": "Text", | ||
| "text": "Hello" | ||
| }, | ||
| { | ||
| "id": "old_item" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "description": "Deletion with extra properties (should be invalid)", | ||
| "valid": false, | ||
| "data": { | ||
| "updateComponents": { | ||
| "surfaceId": "test_surface", | ||
| "components": [ | ||
| { | ||
| "id": "item_to_delete", | ||
| "text": "Should not be here" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "description": "Deletion missing ID (should be invalid)", | ||
| "valid": false, | ||
| "data": { | ||
| "updateComponents": { | ||
| "surfaceId": "test_surface", | ||
| "components": [ | ||
| {} | ||
| ] | ||
| } | ||
| } | ||
| } | ||
|
Contributor
There was a problem hiding this comment. These test cases are great for verifying the deletion-by-omission behavior. To make the contract even more explicit and prevent future regressions, it would be beneficial to add a test case that asserts that using },
{
"description": "Deletion with component: null (should be invalid per schema)",
"valid": false,
"data": {
"updateComponents": {
"surfaceId": "test_surface",
"components": [
{
"id": "item_to_delete",
"component": null
}
]
}
}
} |
||
| ] | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| {"createSurface":{"surfaceId":"contact_form_1","catalogId":"https://a2ui.dev/specification/v0_9/standard_catalog.json"}} | ||
| {"updateComponents": {"surfaceId": "contact_form_1", "components": [{"id": "root", "component": "Card", "child": "form_container"}, {"id": "form_container", "component": "Column", "children": ["header_row", "name_row", "email_group", "phone_group", "pref_group", "divider_1", "newsletter_checkbox", "submit_button"], "justify": "start", "align": "stretch"}, {"id": "header_row", "component": "Row", "children": ["header_icon", "header_text"], "align": "center"}, {"id": "header_icon", "component": "Icon", "name": "mail"}, {"id": "header_text", "component": "Text", "text": "# Contact Us", "variant": "h2"}, {"id": "name_row", "component": "Row", "children": ["first_name_group", "last_name_group"], "justify": "spaceBetween"}, {"id": "first_name_group", "component": "Column", "children": ["first_name_label", "first_name_field"], "weight": 1}, {"id": "first_name_label", "component": "Text", "text": "First Name", "variant": "caption"}, {"id": "first_name_field", "component": "TextField", "label": "First Name", "value": {"path": "/contact/firstName"}, "variant": "shortText"}, {"id": "last_name_group", "component": "Column", "children": ["last_name_label", "last_name_field"], "weight": 1}, {"id": "last_name_label", "component": "Text", "text": "Last Name", "variant": "caption"}, {"id": "last_name_field", "component": "TextField", "label": "Last Name", "value": {"path": "/contact/lastName"}, "variant": "shortText"}, {"id": "email_group", "component": "Column", "children": ["email_label", "email_field"]}, {"id": "email_label", "component": "Text", "text": "Email Address", "variant": "caption"}, {"id": "email_field", "component": "TextField", "label": "Email", "value": {"path": "/contact/email"}, "variant": "shortText", "checks": [{"call": "required", "args": [{"path": "/contact/email"}], "message": "Email is required."}, {"call": "email", "args": [{"path": "/contact/email"}], "message": "Please enter a valid email address."}]}, {"id": "phone_group", "component": "Column", "children": ["phone_label", "phone_field"]}, {"id": "phone_label", "component": "Text", "text": "Phone Number", "variant": "caption"}, {"id": "phone_field", "component": "TextField", "label": "Phone", "value": {"path": "/contact/phone"}, "variant": "shortText", "checks": [{"call": "regex", "args": [{"path": "/contact/phone"}, "^\\d{10}$"], "message": "Phone number must be 10 digits."}]}, {"id": "pref_group", "component": "Column", "children": ["pref_label", "pref_picker"]}, {"id": "pref_label", "component": "Text", "text": "Preferred Contact Method", "variant": "caption"}, {"id": "pref_picker", "component": "ChoicePicker", "variant": "mutuallyExclusive", "options": [{"label": "Email", "value": "email"}, {"label": "Phone", "value": "phone"}, {"label": "SMS", "value": "sms"}], "value": {"path": "/contact/preference"}}, {"id": "divider_1", "component": "Divider", "axis": "horizontal"}, {"id": "newsletter_checkbox", "component": "CheckBox", "label": "Subscribe to our newsletter", "value": {"path": "/contact/subscribe"}}, {"id": "submit_button_label", "component": "Text", "text": "Send Message"}, {"id": "submit_button", "component": "Button", "child": "submit_button_label", "variant": "primary", "action": {"event": {"name": "submitContactForm", "context": {"formId": "contact_form_1", "clientTime": {"call": "now", "returnType": "string"}, "isNewsletterSubscribed": {"path": "/contact/subscribe"}}}}}]}} | ||
| {"updateDataModel":{"surfaceId":"contact_form_1","path":"/contact","value":{"firstName":"John","lastName":"Doe","email":"john.doe@example.com","phone":"1234567890","preference":["email"],"subscribe":true}}} | ||
| {"deleteSurface":{"surfaceId":"contact_form_1"}} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation correctly states that deletion is done by omitting the
componentproperty, which aligns with the JSON schema. However, the pull request title (feat: Support component deletion via component: null) and description are inconsistent with this, as they state deletion is done viacomponent: null. Please update the PR title and description to match the implemented behavior to avoid confusion.