Tree: Cleanup and document dependencies within tree #11656
Conversation
github-actions
bot
added
area: dds
packages/dds/tree/README.md
Outdated
|
|
||
| - Reducing transitive dependencies: | ||
|
|
||
| Try to keep the total number of dependencies of a given component small when possible, with a particular emphasis on avoiding stateful dependencies for code with complex conditional logic. |
There was a problem hiding this comment.
It's not completely clear to me what is meant by stateful dependencies.
There was a problem hiding this comment.
I rewrote and extended this section. Hopefully its more clear now
| A change family has to handle all its supported changes identically between all clients, and across all versions. | ||
| Support for new kinds of changes can be added, but updating applications to use the new changes must be done carefully to avoid breaking old clients. | ||
|
|
||
| Applications that only have ephemeral sessions and never persist documents with trailing ops may be able to relax this constraint somewhat. |
There was a problem hiding this comment.
What are trailing ops?
There was a problem hiding this comment.
Ops stored in server side summaries which are applied on container load. Thet exist to prevent dataloss when a session ends between summaries. As they are an important concept in fluid, but we don't seem to define them anywhere (though the term is used several times), I'm asking internally where documentation about them belongs and will try and update and link that.
There was a problem hiding this comment.
Looks like there currently arn't docs covering trailing ops. When such docs get added I'll update this to link them, but for now I'll leave this as is.
packages/dds/tree/src/feature-libraries/sequence-change-family/README.md
Show resolved
Hide resolved
Co-authored-by: alex-pardes <105307164+alex-pardes@users.noreply.github.com>
Co-authored-by: alex-pardes <105307164+alex-pardes@users.noreply.github.com>
|
This commit is queued for merging with the |
Description
Documents the existing dependency structure, adds a couple missing readmes, and removes some unused deps from the fence files.
Reviewer Guidance
Focus here should be on the readme content and related changes. Feedback on the actual dependency structure (other than the removed deps) is a separate concern beyond this PR.