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

Introduce SourceDocument for text edit support #8957

Merged
merged 11 commits into from
Feb 6, 2024

Conversation

kazcw
Copy link
Contributor

@kazcw kazcw commented Feb 3, 2024

Pull Request Description

Introduce SourceDocument, a reactive source code representation that can be synced from a MutableModule. SourceDocument replaces various logic for tracking source code and spans--most importantly, ReactiveModule. There is no longer any reactively-tracked Module, per-se: Changes to the MutableModule attached to the synchronized ydoc are pushed as Y.Js events to the SourceDocument and GraphDb, which are reactively tracked. This avoids a problem in the upcoming text-synchronization (next PR) that was caused by a reactive back channel bypassing the GraphDb and resulting in observation of inconsistent states.

Stacked on #8956. Part of #8238.

Important Notes

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • All code has been tested:
    • Unit tests have been written where possible.
    • If GUI codebase was changed, the GUI was tested when built using ./run ide build.

@kazcw kazcw added CI: No changelog needed Do not require a changelog entry for this PR. -gui labels Feb 3, 2024
@kazcw kazcw self-assigned this Feb 3, 2024
import { print, type AstId, type Module, type ModuleUpdate } from '.'
import { rangeEquals, sourceRangeFromKey, type SourceRange } from '../yjsModel'

export class SourceDocument {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add some docs about this class, it will help to read the code.

@kazcw kazcw added the CI: Ready to merge This PR is eligible for automatic merge label Feb 6, 2024
@mergify mergify bot merged commit e0ba39e into develop Feb 6, 2024
26 of 27 checks passed
@mergify mergify bot deleted the wip/kw/text-edits-2-sourcedoc branch February 6, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
-gui CI: No changelog needed Do not require a changelog entry for this PR. CI: Ready to merge This PR is eligible for automatic merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants