refactor: move secrets and metadata plugins to runtime (#1673)

* refactor: move secrets and metadata plugins to runtime

* feat: impl config::Source for SecretStore

* ci: skip crates

* fix lock

* Revert "feat: impl config::Source for SecretStore"

This reverts commit 7442c24.

* fix docs

* fix: deprecation warnings

* bump examples

* fix

* fix serenity

* nit

* bump examples

* fix serenity

* fix rocket doc test

* bump examples

* bump examples

Author: jonaro00

.circleci/config.yml

@@ -631,10 +631,8 @@ workflows:
             parameters:
               path:
                 - resources/aws-rds
-                - resources/metadata
                 - resources/persist
                 - resources/qdrant
-                - resources/secrets
                 - resources/shared-db
                 - resources/turso
                 - resources/opendal

cargo-shuttle/src/lib.rs

@@ -443,7 +443,8 @@ impl Shuttle {
                 } else {
                     get_templates_schema()
                         .await
-                        .map_err(|_| {
+                        .map_err(|e| {
+                            error!(err = %e, "Failed to get templates");
                             println!(
                                 "{}",
                                 "Failed to look up template list. Falling back to internal list."

codegen/src/lib.rs

@@ -26,7 +26,7 @@ mod shuttle_main;
 /// | `ShuttlePoem`     | [shuttle-poem](https://crates.io/crates/shuttle-poem)          | [poem](https://docs.rs/poem/2.0)                                                 | 2.0        | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/poem/hello-world)     |
 /// | `ShuttleRocket`   | [shuttle-rocket](https://crates.io/crates/shuttle-rocket)      | [rocket](https://docs.rs/rocket/0.5)                                             | 0.5        | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/rocket/hello-world)   |
 /// | `ShuttleSalvo`    | [shuttle-salvo](https://crates.io/crates/shuttle-salvo)        | [salvo](https://docs.rs/salvo/0.63)                                              | 0.63       | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/salvo/hello-world)    |
-/// | `ShuttleSerenity` | [shuttle-serenity](https://crates.io/crates/shuttle-serenity   | [serenity](https://docs.rs/serenity/0.12) and [poise](https://docs.rs/poise/0.6) | 0.12       | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/serenity/hello-world) |
+/// | `ShuttleSerenity` | [shuttle-serenity](https://crates.io/crates/shuttle-serenity)  | [serenity](https://docs.rs/serenity/0.12) and [poise](https://docs.rs/poise/0.6) | 0.12       | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/serenity/hello-world) |
 /// | `ShuttleThruster` | [shuttle-thruster](https://crates.io/crates/shuttle-thruster)  | [thruster](https://docs.rs/thruster/1.3)                                         | 1.3        | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/thruster/hello-world) |
 /// | `ShuttleTower`    | [shuttle-tower](https://crates.io/crates/shuttle-tower)        | [tower](https://docs.rs/tower/0.4)                                               | 0.4        | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/tower/hello-world)    |
 /// | `ShuttleTide`     | [shuttle-tide](https://crates.io/crates/shuttle-tide)          | [tide](https://docs.rs/tide/0.16)                                                | 0.16       | [GitHub](https://github.com/shuttle-hq/shuttle-examples/tree/main/tide/hello-world)     |

common/src/resource.rs

@@ -56,10 +56,10 @@ pub struct Response {
     /// The type of this resource.
     pub r#type: Type,
 
-    /// The config used when creating this resource. Use the [Self::r#type] to know how to parse this data.
+    /// The config used when creating this resource. Use the `r#type` to know how to parse this data.
     pub config: Value,
 
-    /// The data associated with this resource. Use the [Self::r#type] to know how to parse this data.
+    /// The data associated with this resource. Use the `r#type` to know how to parse this data.
     pub data: Value,
 }
 

common/src/secrets.rs

@@ -4,7 +4,7 @@ use zeroize::Zeroize;
 
 /// Wrapper type for secret values such as passwords or authentication keys.
 ///
-/// Once wrapped, the inner value cannot leak accidentally, as both the [`Display`] and [`Debug`]
+/// Once wrapped, the inner value cannot leak accidentally, as both the [`std::fmt::Display`] and [`Debug`]
 /// implementations cover up the actual value and only show the type.
 ///
 /// If you need access to the inner value, there is an [expose](`Secret::expose`) method.

examples

@@ -8,4 +8,4 @@ keywords = ["shuttle-service", "metadata"]
 
 [dependencies]
 async-trait = "0.1.56"
-shuttle-service = { path = "../../service", version = "0.41.0" }
+shuttle-service = { path = "../../service", version = "<=0.44.0" }

resources/metadata/Cargo.toml

@@ -1,22 +1,3 @@
 # Shuttle Metadata
 
-This plugin allows applications to obtain certain information about their runtime environment.
-
-## Usage
-
-Add `shuttle-metadata` to the dependencies for your service.
-
-You can get this resource using the `shuttle_metadata::ShuttleMetadata` attribute to get a `Metadata`. This struct will contain information such as the Shuttle service name.
-
-```rust
-#[shuttle_runtime::main]
-async fn app(
-    #[shuttle_metadata::ShuttleMetadata] metadata: shuttle_metadata::Metadata,
-) -> __ { ... }
-```
-
-#### Example projects that use `shuttle-metadata`
-
-| Framework | Link                                                                                   |
-| --------- | -------------------------------------------------------------------------------------- |
-| Axum      | [axum example](https://github.com/shuttle-hq/shuttle-examples/tree/main/axum/metadata) |
+This plugin has been moved to [shuttle-runtime](https://crates.io/crates/shuttle-runtime).

resources/metadata/README.md

@@ -3,6 +3,10 @@ pub use shuttle_service::{DeploymentMetadata as Metadata, Environment, SecretSto
 use shuttle_service::{Error, ResourceFactory, ResourceInputBuilder};
 
 #[derive(Default)]
+#[deprecated(
+    since = "0.42.0",
+    note = "This plugin has been moved to shuttle_runtime::Metadata, see https://docs.shuttle.rs/resources/shuttle-metadata"
+)]
 pub struct ShuttleMetadata;
 
 #[async_trait]

resources/metadata/src/lib.rs

@@ -9,4 +9,4 @@ keywords = ["shuttle-service", "secrets"]
 [dependencies]
 async-trait = "0.1.56"
 serde_json = "1"
-shuttle-service = { path = "../../service", version = "0.41.0" }
+shuttle-service = { path = "../../service", version = "<=0.44.0" }