[doc] Add an ADR on the evolution of the refresh of the representations#6325
Merged
sbegaudeau merged 1 commit intomasterfrom Mar 27, 2026
Merged
[doc] Add an ADR on the evolution of the refresh of the representations#6325sbegaudeau merged 1 commit intomasterfrom
sbegaudeau merged 1 commit intomasterfrom
Conversation
frouene
requested changes
Mar 25, 2026
| - Finally, we will validate the approach with the `DeckEventProcessor` which is complex enough with its support for events | ||
| - Remove the previous API | ||
|
|
||
| During this transition period, if an implementation of `IRepresentationRefresher` exists for a given representation event processor. |
Contributor
There was a problem hiding this comment.
This sentence does not feel complete
| - as the entry point to perform changes on representations | ||
| - to perform the refresh of the representations | ||
|
|
||
| This create a large set of constraints on those classes with tons of responsibilities mixed together. |
| Since we have already removed some responsibilities related to the refresh from the `EditingContextEventProcessor` thanks to the introduction of the `RepresentationEventProcessorRefresher`. | ||
| We should not add the burden of the refresh to another existing concept. | ||
|
|
||
| One of the issue with the coupling of the refresh within the representation event processors is the coupling between the execution of the refresh which should be stateless and the state of the event processor which is inheritely stateful. |
|
|
||
| In the past, we have never formalized what the state of the representation event processor is. | ||
| Most people may still assume that it is limited to the `IRepresentation`. | ||
| We tried to moved towar an immutable data structure for the state of the `DiagramEventProcessor` with the switch to a record for `DiagramContext`. |
pcdavid
approved these changes
Mar 25, 2026
|
|
||
| In the past, we have never formalized what the state of the representation event processor is. | ||
| Most people may still assume that it is limited to the `IRepresentation`. | ||
| We tried to moved towar an immutable data structure for the state of the `DiagramEventProcessor` with the switch to a record for `DiagramContext`. |
39 tasks
Signed-off-by: Stéphane Bégaudeau <stephane.begaudeau@obeo.fr>
sbegaudeau
force-pushed
the
sbe/enh/adr-refresh
branch
from
db1bc74 to
478da1e
Compare
frouene
approved these changes
Mar 27, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Signed-off-by: Stéphane Bégaudeau stephane.begaudeau@obeo.fr
Pull request template
General purpose
What is the main goal of this pull request?
Project management
priority:andpr:labels been added to the pull request? (In case of doubt, start with the labelspriority: lowandpr: to review later)area:,difficulty:,type:)CHANGELOG.adocbeen updated to reference the relevant issues?CHANGELOG.adoc? (Including changes in the GraphQL API)CHANGELOG.adoc? For example indoc/screenshots/2022.5.0-my-new-feature.pngArchitectural decision records (ADR)
[doc]?CHANGELOG.adoc?Dependencies
CHANGELOG.adoc?CHANGELOG.adoc?Frontend
This section is not relevant if your contribution does not come with changes to the frontend.
General purpose
Typing
We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).
useMutation<DATA_TYPE, VARIABLE_TYPE>(…)useQuery<DATA_TYPE, VARIABLE_TYPE>(…)useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)useState<STATE_TYPE>(…)?.(if the GraphQL API specifies that a field cannot benull, do not treat it has potentiallynullfor example)let diagram: Diagram | null = null;)Backend
This section is not relevant if your contribution does not come with changes to the backend.
General purpose
Architecture
Review
How to test this PR?
Please describe here the various use cases to test this pull request