[FIX] CorePlugins: Prevent dispatch during adaptRange #7603
+87
−61
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
Collaborator
|
|
rrahir
force-pushed
the
18.0-prevent-dispatch-in-adapt-range-rar
branch
from
da92f16 to
920785b
Compare
hokolomopo
reviewed
Dec 5, 2025
src/plugins/core_plugin.ts
Outdated
Comment on lines
55
to
60
| // Bind adaptRanges to a version of `this` where `dispatch` always throws | ||
| const thisWithThrowingDispatch = Object.create(this); | ||
| thisWithThrowingDispatch.dispatch = () => { | ||
| throw new Error("dispatch is not allowed in adaptRanges context"); | ||
| }; | ||
| range.addRangeProvider(this.adaptRanges.bind(thisWithThrowingDispatch)); |
Contributor
There was a problem hiding this comment.
Add a test for this 🙂
And maybe it should be the responsibility of the range plugin, rather than every other plugin ? With a boolean isAdaptingRange or something that would throw on a command handle ... not sure tho.
Collaborator
Author
There was a problem hiding this comment.
And maybe it should be the responsibility of the range plugin
I thought about it as well, I liked that implementation a bit but the shallow copy might not be the brightest idea. Maybe others will have a strong opinion about this?
rrahir
force-pushed
the
18.0-prevent-dispatch-in-adapt-range-rar
branch
from
920785b to
0674451
Compare
Collaborator
|
@rrahir @LucasLefevre because this PR has multiple commits, I need to know how to merge it:
|
Collaborator
|
oups, I didn't see the second commit. I'm ok with the second implementation |
rrahir
force-pushed
the
18.0-prevent-dispatch-in-adapt-range-rar
branch
from
0674451 to
32f35b3
Compare
The method `adaptRange` was originally designed for each plugin to update their own ranges, whithout having to manually react to the different commands that alter the sheets structure. We have abused the system when we introduced the spreadsheet pivots to allow the modification of a pivot dataset (which is stored in PivotCorePlugin) from another entry point `SpreadsheetPivotCorePlugin`) by dispatching an UPDATE_PIVOT command but there are some side effects that we did not account for, the dispatched command is forwarded to EVERY other plugin. Meaning that during an adaptRange, which should only concern a specific plugin, we end up notifying a change to the whole core/coreview stack. This revision removes the access to 'dispatch' during the handling of `adaptRange` so we ensure that the changes are kept locally. Task: 5380747
rrahir
force-pushed
the
18.0-prevent-dispatch-in-adapt-range-rar
branch
from
32f35b3 to
eab32b3
Compare
Collaborator
Author
|
@LucasLefevre it's updated :) |
robodoo
pushed a commit
that referenced
this pull request
Dec 11, 2025
The method `adaptRange` was originally designed for each plugin to update their own ranges, whithout having to manually react to the different commands that alter the sheets structure. We have abused the system when we introduced the spreadsheet pivots to allow the modification of a pivot dataset (which is stored in PivotCorePlugin) from another entry point `SpreadsheetPivotCorePlugin`) by dispatching an UPDATE_PIVOT command but there are some side effects that we did not account for, the dispatched command is forwarded to EVERY other plugin. Meaning that during an adaptRange, which should only concern a specific plugin, we end up notifying a change to the whole core/coreview stack. This revision removes the access to 'dispatch' during the handling of `adaptRange` so we ensure that the changes are kept locally. closes #7603 Task: 5380747 Signed-off-by: Lucas Lefèvre (lul) <[email protected]>
This was referenced Dec 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The method
adaptRangewas originally designed for each plugin to update their own ranges, whithout having to manually react to the different commands that alter the sheets structure.We have abused the system when we introduced the spreadsheet pivots to allow the modification of a pivot dataset (which is stored in PivotCorePlugin) from another entry point
SpreadsheetPivotCorePlugin) by dispatching an UPDATE_PIVOT command but there are some side effects that we did not account for, the dispatched command is forwarded to EVERY other plugin. Meaning that during an adaptRange, which should only concern a specific plugin, we end up notifying a change to the whole core/coreview stack.This revision removes the access to 'dispatch' during the handling of
adaptRangeso we ensure that the changes are kept locally.Task: 5380747
Description:
description of this task, what is implemented and why it is implemented that way.
Task: TASK_ID
review checklist