chore: doc interpreter #607
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zeeshanlakhani
force-pushed
the
zl/wit-to-ipld-schema
branch
from
e918d7b
to
c82b66c
Compare
This PR contains a spec/document for the WIT<->IPLD interpreter, which converts WIT runtime values to IPLD data model values based on WIT types. Consider this a living document on the state of the interpreter. Includes: - added testing - function name handling of varying cases
zeeshanlakhani
force-pushed
the
zl/wit-to-ipld-schema
branch
from
c82b66c
to
824c1a0
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #607 +/- ##
==========================================
+ Coverage 69.17% 69.47% +0.30%
==========================================
Files 95 95
Lines 12953 13082 +129
==========================================
+ Hits 8960 9089 +129
Misses 3993 3993
|
bgins
approved these changes
Mar 7, 2024
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
bgins
reviewed
Mar 8, 2024
good catch Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Co-authored-by: Brian Ginsburg <[email protected]> Signed-off-by: Zeeshan Lakhani <[email protected]>
Merged
bgins
pushed a commit
that referenced
this pull request
Mar 13, 2024
## 🤖 New release * `homestar-runtime`: 0.2.0 -> 0.3.0 (⚠️ API breaking changes) * `homestar-invocation`: 0.2.0 -> 0.3.0 (⚠️ API breaking changes) * `homestar-wasm`: 0.2.0 -> 0.3.0 (⚠️ API breaking changes) * `homestar-workflow`: 0.2.0 -> 0.3.0 (✓ API compatible changes) ###⚠️ `homestar-runtime` breaking changes ``` --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.29.1/src/lints/enum_variant_added.ron Failed in: variant Command:Init in /tmp/.tmpgzntbb/homestar/homestar-runtime/src/cli.rs:152 ``` ###⚠️ `homestar-invocation` breaking changes ``` --- failure enum_tuple_variant_field_added: pub enum tuple variant field added --- Description: An enum's exhaustive tuple variant has a new field, which has to be included when constructing or matching on this variant. ref: https://doc.rust-lang.org/reference/attributes/type_system.html#the-non_exhaustive-attribute impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.29.1/src/lints/enum_tuple_variant_field_added.ron Failed in: field 1 of variant Nonce::Nonce96 in /tmp/.tmpgzntbb/homestar/homestar-invocation/src/task/instruction/nonce.rs:39 field 1 of variant Nonce::Nonce128 in /tmp/.tmpgzntbb/homestar/homestar-invocation/src/task/instruction/nonce.rs:41 --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.29.1/src/lints/enum_variant_added.ron Failed in: variant Error:FromMultibase in /tmp/.tmpgzntbb/homestar/homestar-invocation/src/error.rs:38 variant Error:FromMultibase in /tmp/.tmpgzntbb/homestar/homestar-invocation/src/error.rs:38 ``` ###⚠️ `homestar-wasm` breaking changes ``` --- failure auto_trait_impl_removed: auto trait no longer implemented --- Description: A public type has stopped implementing one or more auto traits. This can break downstream code that depends on the traits being implemented. ref: https://doc.rust-lang.org/reference/special-types-and-traits.html#auto-traits impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.29.1/src/lints/auto_trait_impl_removed.ron Failed in: type State is no longer Sync, in /tmp/.tmpgzntbb/homestar/homestar-wasm/src/wasmtime/world.rs:41 type State is no longer Sync, in /tmp/.tmpgzntbb/homestar/homestar-wasm/src/wasmtime/world.rs:41 --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.29.1/src/lints/enum_variant_missing.ron Failed in: variant InterpreterError::MapType, previously in file /tmp/.tmpEeUFOH/homestar-wasm/src/error.rs:36 ``` <details><summary><i><b>Changelog</b></i></summary><p> ## `homestar-runtime` <blockquote> ## [0.3.0](homestar-runtime-v0.2.0...homestar-runtime-v0.3.0) - 2024-03-13 ### Added - log the creation of the key file in `init` - default `key-file` path to output directory - support generating PEM encoded ed25519 keys from `init` - translate `InquireError` to `miette::Result` in `init` - recursively create config directory on `init` - output a cleaner error when an invalid seed is passed to `init` - support configuring key using `init` command - run `init` command non-interactively if a TTY isn't detected - add `--no-input` to `init` command - add `--force` to `init` command for forcing destructive operations - add `--quiet` flag to `init` command - support `--dry-run` for `init` command - add `init` command for initializing a settings file - load settings from a well-known config file - finish interpreter ([#595](#595)) ### Fixed - cleanup empty key file when bailing out of generating secp256k1 - parse ed25519 keys using the old strategy as a fallback - use `ed25519-dalek` for parsing PEM-encoded PKCS[#8](#8) ed25519 keys - only constrain `inquire` and `derive_builder` by minor version - hide `IpfsSettings` behind "ipfs" feature - set `truncate(true)` when forcefully overwriting the config - Update nonce schema with IPLD bytes ([#593](#593)) ### Other - Add workflow spans and every cli logging ([#603](#603)) - *(schemas)* update OpenRPC API doc and JSON schemas - handle nonce as incoming string/arraybuf ([#611](#611)) - [chore(cargo)](deps): Bump toml from 0.8.10 to 0.8.11 ([#612](#612)) - document that a random seed will be chosen if `key-seed` is unset - document that if unset, a default path is used with `key-file` - update help text for `key-file` to say it'll generate a key - prompt for the key file as a `String` instead of `PathBuf` - add a test for writing the generated config file + key - split `force` field out of `OutputMode::File` - remove `KeyTypeArg` in favor of using `KeyType` - remove unneeded `defaults.toml` - add simple tests for `init` command - remove out of date TODO in `init.rs` - remove unneeded `#[allow(dead_code)]` in `settings.rs` - wrap all `init` args in `InitArgs` and consolidate handling - sort imports in `cli/init.rs` - remove docs link to private `homestar_runtime::db::pool` - improve error for passing `--no-input` to `init` with no key - remove extraneous `...` destructuring of `Command::Init` - change `--config` flag to `--output` for `init` command - move handling of `init` command to `init.rs` - fix comments listing supported public key types - *(schemas)* update OpenRPC API doc and JSON schemas - *(schemas)* update OpenRPC API doc and JSON schemas - poll DHT in background when worker runs up a workflow + dual-stack webserver ([#590](#590)) - [chore(cargo)](deps): Bump config from 0.13.4 to 0.14.0 ([#588](#588)) - [chore(cargo)](deps): Bump nix from 0.27.1 to 0.28.0 ([#587](#587)) </blockquote> ## `homestar-invocation` <blockquote> ## [0.3.0](homestar-invocation-v0.2.0...homestar-invocation-v0.3.0) - 2024-03-13 ### Added - finish interpreter ([#595](#595)) ### Fixed - Update nonce schema with IPLD bytes ([#593](#593)) ### Other - handle nonce as incoming string/arraybuf ([#611](#611)) - test json/ipld/nonce ([#610](#610)) - poll DHT in background when worker runs up a workflow + dual-stack webserver ([#590](#590)) </blockquote> ## `homestar-wasm` <blockquote> ## [0.3.0](homestar-wasm-v0.2.0...homestar-wasm-v0.3.0) - 2024-03-13 ### Added - finish interpreter ([#595](#595)) ### Other - Add workflow spans and every cli logging ([#603](#603)) - handle incoming as Wit integer, but argument is float ([#609](#609)) - handle ref/non-ref case with rigor ([#608](#608)) - doc interpreter ([#607](#607)) - poll DHT in background when worker runs up a workflow + dual-stack webserver ([#590](#590)) - wasmtime 17->18 ([#585](#585)) </blockquote> ## `homestar-workflow` <blockquote> ## [0.3.0](homestar-workflow-v0.2.0...homestar-workflow-v0.3.0) - 2024-03-13 ### Other - handle nonce as incoming string/arraybuf ([#611](#611)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Signed-off-by: release-plz-ipvm-wg[bot] <144082651+release-plz-ipvm-wg[bot]@users.noreply.github.com> Co-authored-by: release-plz-ipvm-wg[bot] <144082651+release-plz-ipvm-wg[bot]@users.noreply.github.com> Co-authored-by: release-plz-ipvm-wg[bot] <release-plz-ipvm-wg[bot]@users.noreply.github.com>
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR contains a spec/document for the WIT<->IPLD interpreter, which converts WIT runtime values to IPLD data model values based on WIT types. Consider this a living document on the state of the interpreter.
Includes: