feat: create the RuntimeMetadata and Repository structs. Refactor Runtimes

src/main.rs

@@ -7,6 +7,7 @@ extern crate lazy_static;
 mod config;
 mod data;
 mod router;
+mod runtimes;
 mod workers;
 
 use actix_files::{Files, NamedFile};

src/runtimes/metadata.rs

@@ -0,0 +1,59 @@
+// Copyright 2022 VMware, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+use super::runtime::RuntimeStatus;
+use anyhow::{anyhow, Result};
+use serde::Deserialize;
+use std::collections::HashMap;
+
+// TODO: Remove it when implementing the manager
+#[allow(dead_code)]
+/// Metadata associated to a Runtime. It contains information
+/// about a certain runtime like name, version and all the
+/// details to run workers with it.
+///
+/// A runtime is a Wasm binary + configuration that can run
+/// a source code as a worker. The configuration includes
+/// different pieces like polyfills files, templates,
+/// arguments, etc.
+#[derive(Deserialize)]
+pub struct RuntimeMetadata<'a> {
+    /// Name of the runtime (like ruby, python, etc)
+    name: &'a str,
+    /// Specific version of the runtime
+    version: &'a str,
+    /// Current status in the repository
+    status: RuntimeStatus,
+    /// Associated extensions
+    extensions: Vec<&'a str>,
+    /// Arguments to pass to the Wasm module via WASI
+    args: Vec<&'a str>,
+    /// A list of environment variables that must be configured
+    /// for the runtime to work.
+    envs: Option<HashMap<&'a str, &'a str>>,
+    /// The URL to pull the module binary
+    binary: &'a str,
+    /// The checksum to validate the given binary (SHA256)
+    binary_checksum: &'a str,
+    /// The URL to a polyfill file
+    polyfill: Option<&'a str>,
+    /// The checksum to validate the given polyfill file (SHA256)
+    polyfill_polyfill: Option<&'a str>,
+    /// The URL to a template file for the worker. It will wrap the
+    /// source code into a template that can include imports,
+    /// function calls, etc.
+    template: Option<&'a str>,
+    /// The checksum to validate the given template file (SHA256)
+    template_polyfill: Option<&'a str>,
+}
+
+// TODO: Remove it when implementing the manager
+#[allow(dead_code)]
+impl<'a> RuntimeMetadata<'a> {
+    /// Reads and parses the metadata from a slice of bytes. It will return
+    /// a result as the deserialization may fail.
+    pub fn from_slice(data: &'a [u8]) -> Result<Self> {
+        toml::from_slice::<RuntimeMetadata>(data)
+            .map_err(|_| anyhow!("wws could not deserialize the runtime metadata"))
+    }
+}

src/runtimes/mod.rs

@@ -0,0 +1,7 @@
+// Copyright 2022 VMware, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+mod metadata;
+mod modules;
+mod repository;
+pub mod runtime;

src/workers/runtimes/javascript.rs → src/runtimes/modules/javascript.rs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use super::data::Data;
-use crate::workers::runtime::Runtime;
+use crate::runtimes::runtime::Runtime;
 use anyhow::Result;
 use std::{fs, path::PathBuf};
 use wasmtime_wasi::Dir;

src/workers/runtimes/native.rs → src/runtimes/modules/native.rs

@@ -1,7 +1,7 @@
 // Copyright 2022 VMware, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::workers::runtime::Runtime;
+use crate::runtimes::runtime::Runtime;
 use anyhow::Result;
 use std::{fs, path::PathBuf};
 

src/runtimes/repository.rs

@@ -0,0 +1,34 @@
+// Copyright 2022 VMware, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+use super::metadata::RuntimeMetadata;
+use anyhow::{anyhow, Result};
+use serde::Deserialize;
+
+// TODO: Remove it when implementing the manager
+#[allow(dead_code)]
+/// A Repository contains the list of runtimes available on it.
+/// This file is used by wws to properly show the list of available
+/// repos and install them.
+///
+/// By default, this repository class rely on the [WebAssembly Language Runtimes](https://github.com/vmware-labs/webassembly-language-runtimes)
+/// repository. It looks for a repository.toml file in the Git repo.
+#[derive(Deserialize)]
+pub struct Repository<'a> {
+    /// Version of the repository file
+    version: u32,
+    /// The list of runtimes available in the repository
+    #[serde(borrow)]
+    runtimes: Vec<RuntimeMetadata<'a>>,
+}
+
+// TODO: Remove it when implementing the manager
+#[allow(dead_code)]
+impl<'a> Repository<'a> {
+    /// Reads and parses the metadata from a slice of bytes. It will return
+    /// a result as the deserialization may fail.
+    pub fn from_slice(data: &'a [u8]) -> Result<Self> {
+        toml::from_slice::<Repository>(data)
+            .map_err(|_| anyhow!("wws could not deserialize the repository metadata"))
+    }
+}

src/workers/runtime.rs → src/runtimes/runtime.rs

@@ -1,11 +1,34 @@
 // Copyright 2022 VMware, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-use super::runtimes::{javascript::JavaScriptRuntime, native::NativeRuntime};
+use super::modules::{javascript::JavaScriptRuntime, native::NativeRuntime};
 use anyhow::{anyhow, Result};
+use serde::Deserialize;
 use std::path::Path;
 use wasmtime_wasi::WasiCtxBuilder;
 
+/// Define the status of a runtime in a target repository
+#[derive(Deserialize)]
+pub enum RuntimeStatus {
+    Active,
+    Yanked,
+    Deprecated,
+    Unknown,
+}
+
+impl From<&str> for RuntimeStatus {
+    /// Create a RuntimeStatus variant from a &str. It uses predefined
+    /// values
+    fn from(value: &str) -> Self {
+        match value {
+            "active" => RuntimeStatus::Active,
+            "yanked" => RuntimeStatus::Yanked,
+            "deprecated" => RuntimeStatus::Deprecated,
+            _ => RuntimeStatus::Unknown,
+        }
+    }
+}
+
 /// Define the behavior a Runtime must have. This includes methods
 /// to initialize the environment for the given runtime as well as
 /// the Wasi Context to process the request.

src/workers/mod.rs

@@ -1,8 +1,6 @@
 // Copyright 2022 VMware, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-mod runtime;
-mod runtimes;
 pub mod wasm_io;
 mod worker;
 

src/workers/worker.rs

@@ -1,10 +1,8 @@
 // Copyright 2022 VMware, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-use super::{
-    runtime::{init_runtime, Runtime},
-    wasm_io::{WasmInput, WasmOutput},
-};
+use super::wasm_io::{WasmInput, WasmOutput};
+use crate::runtimes::runtime::{init_runtime, Runtime};
 use actix_web::HttpRequest;
 use anyhow::Result;
 use std::{collections::HashMap, path::Path};