tree: Import / Export APIs and demo #22566

CraigMacomber · 2024-09-19T00:19:58Z

Description

Added import/export options for tree content and schema, and example script using them.

Reviewer Guidance

The review process is outlined on this wiki page.

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

…to clone

…to independentView

…to CLI

jzaffiro

A few minor comments, but docs look good!

.changeset/chubby-olives-say.md

examples/apps/tree-cli-app/README.md

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

…to CLI

…#22927) ## Description A collection of minor improvements split out from #22566 for simplified and more targeted review.

…to CLI

.changeset/chubby-olives-say.md

jenn-le · 2024-10-31T20:42:38Z

examples/apps/tree-cli-app/src/index.ts

+const args = process.argv.slice(2);
+
+console.log(`Requires arguments: [<source>] [<destination>] [<edit>]`);
+console.log(`Example arguments: default data/large.concise.json string:10,item:100`);


the example for edit is a bit confusing to me, maybe expand on its expected format or how this particular example affects the document?

should be better now.

examples/apps/tree-cli-app/src/schema.ts

examples/apps/tree-cli-app/src/test/schema.spec.ts

jenn-le · 2024-10-31T23:03:54Z

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

+			},
+			...options,
+		};
+		const schemalessConfig = applySchemaToParserOptions(schema, config);


why is this considered schemaless?

comment added.

jenn-le · 2024-10-31T23:14:35Z

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

+		const codec = makeFieldBatchCodec({ jsonValidator: noopValidator }, format);
+		const cursor = borrowFieldCursorFromTreeNodeOrValue(node);
+		const batch: FieldBatch = [cursor];
+		// If none provided, create a compressor which will not compress anything (TODO: is this the right way to do that?).


this seems like a todo that should prob be addressed before merging

@taylorsw04 Can you provide some inside here and on the TODO below?

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

packages/dds/tree/src/simple-tree/api/tree.ts

jenn-le · 2024-10-31T23:23:58Z

examples/apps/tree-cli-app/data/default.verbose.json

@@ -0,0 +1 @@
+{"type":"com.fluidframework.example.cli.List","fields":[]}


is the verbose version supposed to not have any fields?

the default tree does not have any children under this node, so yes. I have however changed the default tree to be a bit bigger so its a better example.

jenn-le · 2024-10-31T23:29:01Z

packages/dds/tree/src/simple-tree/api/tree.ts

@@ -67,6 +67,13 @@ export interface ViewableTree {
 	viewWith<TRoot extends ImplicitFieldSchema>(
 		config: TreeViewConfiguration<TRoot>,
 	): TreeView<TRoot>;
+
+	// TODO:
+	// Add stored key versions of Tree.exportVerbose, Tree.exportConcise and Tree.exportCompressed here so tree content can be accessed without a view schema.


link here for context would be good I think

I have moved these comments to the interface doc comment so they can use the link syntax. They are in privateRemarks though, so I don't think there is any way to click them, and they don't render as links in intelisense.

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

github-actions · 2024-11-01T05:24:39Z

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

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...

http://localhost:1313/docs/api/v1/protocol-definitions/
- (3127:9) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v1/protocol-definitions/itokenclaims-interface/
- (2873:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (2873:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v2/driver-definitions/
- (3602:9) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3602:9) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v2/driver-definitions/itokenclaims-interface/
- (3307:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3307:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v2/protocol-definitions/
- (3482:9) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v2/protocol-definitions/itokenclaims-interface/
- (3307:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3307:3) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)

http://localhost:1313/docs/api/v2/routerlicious-driver/itokenresponse-interface/
- (3328:8) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3341:8) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3328:8) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)
- (3341:8) 'JSON Web..' => https://jwt.io/introduction/ (connection failed)


Stats:
  440610 links
    3397 destination URLs
       2 URLs ignored
      14 warnings
       1 errors

 ELIFECYCLE  Command failed with exit code 1.

CraigMacomber and others added 30 commits July 25, 2024 12:26

Add data input and output APIs and ensureUnambiguous

0598d7d

Update packages/dds/tree/src/simple-tree/tree.ts

54f9fed

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

Update packages/dds/tree/src/simple-tree/tree.ts

7ade94e

Schema traversal cleanup and docs

