Add Clone to SharedTree Revertible #23044

jikim-msft · 2024-11-09T00:14:23Z

Description

13864

This PR adds forkable revertible feature to the Revertible object of SharedTree.

Removed DisposableRevertible and replaced by RevertibleAlpha.
Added clone() method to the new interface.
Uses TreeBranch (which is subset of TreeCheckout) to access data necessary for revert operation.

…dFramework into revertible-alpha

msfluid-bot

Code Coverage Summary

↓ packages.dds.tree.src.shared-tree:
Line Coverage Change: -0.03% Branch Coverage Change: -0.15%

Metric Name	Baseline coverage	PR coverage	Coverage Diff
Branch Coverage	90.88%	90.73%	↓ -0.15%
Line Coverage	97.28%	97.25%	↓ -0.03%

↑ packages.dds.tree.src.simple-tree.api:
Line Coverage Change: 0.01% Branch Coverage Change: No change

Metric Name	Baseline coverage	PR coverage	Coverage Diff
Branch Coverage	88.76%	88.76%	→ No change
Line Coverage	82.35%	82.36%	↑ 0.01%

Baseline commit: cfb6838
Baseline build: 306774
Happy Coding!!

Code coverage comparison check passed!!

msfluid-bot · 2024-11-09T03:31:51Z

⯅ @fluid-example/bundle-size-tests: +919 Bytes

Metric Name	Baseline Size	Compare Size	Size Diff
aqueduct.js	465.72 KB	465.75 KB	⯅ +35 Bytes
azureClient.js	563.04 KB	563.09 KB	⯅ +49 Bytes
connectionState.js	724 Bytes	724 Bytes	■ No change
containerRuntime.js	262.34 KB	262.35 KB	⯅ +14 Bytes
fluidFramework.js	426.99 KB	427.34 KB	⯅ +351 Bytes
loader.js	134.18 KB	134.19 KB	⯅ +14 Bytes
map.js	42.71 KB	42.71 KB	⯅ +7 Bytes
matrix.js	149.84 KB	149.85 KB	⯅ +7 Bytes
odspClient.js	528.83 KB	528.88 KB	⯅ +49 Bytes
odspDriver.js	97.88 KB	97.9 KB	⯅ +21 Bytes
odspPrefetchSnapshot.js	42.81 KB	42.83 KB	⯅ +14 Bytes
sharedString.js	165.77 KB	165.78 KB	⯅ +7 Bytes
sharedTree.js	417.45 KB	417.79 KB	⯅ +344 Bytes
Total Size	3.37 MB	3.37 MB	⯅ +919 Bytes

Baseline commit: cfb6838

Generated by 🚫 dangerJS against eddc5a3

packages/dds/tree/src/core/revertible.ts

packages/dds/tree/src/shared-tree/treeCheckout.ts

Copilot reviewed 5 out of 6 changed files in this pull request and generated no suggestions.

Files not reviewed (1)

packages/dds/tree/src/core/index.ts: Evaluated as low risk

Comments skipped due to low confidence (2)

packages/dds/tree/src/shared-tree/treeCheckout.ts:634

[nitpick] The method name 'clone' might be ambiguous. Consider renaming it to 'createClone' or 'duplicate' for better clarity.

