fix(core): drop mutate function from the signals public API #51821

pkozlowski-opensource · 2023-09-19T11:41:29Z

PR modifies the signals public API surface: drops the .mutate method and marks signal core APIs as stable.

This change removes the `mutate` method from the `WritableSignal` interface and completely drops it from the public API surface. The initial API proposal for Angular signals included the mutate method, allowing in-place modification of JS objects, without changing their references (identity). This was based on the reasoning that identity change on modification is not necessary as we can send the “modified” notification through the signals graph. Unfortunately the signal-specific change notification is lost as soon as we read signal value outside of a reactive context (outside of a reactive graph). In other words - any code outside of the Angular signals library can’t know that an object is modified. Secondly, to make the mutate method work, we’ve defaulted the signal value equality function to the one that considers non-primitive values as always different. This is unfortunate for people working with immutable data structures (this is notably the case for the popular state management libraries) as the default equality function de-optimizes memoization in computed, making the application less performant. Given the above reasons we prefer to remove the mutate method in the signals library - at least for now. There are just too many sharp edges and tradeoffs that we don’t fully understand yet. BREAKING CHANGE: The `mutate` method was removed from the `WritableSignal` interface and completely dropped from the public API surface. As an alternative please use the update method and make immutable changes to the object. Example before: ```typescript items.mutate(itemsArray => itemsArray.push(newItem)); ``` Example after: ```typescript items.update(itemsArray => [itemsArray, …newItem]); ```

This change marks core signal APIs as stable and exit developer preview for the main signal building blocks.

atscott

reviewed-for: public-api

jessicajaniuk

reviewed-for: fw-core, public-api

dylhunn

reviewed-for: fw-core, public-api

pkozlowski-opensource · 2023-10-05T12:41:30Z

caretaker note: g3 failure is unrelated

atscott · 2023-10-05T21:40:52Z

This PR was merged into the repository by commit 5b88d13.

This change marks core signal APIs as stable and exit developer preview for the main signal building blocks. PR Close #51821

…ngular#51821)" This reverts commit c7ff9df. requires cleanup of 2 uses internally first

…51821)" (#52081) This reverts commit c7ff9df. requires cleanup of 2 uses internally first PR Close #52081

…51821) This change removes the `mutate` method from the `WritableSignal` interface and completely drops it from the public API surface. The initial API proposal for Angular signals included the mutate method, allowing in-place modification of JS objects, without changing their references (identity). This was based on the reasoning that identity change on modification is not necessary as we can send the “modified” notification through the signals graph. Unfortunately the signal-specific change notification is lost as soon as we read signal value outside of a reactive context (outside of a reactive graph). In other words - any code outside of the Angular signals library can’t know that an object is modified. Secondly, to make the mutate method work, we’ve defaulted the signal value equality function to the one that considers non-primitive values as always different. This is unfortunate for people working with immutable data structures (this is notably the case for the popular state management libraries) as the default equality function de-optimizes memoization in computed, making the application less performant. Given the above reasons we prefer to remove the mutate method in the signals library - at least for now. There are just too many sharp edges and tradeoffs that we don’t fully understand yet. BREAKING CHANGE: The `mutate` method was removed from the `WritableSignal` interface and completely dropped from the public API surface. As an alternative please use the update method and make immutable changes to the object. Example before: ```typescript items.mutate(itemsArray => itemsArray.push(newItem)); ``` Example after: ```typescript items.update(itemsArray => [itemsArray, …newItem]); ```

…51986) This change removes the `mutate` method from the `WritableSignal` interface and completely drops it from the public API surface. The initial API proposal for Angular signals included the mutate method, allowing in-place modification of JS objects, without changing their references (identity). This was based on the reasoning that identity change on modification is not necessary as we can send the “modified” notification through the signals graph. Unfortunately the signal-specific change notification is lost as soon as we read signal value outside of a reactive context (outside of a reactive graph). In other words - any code outside of the Angular signals library can’t know that an object is modified. Secondly, to make the mutate method work, we’ve defaulted the signal value equality function to the one that considers non-primitive values as always different. This is unfortunate for people working with immutable data structures (this is notably the case for the popular state management libraries) as the default equality function de-optimizes memoization in computed, making the application less performant. Given the above reasons we prefer to remove the mutate method in the signals library - at least for now. There are just too many sharp edges and tradeoffs that we don’t fully understand yet. BREAKING CHANGE: The `mutate` method was removed from the `WritableSignal` interface and completely dropped from the public API surface. As an alternative please use the update method and make immutable changes to the object. Example before: ```typescript items.mutate(itemsArray => itemsArray.push(newItem)); ``` Example after: ```typescript items.update(itemsArray => [itemsArray, …newItem]); ``` PR Close #51986

roma2341 · 2023-10-19T10:09:32Z

Why you drop this function without any description? what are alternatives for dropped function ?

pkozlowski-opensource · 2023-10-19T10:11:07Z

@roma2341 description is provided as part of the commit message: 9ea54d4

angular-automatic-lock-bot · 2023-11-19T00:09:36Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

