Add Go language guide by kate-goldenring · Pull Request #77 · bytecodealliance/component-docs

kate-goldenring · 2023-09-23T00:16:21Z

Add go language guide and a description of reactor vs command components as a lot of tooling refers to the two but we haven't explicitly called out the difference anywhere

fixes #37

kate-goldenring · 2023-09-23T00:17:05Z

Currently debugging why the resultant add.component.wasm is not compatible with our example-host. I am getting:

Error: Failed to instantiate the example world

Caused by:
    0: import `wasi:io/streams` has the wrong type
    1: instance export `check-write` has the wrong type
    2: expected func found nothing

kate-goldenring · 2023-09-26T22:45:31Z

updating wasmtime version did the trick so this is ready for review

itowlson

Thanks for doing this! The spine of it is great, but reading it I sometimes felt a bit adrift. Key suggestions would be:

A bit more of a roadmap up front. We can't go directly from busting out some Go to having a component, so here are the waypoints we're going to hit.
A bit more what and why, around things like the init, SetExample stuff.

But the core story is great! So good to have this in here.

component-model/src/creating-and-consuming/authoring.md

itowlson · 2023-09-27T00:20:44Z

component-model/src/language-support/go.md

@@ -0,0 +1,89 @@
+# Go Tooling


The comment on the PR mentions you needed Wasmtime 13 for this to work. Should we state that on this section, or wait for #78 to land and rev the entire book to a Wasmtime 13-compatible toolchain? (Are there other tools will not work with Wasmtime 13 though? I am not sure what the alignment status is now the Wasmcon freeze is over.)

I think a full book rev makes sense. I think it is better than leaving at "latest dev" since that already implies Wasmtime 13 changes

component-model/src/language-support/go.md

itowlson · 2023-09-27T00:29:17Z

component-model/src/language-support/go.md

+wit-bindgen tiny-go ./add.wit -w example --out-dir=gen
+```
+
+Now, we can implement the generated `SetExample` type (in `gen/example.go`) that is exported by our component:


Is SetExample a name that wit-bindgen creates from... the -w parameter? I'm not quite sure what is happening here.

itowlson · 2023-09-27T00:30:42Z

component-model/src/language-support/go.md

+
+func init() {
+    a := AddImpl{}
+    SetExample(a)


Oh! I see! (I think.) This is a gadget wit-bindgen gives us for working around the main problem - it's like for registering your interface implementations in a reactor scenario. Something like that?

The reasoning behind using init() is to register user implementation as exported interfaces / functions.

component-model/src/language-support/go.md

component-model/examples/example-host/Cargo.toml

itowlson · 2023-09-27T01:05:49Z

component-model/src/language-support/go.md

+```go
+package main
+
+//go:generate wit-bindgen tiny-go ./add.wit -w example --out-dir=gen


This looks like the line we just ran. What is its role here?

This informs go generate what to run, so for future WIT changes, just go generate needs to be run rather than the explicit wit-bindgen command. But it probably over complicates so ill remove

component-model/src/language-support/go.md

Mossaka

This looks great to me! Thank you for your work @kate-goldenring

rylev · 2024-03-21T09:13:31Z

@kate-goldenring what's the state of this PR? Looks like at the very least it needs a rebase.

Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

kate-goldenring · 2024-04-05T19:55:16Z

@itowlson do you mind giving this another review? I broke the guide up into two sections:

a quickstart that just exports an add function
one that uses wit-bindgen to support more complex worlds
I also call out how a lot of the wasm-tools commands to componentize with be unnecessary once the wasip2 target is added.

…nterface Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

itowlson

Couple of things to sanity-check but looks good!

component-model/src/language-support/go.md

itowlson · 2024-04-07T19:30:35Z

component-model/src/language-support/go.md

+3. Convert the Wasm core module to a component using
+   []`wasm-tools`](https://github.com/bytecodealliance/wasm-tools)
+
+The next section will walk through steps 1-2, producing a core Wasm module that targets WASI preview 1.


Should we line up the ordering here - this next section is actually step 2 not step 1 I think?

I updated the guide to number the headings and added a section introducing the example world. What do you think? 2be771c

component-model/src/language-support/go.md

Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

itowlson

This is great - thank you Kate!

kate-goldenring requested a review from itowlson September 23, 2023 00:16

itowlson requested changes Sep 27, 2023

View reviewed changes

yfaming mentioned this pull request Sep 28, 2023

upgrade wasmtime and wasmtime cli options #78

Closed

kate-goldenring force-pushed the go-language-guide branch from 0dfdd32 to bb3dd4f Compare October 2, 2023 23:52

kate-goldenring mentioned this pull request Nov 16, 2023

Language Guide: Add (tiny)go #37

Closed

Mossaka approved these changes Nov 28, 2023

View reviewed changes

kate-goldenring added 2 commits April 5, 2024 10:20

Add Go language guide

4eb31f7

Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

Make Go tutorial more informative and explanatory

b7f0e46

Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

kate-goldenring force-pushed the go-language-guide branch from bb3dd4f to b023afc Compare April 5, 2024 19:53

Revamp go example with quickstart and expanded section to target an i…

6612cbc

…nterface Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

kate-goldenring force-pushed the go-language-guide branch from b023afc to 6612cbc Compare April 5, 2024 20:00

itowlson approved these changes Apr 7, 2024

View reviewed changes

Number steps in the go language guide

2be771c

Signed-off-by: Kate Goldenring <kate.goldenring@fermyon.com>

itowlson approved these changes Apr 9, 2024

View reviewed changes

kate-goldenring merged commit e209a6f into bytecodealliance:main Apr 9, 2024

kate-goldenring deleted the go-language-guide branch April 9, 2024 20:39

Conversation

kate-goldenring commented Sep 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kate-goldenring commented Sep 23, 2023

Uh oh!

kate-goldenring commented Sep 26, 2023

Uh oh!

itowlson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kate-goldenring Oct 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Mossaka left a comment

Choose a reason for hiding this comment

Uh oh!

rylev commented Mar 21, 2024

Uh oh!

kate-goldenring commented Apr 5, 2024

Uh oh!

itowlson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

itowlson left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kate-goldenring commented Sep 23, 2023 •

edited

Loading

kate-goldenring Oct 2, 2023 •

edited

Loading