b36056e

Cleanup and docs

cceedc2

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

12f2759

…to clone

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

8cd73f3

…to clone

Tidy up API and comments

d13b7c2

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

3ed5997

…to clone

implement some json interop

2e5b975

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

e9b564c

…to clone

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

8cd32d5

…to clone

fix merge, cleanup unneeded diffs

f81f235

fix old API diff

48442d8

split out and clean up verbose tree

b0abad8

Split out clone

b19530f

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

6b9d4b9

…to clone

Add independentView API

2ff695c

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

9bd4ae6

…to clone

Export via treeBeta

8677813

Fix API, add compressed apis

20443bf

Clone Progress

f580a20

CloneProgress

543a7f2

schema export

7444e75

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

f1406ed

…to clone

Use createIdCompressor

694e069

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

dac50a2

…to independentView

revert unneeded id compressor changes

6ed4f21

Fixup API

a962ad1

Cleanup missed file

2365179

CraigMacomber added 4 commits October 24, 2024 10:39

TreeAlpha

54e84f2

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

eec7c6b

…to CLI

fix build

6c4beee

Add changeset

53c2476

github-actions bot added the changeset-present label Oct 24, 2024

CraigMacomber changed the title ~~tree: Import / Export demo~~ tree: Import / Export APIs and demo Oct 24, 2024

Merge branch 'main' into CLI

1733104

CraigMacomber marked this pull request as ready for review October 24, 2024 19:25

CraigMacomber requested review from a team as code owners October 24, 2024 19:25

CraigMacomber added 2 commits October 24, 2024 14:28

update todo

32156bd

Merge branch 'main' into CLI

2252bb4

jzaffiro approved these changes Oct 25, 2024

View reviewed changes

.changeset/chubby-olives-say.md Outdated Show resolved Hide resolved

.changeset/chubby-olives-say.md Outdated Show resolved Hide resolved

.changeset/chubby-olives-say.md Outdated Show resolved Hide resolved

examples/apps/tree-cli-app/README.md Outdated Show resolved Hide resolved

CraigMacomber and others added 4 commits October 29, 2024 09:29

Apply suggestions from code review

5239016

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

Merge branch 'main' into CLI

6cb39ff

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

ad9edc0

…to CLI

Fix APi reports and const schema parameters

db3fee2

CraigMacomber requested a review from a team as a code owner October 29, 2024 20:26

CraigMacomber mentioned this pull request Oct 29, 2024

tree: Const schema type parameters, more tests tree and misc cleanups #22927

Merged

CraigMacomber added a commit that referenced this pull request Oct 29, 2024

tree: Const schema type parameters, more tests tree and misc cleanups (…

4a730a0

…#22927) ## Description A collection of minor improvements split out from #22566 for simplified and more targeted review.

CraigMacomber added 2 commits October 29, 2024 15:32

Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

2f4ec4f

…to CLI

Merge branch 'main' into CLI

59862d1

jenn-le reviewed Oct 31, 2024

View reviewed changes

CraigMacomber and others added 5 commits October 31, 2024 16:33

Apply suggestions from code review

6240458

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

Update default tree, example files and docs

d60e40e

fix comments

a46aebb

More docs

eeb4a5c

clarify TODO

a41018f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tree: Import / Export APIs and demo #22566

tree: Import / Export APIs and demo #22566

CraigMacomber commented Sep 19, 2024

jzaffiro left a comment

jenn-le Oct 31, 2024

CraigMacomber Nov 1, 2024

jenn-le Oct 31, 2024

CraigMacomber Nov 1, 2024

jenn-le Oct 31, 2024

CraigMacomber Nov 1, 2024

jenn-le Oct 31, 2024

CraigMacomber Nov 1, 2024

jenn-le Oct 31, 2024

CraigMacomber Nov 1, 2024

github-actions bot commented Nov 1, 2024

		@@ -0,0 +1 @@
		{"type":"com.fluidframework.example.cli.List","fields":[]}

tree: Import / Export APIs and demo #22566

Are you sure you want to change the base?

tree: Import / Export APIs and demo #22566

Conversation

CraigMacomber commented Sep 19, 2024

Description

Reviewer Guidance

jzaffiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 1, 2024

linkcheck output