shuttle_runtime/
plugins.rs

1use crate::async_trait;
2use serde::{Deserialize, Serialize};
3use shuttle_service::{
4    resource::{ProvisionResourceRequest, ResourceType},
5    DeploymentMetadata, Error, IntoResource, ResourceFactory, ResourceInputBuilder, SecretStore,
6};
7
8/// ## Shuttle Metadata
9///
10/// Plugin for getting various metadata at runtime.
11///
12/// ### Usage
13///
14/// ```rust,ignore
15/// #[shuttle_runtime::main]
16/// async fn main(
17///     #[shuttle_runtime::Metadata] metadata: DeploymentMetadata,
18/// ) -> __ { ... }
19#[derive(Default)]
20pub struct Metadata;
21
22#[async_trait]
23impl ResourceInputBuilder for Metadata {
24    type Input = DeploymentMetadata;
25    type Output = DeploymentMetadata;
26
27    async fn build(self, factory: &ResourceFactory) -> Result<Self::Input, Error> {
28        Ok(factory.get_metadata())
29    }
30}
31
32/// ## Shuttle Secrets
33///
34/// Plugin for getting secrets in your [Shuttle](https://www.shuttle.dev) service.
35///
36/// ### Usage
37///
38/// Add a `Secrets.toml` file to the root of your crate with the secrets you'd like to store.
39/// Make sure to add `Secrets*.toml` to `.gitignore` to omit your secrets from version control.
40///
41/// Next, add `#[shuttle_runtime::Secrets] secrets: SecretStore` as a parameter to your `shuttle_service::main` function.
42/// `SecretStore::get` can now be called to retrieve your API keys and other secrets at runtime.
43///
44/// ### Example
45///
46/// ```rust,ignore
47/// #[shuttle_runtime::main]
48/// async fn main(
49///     #[shuttle_runtime::Secrets] secrets: SecretStore
50/// ) -> ShuttleAxum {
51///     // get secret defined in `Secrets.toml` file.
52///     let secret = secrets.get("MY_API_KEY").unwrap();
53///
54///     let router = Router::new()
55///         .route("/", || async move { format!("My secret is: {}", secret) });
56///
57///     Ok(router.into())
58/// }
59/// ```
60#[derive(Default)]
61pub struct Secrets;
62
63#[derive(Serialize, Deserialize)]
64#[serde(transparent)]
65pub struct SecretsOutputWrapper(SecretStore);
66
67#[async_trait]
68impl ResourceInputBuilder for Secrets {
69    type Input = ProvisionResourceRequest;
70    type Output = SecretsOutputWrapper;
71
72    async fn build(self, _factory: &ResourceFactory) -> Result<Self::Input, Error> {
73        Ok(ProvisionResourceRequest {
74            r#type: ResourceType::Secrets,
75            config: serde_json::Value::Null,
76        })
77    }
78}
79
80#[async_trait]
81impl IntoResource<SecretStore> for SecretsOutputWrapper {
82    async fn into_resource(self) -> Result<SecretStore, Error> {
83        Ok(self.0)
84    }
85}
shuttle_runtime/plugins.rs

shuttle_runtime/
plugins.rs