…51821) This change removes the `mutate` method from the `WritableSignal` interface and completely drops it from the public API surface. The initial API proposal for Angular signals included the mutate method, allowing in-place modification of JS objects, without changing their references (identity). This was based on the reasoning that identity change on modification is not necessary as we can send the “modified” notification through the signals graph. Unfortunately the signal-specific change notification is lost as soon as we read signal value outside of a reactive context (outside of a reactive graph). In other words - any code outside of the Angular signals library can’t know that an object is modified. Secondly, to make the mutate method work, we’ve defaulted the signal value equality function to the one that considers non-primitive values as always different. This is unfortunate for people working with immutable data structures (this is notably the case for the popular state management libraries) as the default equality function de-optimizes memoization in computed, making the application less performant. Given the above reasons we prefer to remove the mutate method in the signals library - at least for now. There are just too many sharp edges and tradeoffs that we don’t fully understand yet. BREAKING CHANGE: The `mutate` method was removed from the `WritableSignal` interface and completely dropped from the public API surface. As an alternative please use the update method and make immutable changes to the object. Example before: ```typescript items.mutate(itemsArray => itemsArray.push(newItem)); ``` Example after: ```typescript items.update(itemsArray => [itemsArray, …newItem]); ``` PR Close angular#51821

This change marks core signal APIs as stable and exit developer preview for the main signal building blocks. PR Close angular#51821

pkozlowski-opensource added area: core Issues related to the framework runtime core: reactivity Work related to fine-grained reactivity in the core framework cross-cutting: signals labels Sep 19, 2023

ngbot bot modified the milestone: Backlog Sep 19, 2023

pkozlowski-opensource force-pushed the signals_no_mutate branch from 28f442a to f76b158 Compare September 19, 2023 13:50

pkozlowski-opensource mentioned this pull request Sep 19, 2023

Signal.mutate() : Mutated objects are not reflected in the DOM #50191

Closed

eneajaho mentioned this pull request Oct 2, 2023

o16n: primitives code location #51986

Closed

pkozlowski-opensource force-pushed the signals_no_mutate branch from f76b158 to 9ea54d4 Compare October 4, 2023 16:00

angular-robot bot added the detected: breaking change PR contains a commit with a breaking change label Oct 4, 2023

feat(core): mark core signal APIs as stable

7d93d76

This change marks core signal APIs as stable and exit developer preview for the main signal building blocks.

angular-robot bot added the detected: feature PR contains a feature commit label Oct 4, 2023

pkozlowski-opensource added the target: major This PR is targeted for the next major release label Oct 4, 2023

pkozlowski-opensource marked this pull request as ready for review October 4, 2023 16:05

pullapprove bot requested review from atscott, dylhunn and jessicajaniuk October 4, 2023 16:05

atscott approved these changes Oct 4, 2023

View reviewed changes

pullapprove bot requested a review from alxhub October 4, 2023 16:08

pkozlowski-opensource modified the milestones: Backlog, v17-candidates Oct 4, 2023

jessicajaniuk approved these changes Oct 4, 2023

View reviewed changes

dylhunn approved these changes Oct 4, 2023

View reviewed changes

devversion approved these changes Oct 4, 2023

View reviewed changes

pkozlowski-opensource removed the request for review from alxhub October 5, 2023 12:37

pkozlowski-opensource added action: merge The PR is ready for merge by the caretaker merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note labels Oct 5, 2023

atscott closed this in c7ff9df Oct 5, 2023

atscott pushed a commit that referenced this pull request Oct 5, 2023

feat(core): mark core signal APIs as stable (#51821)

5b88d13

This change marks core signal APIs as stable and exit developer preview for the main signal building blocks. PR Close #51821

atscott added a commit to atscott/angular that referenced this pull request Oct 6, 2023

Revert "fix(core): drop mutate function from the signals public API (a…

b8f9b5f

…ngular#51821)" This reverts commit c7ff9df. requires cleanup of 2 uses internally first

atscott mentioned this pull request Oct 6, 2023

Revert "fix(core): drop mutate function from the signals public API (… #52081

Closed

atscott added a commit that referenced this pull request Oct 6, 2023

Revert "fix(core): drop mutate function from the signals public API (#…

b6b9eae

…51821)" (#52081) This reverts commit c7ff9df. requires cleanup of 2 uses internally first PR Close #52081

atscott mentioned this pull request Nov 9, 2023

Angular 17 - Mutable signals are not supported #52735

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Nov 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(core): drop mutate function from the signals public API #51821

fix(core): drop mutate function from the signals public API #51821

Uh oh!

pkozlowski-opensource commented Sep 19, 2023 •

edited

Loading

Uh oh!

atscott left a comment

Uh oh!

jessicajaniuk left a comment

Uh oh!

dylhunn left a comment

Uh oh!

pkozlowski-opensource commented Oct 5, 2023

Uh oh!

atscott commented Oct 5, 2023

Uh oh!

roma2341 commented Oct 19, 2023

Uh oh!

pkozlowski-opensource commented Oct 19, 2023

Uh oh!

angular-automatic-lock-bot bot commented Nov 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

fix(core): drop mutate function from the signals public API #51821

fix(core): drop mutate function from the signals public API #51821

Uh oh!

Conversation

pkozlowski-opensource commented Sep 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

atscott left a comment

Choose a reason for hiding this comment

Uh oh!

jessicajaniuk left a comment

Choose a reason for hiding this comment

Uh oh!

dylhunn left a comment

Choose a reason for hiding this comment

Uh oh!

pkozlowski-opensource commented Oct 5, 2023

Uh oh!

atscott commented Oct 5, 2023

Uh oh!

roma2341 commented Oct 19, 2023

Uh oh!

pkozlowski-opensource commented Oct 19, 2023

Uh oh!

angular-automatic-lock-bot bot commented Nov 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pkozlowski-opensource commented Sep 19, 2023 •

edited

Loading