Merge pull request #1906 from itowlson/free-the-locked-app-one-again

Decouple LockedApp schema from `spin-core`

Author: itowlson

Cargo.lock

@@ -54,6 +54,7 @@ spin-doctor = { path = "crates/doctor" }
 spin-http = { path = "crates/http" }
 spin-trigger-http = { path = "crates/trigger-http" }
 spin-loader = { path = "crates/loader" }
+spin-locked-app = { path = "crates/locked-app" }
 spin-manifest = { path = "crates/manifest" }
 spin-oci = { path = "crates/oci" }
 spin-plugins = { path = "crates/plugins" }

Cargo.toml

@@ -11,5 +11,6 @@ ouroboros = "0.18.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 spin-core = { path = "../core" }
+spin-locked-app = { path = "../locked-app" }
 spin-serde = { path = "../serde" }
 thiserror = "1.0"

crates/app/Cargo.toml

@@ -7,22 +7,21 @@
 #![deny(missing_docs)]
 
 mod host_component;
-pub mod locked;
-mod metadata;
-pub mod values;
+pub use spin_locked_app::locked;
+pub use spin_locked_app::values;
+pub use spin_locked_app::{Error, MetadataKey, Result};
 
 use ouroboros::self_referencing;
 use serde::Deserialize;
 use spin_core::{wasmtime, Engine, EngineBuilder, HostComponentDataHandle, StoreBuilder};
 
 use host_component::DynamicHostComponents;
 use locked::{ContentPath, LockedApp, LockedComponent, LockedComponentSource, LockedTrigger};
-use metadata::MetadataExt;
+use spin_locked_app::MetadataExt;
 
 pub use async_trait::async_trait;
 pub use host_component::DynamicHostComponent;
 pub use locked::Variable;
-pub use metadata::MetadataKey;
 
 /// MetadataKey for extracting the application name.
 pub const APP_NAME_KEY: MetadataKey = MetadataKey::new("name");
@@ -397,29 +396,3 @@ impl<'a, L: MaybeLoader> AppTrigger<'a, L> {
 struct CommonTriggerConfig {
     component: Option<String>,
 }
-
-/// Type alias for a [`Result`]s with [`Error`].
-pub type Result<T> = std::result::Result<T, Error>;
-
-/// Errors returned by methods in this crate.
-#[derive(Debug, thiserror::Error)]
-pub enum Error {
-    /// An error propagated from the [`spin_core`] crate.
-    #[error("spin core error: {0:#}")]
-    CoreError(#[source] anyhow::Error),
-    /// An error from a [`DynamicHostComponent`].
-    #[error("host component error: {0:#}")]
-    HostComponentError(#[source] anyhow::Error),
-    /// An error from a [`Loader`] implementation.
-    #[error(transparent)]
-    LoaderError(anyhow::Error),
-    /// An error indicating missing or unexpected metadata.
-    #[error("metadata error: {0}")]
-    MetadataError(String),
-    /// An error indicating failed JSON (de)serialization.
-    #[error("json error: {0}")]
-    JsonError(#[from] serde_json::Error),
-    /// A validation error that can be presented directly to the user.
-    #[error(transparent)]
-    ValidationError(anyhow::Error),
-}

crates/app/src/lib.rs

@@ -24,7 +24,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 sha2 = "0.10.8"
 shellexpand = "3.1"
-spin-app = { path = "../app" }
+spin-locked-app = { path = "../locked-app" }
 spin-common = { path = "../common" }
 spin-config = { path = "../config" }
 spin-manifest = { path = "../manifest" }

crates/loader/Cargo.toml

@@ -14,8 +14,8 @@ use std::path::{Path, PathBuf};
 
 use anyhow::Result;
 use local::LocalLoader;
-use spin_app::locked::LockedApp;
 use spin_common::paths::parent_dir;
+use spin_locked_app::locked::LockedApp;
 
 pub mod cache;
 mod http;

crates/loader/src/lib.rs

@@ -3,14 +3,14 @@ use std::path::{Path, PathBuf};
 use anyhow::{bail, ensure, Context, Result};
 use futures::future::try_join_all;
 use reqwest::Url;
-use spin_app::{
+use spin_common::paths::parent_dir;
+use spin_locked_app::{
     locked::{
         self, ContentPath, ContentRef, LockedApp, LockedComponent, LockedComponentSource,
         LockedTrigger,
     },
     values::{ValuesMap, ValuesMapBuilder},
 };
-use spin_common::paths::parent_dir;
 use spin_manifest::schema::v2::{self, AppManifest, KebabId, WasiFilesMount};
 use tokio::{fs, sync::Semaphore};
 

crates/loader/src/local.rs

@@ -0,0 +1,14 @@
+[package]
+name = "spin-locked-app"
+version = { workspace = true }
+authors = { workspace = true }
+edition = { workspace = true }
+
+[dependencies]
+anyhow = "1.0"
+async-trait = "0.1"
+ouroboros = "0.18.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+spin-serde = { path = "../serde" }
+thiserror = "1.0"

crates/locked-app/Cargo.toml

@@ -0,0 +1,50 @@
+//! Spin internal application interfaces
+//!
+//! This crate contains interfaces to Spin application configuration to be used
+//! by crates that implement Spin execution environments: trigger executors and
+//! host components, in particular.
+
+#![deny(missing_docs)]
+
+pub mod locked;
+mod metadata;
+pub mod values;
+
+pub use async_trait::async_trait;
+pub use locked::Variable;
+pub use metadata::{MetadataExt, MetadataKey};
+
+/// MetadataKey for extracting the application name.
+pub const APP_NAME_KEY: MetadataKey = MetadataKey::new("name");
+/// MetadataKey for extracting the application version.
+pub const APP_VERSION_KEY: MetadataKey = MetadataKey::new("version");
+/// MetadataKey for extracting the application description.
+pub const APP_DESCRIPTION_KEY: MetadataKey = MetadataKey::new("description");
+/// MetadataKey for extracting the OCI image digest.
+pub const OCI_IMAGE_DIGEST_KEY: MetadataKey = MetadataKey::new("oci_image_digest");
+
+/// Type alias for a [`Result`]s with [`Error`].
+pub type Result<T> = std::result::Result<T, Error>;
+
+/// Errors returned by methods in this crate.
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    /// An error propagated from the [`spin_core`] crate.
+    #[error(transparent)]
+    CoreError(anyhow::Error),
+    /// An error from a [`DynamicHostComponent`].
+    #[error("host component error: {0:#}")]
+    HostComponentError(#[source] anyhow::Error),
+    /// An error from a [`Loader`] implementation.
+    #[error(transparent)]
+    LoaderError(anyhow::Error),
+    /// An error indicating missing or unexpected metadata.
+    #[error("metadata error: {0}")]
+    MetadataError(String),
+    /// An error indicating failed JSON (de)serialization.
+    #[error("json error: {0}")]
+    JsonError(#[from] serde_json::Error),
+    /// A validation error that can be presented directly to the user.
+    #[error(transparent)]
+    ValidationError(anyhow::Error),
+}