feat(isolatedwit): Moving the adder wit to a separate package. #136

ritesh089 · 2024-05-09T15:22:32Z

This PR updates the tutorial example that shows that components can be built with their own wit and then composed together with another parent component.

This PR is based on the feedback provided by @kate-goldenring on
#135

itowlson · 2024-05-09T20:44:55Z

component-model/src/tutorial.md

@@ -133,7 +145,7 @@ Now it all adds up! Run the final component with the `wasmtime` CLI, ensuring yo
 the `wasmtime` command line do not include component model support.

 ```sh
-wasmtime run final.wasm 1 2 add
+wasmtime run command.wasm 1 2 add


We are still creating final.wasm on line 134... is that no longer used? Doesn't command.wasm have unsatisfied imports at this point?

I meant to overwrite command.wasm. But I missed updating line 134 .
I think it is better to leave it as final.wasm. Will update soon.

Updated . @itowlson

component-model/src/tutorial.md

itowlson · 2024-05-09T20:58:45Z

component-model/src/tutorial.md

-    }
-    eval-expression: func(op: op, x: u32, y: u32) -> u32;
-}
+//adder/wit/world.wit


Provide more intro here. This now goes from a paragraph talking about the "calculate" interface/world to a WIT that is just the adder interface/world. E.g. // WIT for the "adder" world - see <file path>, or a bridging paragraph.

Or break up the "these files" define section into e..g

The "adder" file defines:

(list of bullets)

... WIT WIT WIT ...

The "calculator" file defines:

(list of bullets)

... WIT WIT WIT ...

(I'm not sure which approach will work best - we may need to experiment a bit!)

I added description for the adder with separately. please let me know if this works . @itowlson

Yep, that works - thanks @ritesh089!

itowlson · 2024-05-09T21:00:48Z

component-model/src/tutorial.md


 world calculator {
    export calculate;
-    import add;
+    import docs:adder/add;


This adds a new concept of cross-package references. Do we need to explain that here? It feels like it complicates the tutorial, but as a reader I would have questions given that these world have supposedly come from different sources. Maybe a forward reference is enough?

I think cross package reference example is very much required. Because the real use cases for most teams to use component model will be to build components independently and compose them later as and when required.
I felt that was missing in the example and documentation. which was the main reason for me to create a separate repo which my team used to understand this concept.
I did not understand the forward reference part .

By "forward reference" I mean a link to a section of the documentation that explains it (rather than explaining it in the tutorial itself).

Based on our discussion, the scope of this PR will not be to update the language reference.

itowlson · 2024-05-09T21:02:37Z

component-model/src/tutorial.md

@@ -67,14 +74,14 @@ world app {

 Reference the [language guide](language-support.md) and [authoring components


Are the language guides going to need any update to reflect that we now have two WIT packages/files in play?

I kept the scope of this PR to the tutorial section. The language reference doesn't use this tutorial as a link reference , but I do see some differences.
Do you want me to update that in another PR ? Or you prefer all the changes in one PR here itself?

If the language guide is general guidance and not tied to the tutorial files layout, then there is no need to change it.

itowlson · 2024-05-09T21:02:51Z

component-model/src/tutorial.md

@@ -67,14 +74,14 @@ world app {

 Reference the [language guide](language-support.md) and [authoring components
 documentation](creating-and-consuming/authoring.md) to create a component that implements the
-`adder` world of `calculator.wit`. For reference, see the completed
+`adder` world of `adder/wit/world.wit`. For reference, see the completed
 [example](https://github.com/bytecodealliance/component-docs/tree/main/component-model/examples/tutorial/adder/).

 ## Create a `calculator` component

 Reference the [language guide](language-support.md) and [authoring components


Again, any updates needed to the language guides?

I am a bit confused about this.
@kate-goldenring asked me to keep the scope minimal. I am not sure if I should update the language guide.
Can you please confirm?

Per the other thread (#136 (comment)), if the language guide is general guidance and not tied to the tutorial files layout, then there is no need to change it.

@kate-goldenring @itowlson , Did you get a chance to review this PR?
What are the next steps?

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

component-model/src/tutorial.md

component-model/examples/tutorial/adder/wit/world.wit

component-model/examples/tutorial/command/Cargo.toml

kate-goldenring · 2024-05-10T17:53:57Z

component-model/examples/tutorial/command/Cargo.toml

-package = "docs:calculator"
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]


Any reason for the reordering here?

I changed the package name to command to show that these components can be isolated in their own packages. Do you prefer to keep the package "docs:calculator"? @kate-goldenring

component-model/examples/tutorial/command/src/main.rs

component-model/examples/tutorial/wit/calculator.wit

component-model/src/tutorial.md

itowlson

This looks okay to me - thanks @ritesh089 for working through all the discussion! Holding for @kate-goldenring who knows the tutorial pages better than I do!

kate-goldenring

Thank you @ritesh089. I tested everything locally and it looks good. Some small nits to finish cleaning up the WIT paths but LGTM

component-model/src/tutorial.md

Co-authored-by: Kate Goldenring <[email protected]>

ritesh089 and others added 2 commits May 8, 2024 23:13

feat(isolatedwit): Moving the adder wit to a separate package

95a6fa2

Merge branch 'main' into feature/isolatedwit

50987c2

itowlson reviewed May 9, 2024

View reviewed changes

Update component-model/src/tutorial.md

515661a

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

kate-goldenring reviewed May 10, 2024

View reviewed changes

macovedj mentioned this pull request May 13, 2024

Registry tooling and wac #129

Open

feat(wit): Moving wit outside the packages

d810c35

itowlson approved these changes May 23, 2024

View reviewed changes

kate-goldenring approved these changes May 28, 2024

View reviewed changes

ritesh089 and others added 5 commits May 28, 2024 10:17

Update component-model/src/tutorial.md

ceda489

Co-authored-by: Kate Goldenring <[email protected]>

Update component-model/src/tutorial.md

a45c4d4

Co-authored-by: Kate Goldenring <[email protected]>

Update component-model/src/tutorial.md

8d173c2

Co-authored-by: Kate Goldenring <[email protected]>

Update component-model/src/tutorial.md

0b75a71

Co-authored-by: Kate Goldenring <[email protected]>

Update component-model/src/tutorial.md

4ebfc44

Co-authored-by: Kate Goldenring <[email protected]>

kate-goldenring merged commit a755690 into bytecodealliance:main May 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(isolatedwit): Moving the adder wit to a separate package. #136

feat(isolatedwit): Moving the adder wit to a separate package. #136

ritesh089 commented May 9, 2024 •

edited

Loading

itowlson May 9, 2024

ritesh089 May 9, 2024

ritesh089 May 20, 2024

itowlson May 9, 2024

ritesh089 May 20, 2024

itowlson May 20, 2024

itowlson May 9, 2024

ritesh089 May 9, 2024 •

edited

Loading

itowlson May 9, 2024

ritesh089 May 20, 2024

itowlson May 9, 2024

ritesh089 May 9, 2024

itowlson May 9, 2024

itowlson May 9, 2024

ritesh089 May 15, 2024

itowlson May 15, 2024

ritesh089 May 20, 2024

ritesh089 May 23, 2024

kate-goldenring May 10, 2024

ritesh089 May 20, 2024

itowlson left a comment

kate-goldenring left a comment

		@@ -67,14 +74,14 @@ world app {

		Reference the [language guide](language-support.md) and [authoring components

feat(isolatedwit): Moving the adder wit to a separate package. #136

feat(isolatedwit): Moving the adder wit to a separate package. #136

Conversation

ritesh089 commented May 9, 2024 • edited Loading

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

ritesh089 May 9, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itowlson left a comment

Choose a reason for hiding this comment

kate-goldenring left a comment

Choose a reason for hiding this comment

ritesh089 commented May 9, 2024 •

edited

Loading

ritesh089 May 9, 2024 •

edited

Loading