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

dirty tracking doc and a code trace #360

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

scytacki
Copy link
Member

@scytacki scytacki commented Nov 4, 2024

No description provided.

@scytacki scytacki requested a review from kswenson November 4, 2024 20:57
Copy link
Member

@kswenson kswenson left a comment

Choose a reason for hiding this comment

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

👍 LGTM -- nice work. There's some work to do in v3 to get some of this right.


The shared doc info is related to the dirty state of the document because the CFM needs to know to save the original document once this shared doc info has been added to it. When the document is shared or unshared the CFM will mark the document as dirty. This is one case where the CFM will actually mark the document dirty itself.

This is further complicated by the unwrapped option in the CFM. When the client configures the CFM to store the content unwrapped, it is the responsibility of the client to store the shared doc info inside of its content. Clients using the unwrapped option do this by listening for the `sharedFile` event from the CFM. After updating the content a client should set the dirty state so the CFM knows it should save the client's updated content.
Copy link
Member

Choose a reason for hiding this comment

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

I think v3 is not doing this at the moment. There should be a story for it in the CODAP v3 PT board if there isn't.

Copy link
Member Author

Choose a reason for hiding this comment

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

@scytacki scytacki merged commit a8dec0a into master Nov 5, 2024
2 checks passed
@scytacki scytacki deleted the 188182907-extra-documentation branch November 5, 2024 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants