Support "delete" keyword for object nodes #25738
Conversation
github-actions
bot
added
area: dds
noencke
left a comment
noencke
left a comment
There was a problem hiding this comment.
We should document this behavior somewhere. I think it would go on the docs for the TreeObjectNode type. Make sure this new behavior is documented and doesn't conflict with any existing docs.
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for using the delete operator on optional fields in ObjectNodes, making it functionally equivalent to assigning undefined to those fields.
Key Changes:
- Replaced error-throwing
deletePropertyhandler with implementation that callsapplyFieldChangewithundefined - Refactored field assignment logic into a new
applyFieldChangehelper function - Updated test from expecting an error to validating the delete behavior
- Added documentation explaining field assignment and deletion semantics
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/dds/tree/src/simple-tree/node-kinds/object/objectNode.ts | Implements delete support via new applyFieldChange helper and updated proxy deleteProperty handler |
| packages/dds/tree/src/test/simple-tree/node-kinds/object/objectNode.spec.ts | Updates test to validate delete behavior instead of expecting error |
| .changeset/fifty-crabs-add.md | Documents the new feature for changelog |
| : (targetToProxy.get(from.node) ?? fail("missing proxy")); | ||
| const inner = getInnerNode(proxy); | ||
| const storedSchema = inner.context.schema.nodeSchema.get(brand(schema.identifier)); | ||
| assert(storedSchema instanceof ObjectNodeStoredSchema, "Expected ObjectNodeStoredSchema"); |
There was a problem hiding this comment.
When writing asserts (from @fluidframework/core-utils), please use a string literal for the error message, not a hex assert code. This instruction should only apply to newly added asserts, not existing ones.
3 participants
Description
This PR adds support for the "delete" keyword in object nodes.
Breaking Changes
None