Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: document and export common/known update tags #5992

Open
etrepum opened this issue Apr 30, 2024 · 0 comments
Open

Feature: document and export common/known update tags #5992

etrepum opened this issue Apr 30, 2024 · 0 comments
Labels
contribution-week Issues that are good to be picked up for the contribution week enhancement Improvement over existing feature

Comments

@etrepum
Copy link
Contributor

etrepum commented Apr 30, 2024

If we export the update tags that are used internally it'll be easier to document what they're for and people will be less likely to make a typo which is hard to debug since it's used as an extensible Set<string> and there is no way a dev mode would be able to detect 'unregistered' use since there is no registration process like commands.

Some examples in the monorepo that I'm aware of:

  • historic
  • history-push
  • history-merge
  • paste
  • collaboration
  • skip-collab
  • skip-scroll-into-view

It might also be a good time to think about how and whether updates with different tags should really be merged, since you could have two updates in the same tick with very different semantics. It might be the case that for correct behavior they should be reconciled separately at least if they were not part of the same top-level update. It seems reasonable that cascading transforms and any other sort of explicit nested update should inherit tags but if the updates were completely separate it might not make sense. I think this sort of bug would be very hard to catch and reproduce, and tags are probably used rarely enough that it wouldn't be a performance impact to reconcile more than once in a tick (iff updates with different tag sets are to be combined) to avoid this kind of incoherence.

@etrepum etrepum added the enhancement Improvement over existing feature label Apr 30, 2024
@StyleT StyleT added the contribution-week Issues that are good to be picked up for the contribution week label May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution-week Issues that are good to be picked up for the contribution week enhancement Improvement over existing feature
Projects
None yet
Development

No branches or pull requests

2 participants