clone: (forkedBranch?: TreeBranch) => {

packages/dds/tree/src/shared-tree/treeCheckout.ts:639

[nitpick] The error message 'Unable to dispose a revertible that has already been disposed.' could be more descriptive. Consider providing more context about why this error might occur.

throw new UsageError("Unable to dispose a revertible that has already been disposed.");

Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more

packages/dds/tree/src/core/revertible.ts

packages/dds/tree/src/test/utils.ts

packages/dds/tree/src/test/shared-tree/undo.spec.ts

packages/dds/tree/src/test/utils.ts

packages/dds/tree/src/core/revertible.ts

packages/dds/tree/src/shared-tree/treeCheckout.ts

packages/dds/tree/src/test/utils.ts

Co-authored-by: Joshua Smithrud <[email protected]>

noencke · 2024-11-13T20:49:24Z

packages/dds/tree/src/test/shared-tree/undo.spec.ts

+
+	it("clone revertible fails if trees are different", () => {
+		const viewA = asTreeViewAlpha(createLocalSharedTree("testSharedTreeOne"));
+		const viewB = asTreeViewAlpha(createLocalSharedTreeTwo("testSharedTreeTwo"));


For this test case, it's not important that the two trees have different schema - the part that matters is that they are different instances of a SharedTree. So, it should be perfectly fine to initialize viewB using a second call to createLocalSharedTree() rather than createLocalSharedTreeTwo(). And then you can delete createLocalSharedTreeTwo().

noencke · 2024-11-13T20:56:28Z

packages/dds/tree/src/test/shared-tree/undo.spec.ts

@@ -453,6 +464,137 @@ describe("Undo and redo", () => {
 		revertible.revert();
 		assert.equal(view.root.foo, 1);
 	});
+
+	it("reverts original & forked revertibles after making change to the original view", () => {


Can you write these tests within the loop that all of the other tests (except 1 - "can undo while detached") in this file are in? If you look at the describe block at the top of the file, you will see that it runs all the tests in "attached" and "detached" modes. If you adapt your tests here to use the getCheckout helper, it should be easy to have them do the same thing.

Well, actually, it's a little weird. You have a couple of options.

Write your tests in the pattern already established in this file. So, you don't define a schema, and instead you do what all the other tests do and use createCheckout and tree.editor to do edits. This isn't the best way to edit the tree, but it's consistent with how the rest of the file is doing it. So when somebody goes to convert this file later to the "better way", it won't really add any more work to change your tests since they'll all be updated in the same way.

Write your tests in a newer, better pattern - kind of what you are already doing, although I'd recommend you use something like TestTreeProviderLite rather than writing the factory/runtime code yourself. This is nice because it uses a real schema, and the better APIs for editing. However, then we end up with two different patterns in this file - the existing ones, and your new ones. And somebody coming along later to fix this file will have to deal with both patterns.

My vote would be for (1). We should either convert this whole file to a better test pattern first, and then do this PR. Or, we should write new tests in the same way as the current pattern, and then convert them all at once.

Curious what you think. Either way, having your tests run against both "attached" and "detached" scenarios is valuable - and doing that and also (2) will mean some duplicated/divergent code.

I think I can go along with case (1) and I've noticed that there are skipped cases with // TODO: unskip once forking revertibles is supported comment.

I can un-skip these pre-written test cases.

@noencke

I've tried to use createCheckout() and tree.editor but realized clone: (branch?: TreeBranch), thus I can't (and shouldn't) pass TreeCheckout. Unless there is a way to convert TreeCheckout to TreeBranch prior to calling clone(), I think I should rewrite the skipped tests with my test design.

What do you think?

packages/dds/tree/src/core/revertible.ts

jenn-le · 2024-11-13T22:03:03Z

packages/dds/tree/src/shared-tree/schematizingTreeView.ts

@@ -409,7 +409,7 @@ export class SchematizingSimpleTreeView<
 * @remarks Currently, all contexts are also {@link SchematizingSimpleTreeView}s.
 * Other checkout implementations (e.g. not associated with a view) may be supported in the future.
 */
-function getCheckout(context: TreeBranch): TreeCheckout {
+export function getCheckout(context: TreeBranch): TreeCheckout {


@noencke should using this function be established as the normal pattern? there are a bunch of places I know of that are just getting the checkout directly but also, are we really that concerned about checking that it's a schematizing simple tree view?

packages/dds/tree/src/shared-tree/treeCheckout.ts

jenn-le · 2024-11-13T22:29:50Z

packages/dds/tree/src/shared-tree/treeCheckout.ts

+					revertible.dispose();
+				}
+			},
+			clone: (forkedBranch?: TreeBranch) => {


what was the reasoning behind allowing forkedBranch to be optional? why not just make it required and not allow clone to be called without a fork? the behavior for cloning a revertible onto the same checkout doesn't seem obvious to me and i'm not sure why we'd want to do so

packages/dds/tree/src/shared-tree/treeCheckout.ts

packages/dds/tree/src/test/shared-tree/undo.spec.ts

jenn-le · 2024-11-14T00:34:30Z

packages/dds/tree/src/test/shared-tree/undo.spec.ts

+		assert.equal(clonedUndoOriginalPropertyTwo?.status, RevertibleStatus.Disposed);
+	});
+
+	it("reverts cloned revertible on original view", () => {


you should add a test that expects clone to throw if the view doesn't have the revision (also in the case where the view already reverted something)

I think clone revertible fails if trees are different already tests "no revision in view" scenario?

The test tries to clone(viewB).revert() on a revertible created from viewA. Since, viewA and viewB but fails since the revertible passed to the viewB doesn't exist in its revertibleCommitBranch.

Added test case cloned revertible fails if already applied for view already reverted something scenario. Thanks.

packages/dds/tree/src/test/shared-tree/undo.spec.ts

Co-authored-by: Jenn <[email protected]>

github-actions · 2024-11-14T02:32:20Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> [email protected] ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start 1313 linkcheck:full

1: starting server using command "npm run ci:start"
and when url "[ 'http://127.0.0.1:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"


> [email protected] ci:start
> http-server ./public --port 1313 --silent


> [email protected] linkcheck:full
> npm run linkcheck:fast -- --external


> [email protected] linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external

Crawling...

Stats:
  443760 links
    3414 destination URLs
       2 URLs ignored
       0 warnings
       0 errors

jikim-msft added 4 commits November 8, 2024 00:09

first commit

408ff9e

add getCheckout & test case

bdfbd3a

no nuke map

7f0777e

add test

94b8b5a

github-actions bot added base: main PRs targeted against main branch area: dds Issues related to distributed data structures area: dds: tree labels Nov 9, 2024

jikim-msft added 3 commits November 8, 2024 16:15

Merge branch 'main' into revertible-alpha

73dfa36

policy fix

1364971

Merge branch 'revertible-alpha' of https://github.com/jikim-msft/Flui…

f0a7c6e

…dFramework into revertible-alpha

jikim-msft changed the title ~~Revertible alpha~~ Add clone to SharedTree Revertible Nov 9, 2024

jikim-msft changed the title ~~Add clone to SharedTree Revertible~~ Add Clone to SharedTree Revertible Nov 9, 2024

refactor

0d593b4

jikim-msft marked this pull request as ready for review November 9, 2024 02:36

jikim-msft requested a review from a team as a code owner November 9, 2024 02:36

jikim-msft requested review from jenn-le and noencke November 9, 2024 02:36

change test suite name

09f10e5

msfluid-bot reviewed Nov 9, 2024

View reviewed changes

noencke reviewed Nov 11, 2024

View reviewed changes

packages/dds/tree/src/core/revertible.ts Outdated Show resolved Hide resolved

packages/dds/tree/src/shared-tree/treeCheckout.ts Outdated Show resolved Hide resolved

packages/dds/tree/src/shared-tree/treeCheckout.ts Outdated Show resolved Hide resolved

frankmueller-msft requested a review from Copilot November 11, 2024 19:44

Copilot AI reviewed Nov 11, 2024

View reviewed changes

change name to RevertibleAlpha & remove DisposableRevertible

896f22f

Josmithr reviewed Nov 11, 2024

View reviewed changes

packages/dds/tree/src/core/revertible.ts Outdated Show resolved Hide resolved

inline logic

b967512

Josmithr reviewed Nov 11, 2024

View reviewed changes

packages/dds/tree/src/test/utils.ts Outdated Show resolved Hide resolved

Josmithr reviewed Nov 11, 2024

View reviewed changes

packages/dds/tree/src/test/shared-tree/undo.spec.ts Outdated Show resolved Hide resolved

jikim-msft added 2 commits November 12, 2024 02:24

refactor create undo/redo stack function & change name

33e1fde

add doc

0f62865

Merge branch 'microsoft:main' into revertible-alpha

b3ac268

github-actions bot added the public api change Changes to a public API label Nov 12, 2024

add TODO & update api

855fe89

github-actions bot added the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Nov 13, 2024

noencke reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/test/utils.ts Outdated Show resolved Hide resolved

jikim-msft added 4 commits November 13, 2024 17:56

change name back to createTestUndoRedoStacks

cec77a5

add doc

c4ed841

fix import

85319e7

change from commit to changed

80946ab

Josmithr reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/core/revertible.ts Outdated Show resolved Hide resolved

Josmithr reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/core/revertible.ts Outdated Show resolved Hide resolved

Josmithr reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/shared-tree/treeCheckout.ts Show resolved Hide resolved

noencke reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/shared-tree/treeCheckout.ts Outdated Show resolved Hide resolved

Josmithr reviewed Nov 13, 2024

View reviewed changes

packages/dds/tree/src/test/utils.ts Outdated Show resolved Hide resolved

jikim-msft and others added 6 commits November 13, 2024 19:02

change name of forkedBranch

7d87eb7

update api doc

bd83bd2

Update packages/dds/tree/src/test/utils.ts

684943e

Co-authored-by: Joshua Smithrud <[email protected]>

fix doc

9969510

change function param

41acc0d

Merge branch 'microsoft:main' into revertible-alpha

b7b2b2f

noencke reviewed Nov 13, 2024

View reviewed changes

jikim-msft added 3 commits November 13, 2024 22:58

simplify test

fa5e774

update api

ec15843

update doc

233749d

jenn-le reviewed Nov 14, 2024

View reviewed changes

jikim-msft and others added 4 commits November 13, 2024 17:54

Update packages/dds/tree/src/core/revertible.ts

e50bc39

Co-authored-by: Jenn <[email protected]>

Update packages/dds/tree/src/core/revertible.ts

fec248e

Co-authored-by: Jenn <[email protected]>

Update packages/dds/tree/src/shared-tree/treeCheckout.ts

5603232

Co-authored-by: Jenn <[email protected]>

fix nit

eddc5a3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Clone to SharedTree Revertible #23044

Add Clone to SharedTree Revertible #23044

jikim-msft commented Nov 9, 2024 •

edited

Loading

msfluid-bot left a comment •

edited

Loading

msfluid-bot commented Nov 9, 2024 •

edited

Loading

noencke Nov 13, 2024

noencke Nov 13, 2024

noencke Nov 13, 2024 •

edited

Loading

jikim-msft Nov 13, 2024

jikim-msft Nov 14, 2024

jenn-le Nov 13, 2024

jenn-le Nov 13, 2024

jenn-le Nov 14, 2024

jikim-msft Nov 14, 2024 •

edited

Loading

github-actions bot commented Nov 14, 2024

Add Clone to SharedTree Revertible #23044

Are you sure you want to change the base?

Add Clone to SharedTree Revertible #23044

Conversation

jikim-msft commented Nov 9, 2024 • edited Loading

Description

msfluid-bot left a comment • edited Loading

Choose a reason for hiding this comment

Code Coverage Summary

Code coverage comparison check passed!!

msfluid-bot commented Nov 9, 2024 • edited Loading

Choose a reason for hiding this comment

noencke Nov 13, 2024

Choose a reason for hiding this comment

noencke Nov 13, 2024

Choose a reason for hiding this comment

noencke Nov 13, 2024 • edited Loading

Choose a reason for hiding this comment

jikim-msft Nov 13, 2024

Choose a reason for hiding this comment

jikim-msft Nov 14, 2024

Choose a reason for hiding this comment

jenn-le Nov 13, 2024

Choose a reason for hiding this comment

jenn-le Nov 13, 2024

Choose a reason for hiding this comment

jenn-le Nov 14, 2024

Choose a reason for hiding this comment

jikim-msft Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Nov 14, 2024

linkcheck output

jikim-msft commented Nov 9, 2024 •

edited

Loading

msfluid-bot left a comment •

edited

Loading

msfluid-bot commented Nov 9, 2024 •

edited

Loading

noencke Nov 13, 2024 •

edited

Loading

jikim-msft Nov 14, 2024 •

edited

Loading