-
Notifications
You must be signed in to change notification settings - Fork 251
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[wasm-metadata] add OCI description support (#1936)
- Loading branch information
1 parent
b2e621d
commit bf5854f
Showing
10 changed files
with
159 additions
and
9 deletions.
There are no files selected for viewing
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
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
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
110 changes: 110 additions & 0 deletions
110
crates/wasm-metadata/src/oci_annotations/description.rs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| use std::borrow::Cow; | ||
| use std::fmt::{self, Display}; | ||
| use std::str::FromStr; | ||
|
|
||
| use anyhow::{ensure, Error, Result}; | ||
| use serde::Serialize; | ||
| use wasm_encoder::{ComponentSection, CustomSection, Encode, Section}; | ||
| use wasmparser::CustomSectionReader; | ||
|
|
||
| /// Human-readable description of the binary | ||
| #[derive(Debug, Clone, PartialEq)] | ||
| pub struct Description(CustomSection<'static>); | ||
|
|
||
| impl Description { | ||
| /// Create a new instance of `Desrciption`. | ||
| pub fn new<S: Into<Cow<'static, str>>>(s: S) -> Self { | ||
| Self(CustomSection { | ||
| name: "description".into(), | ||
| data: match s.into() { | ||
| Cow::Borrowed(s) => Cow::Borrowed(s.as_bytes()), | ||
| Cow::Owned(s) => Cow::Owned(s.into()), | ||
| }, | ||
| }) | ||
| } | ||
|
|
||
| /// Parse an `description` custom section from a wasm binary. | ||
| pub(crate) fn parse_custom_section(reader: &CustomSectionReader<'_>) -> Result<Self> { | ||
| ensure!( | ||
| reader.name() == "description", | ||
| "The `description` custom section should have a name of 'description'" | ||
| ); | ||
| let data = String::from_utf8(reader.data().to_owned())?; | ||
| Ok(Self::new(data)) | ||
| } | ||
| } | ||
|
|
||
| impl FromStr for Description { | ||
| type Err = Error; | ||
|
|
||
| fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
| Ok(Self::new(s.to_owned())) | ||
| } | ||
| } | ||
|
|
||
| impl Serialize for Description { | ||
| fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> | ||
| where | ||
| S: serde::Serializer, | ||
| { | ||
| serializer.serialize_str(&self.to_string()) | ||
| } | ||
| } | ||
|
|
||
| impl Display for Description { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| // NOTE: this will never panic since we always guarantee the data is | ||
| // encoded as utf8, even if we internally store it as [u8]. | ||
| let data = String::from_utf8(self.0.data.to_vec()).unwrap(); | ||
| write!(f, "{data}") | ||
| } | ||
| } | ||
|
|
||
| impl ComponentSection for Description { | ||
| fn id(&self) -> u8 { | ||
| ComponentSection::id(&self.0) | ||
| } | ||
| } | ||
|
|
||
| impl Section for Description { | ||
| fn id(&self) -> u8 { | ||
| Section::id(&self.0) | ||
| } | ||
| } | ||
|
|
||
| impl Encode for Description { | ||
| fn encode(&self, sink: &mut Vec<u8>) { | ||
| self.0.encode(sink); | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
| use wasm_encoder::Component; | ||
| use wasmparser::Payload; | ||
|
|
||
| #[test] | ||
| fn roundtrip() { | ||
| let mut component = Component::new(); | ||
| component.section(&Description::new("Nori likes chicken")); | ||
| let component = component.finish(); | ||
|
|
||
| let mut parsed = false; | ||
| for section in wasmparser::Parser::new(0).parse_all(&component) { | ||
| if let Payload::CustomSection(reader) = section.unwrap() { | ||
| let description = Description::parse_custom_section(&reader).unwrap(); | ||
| assert_eq!(description.to_string(), "Nori likes chicken"); | ||
| parsed = true; | ||
| } | ||
| } | ||
| assert!(parsed); | ||
| } | ||
|
|
||
| #[test] | ||
| fn serialize() { | ||
| let description = Description::new("Chashu likes tuna"); | ||
| let json = serde_json::to_string(&description).unwrap(); | ||
| assert_eq!(r#""Chashu likes tuna""#, json); | ||
| } | ||
| } |
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
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
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
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
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
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