Yaml2json types #95
Merged
Yaml2json types #95
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
bitdivine
commented
Jun 9, 2024
| @@ -67,8 +84,8 @@ impl Yaml2Candid { | |||
| /// * YAML types do not match the IDL types. | |||
| /// * `type_name` is not defined in the converter's `.did` file. | |||
| pub fn convert(&self, typ: &IDLType, data: &YamlValue) -> anyhow::Result<IDLValue> { | |||
There was a problem hiding this comment.
Here the match includes just the Candid type, so that the compiler will complain if there are any unsupported Candid types.
Below many types that were previously unsupported have been added.
|
|
||
| /// Converts YAML to Candid using a given did file. | ||
| pub struct Yaml2Candid { | ||
| /// The types that the converter supports, defined in an IDLProg interface definition. | ||
| pub prog: IDLProg, | ||
| } | ||
| impl Default for Yaml2Candid { |
There was a problem hiding this comment.
Simple default constructor needed for tests. Included here as it may have more uses.
| num-bigint = { workspace = true } | ||
|
|
||
| [dev-dependencies] | ||
| pretty_assertions = "1.4.0" |
There was a problem hiding this comment.
Provides a pretty diff in assert_eq!() errors. This makes debugging much easier.
| @@ -16,3 +16,4 @@ version = "0.10.1" | |||
| [workspace.dependencies] | |||
| candid = { version = "0.10.8" } | |||
| candid_parser = { version = "0.1.0" } | |||
| num-bigint = { version = "0.4.5" } | |||
There was a problem hiding this comment.
Needed when converting BigNum types.
| @@ -1,60 +1,60 @@ | |||
| record { | |||
There was a problem hiding this comment.
In the .did file, many fields below are optional. I believe that, strictly speaking, they should therefore be opt even if parsers might accept either.
bitdivine
requested review from
ninegua and
chenyan-dfinity
and removed request for
a team
chenyan-dfinity
approved these changes
Jul 10, 2024
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.
Motivation
yaml2candidis very incomplete and still in some places buggy. Specifically, it does not support many Candid types and the opt test vectors (and implementation that was guided by those test vectors) are wrong.Changes
yaml2jsontype match so that the compiler will complain when not all types are matched.optin the candid.Tests
TODO in future