feat: project telemetry config models

.circleci/config.yml

@@ -173,7 +173,7 @@ jobs:
       - restore-cargo-and-sccache
       - install-cargo-make
       - run: cargo make ci-workspace
-      - run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/1Password/typeshare/releases/download/v1.11.0/typeshare-cli-v1.11.0-installer.sh | sh
+      - run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/1Password/typeshare/releases/download/v1.13.0/typeshare-cli-v1.13.0-installer.sh | sh
       - run: cargo make types
       - run: cargo make check-types
       - save-sccache

Makefile.toml

@@ -109,7 +109,7 @@ command = "git-cliff"
 args = ["-o", "CHANGELOG.md", "-t", "${@}"]
 
 [tasks.types]
-install_crate = { crate_name = "typeshare-cli", binary = "typeshare", test_arg = ["-V"], version = "1.11.0" }
+install_crate = { crate_name = "typeshare-cli", binary = "typeshare", test_arg = ["-V"], version = "1.13.0" }
 command = "typeshare"
 args = ["common", "-l", "typescript", "-c", "common/typeshare.toml", "-o", "common/types.ts"]
 

admin/src/args.rs

@@ -1,8 +1,5 @@
 use clap::{Parser, Subcommand};
-use shuttle_common::{
-    constants::API_URL_DEFAULT_BETA,
-    models::{project::ComputeTier, user::UserId},
-};
+use shuttle_common::{constants::API_URL_DEFAULT_BETA, models::project::ComputeTier};
 
 #[derive(Parser, Debug)]
 pub struct Args {
@@ -22,7 +19,7 @@ pub struct Args {
 pub enum Command {
     ChangeProjectOwner {
         project_name: String,
-        new_user_id: UserId,
+        new_user_id: String,
     },
 
     UpdateCompute {
@@ -37,6 +34,13 @@ pub enum Command {
     /// Renew all custom domain certificates
     RenewCerts,
 
+    SetBetaAccess {
+        user_id: String,
+    },
+    UnsetBetaAccess {
+        user_id: String,
+    },
+
     /// Garbage collect free tier projects
     Gc {
         /// days since last deployment to filter by

admin/src/client.rs

@@ -35,6 +35,25 @@ impl Client {
             .await
     }
 
+    pub async fn set_beta_access(&self, user_id: &str, access: bool) -> Result<()> {
+        let resp = if access {
+            self.inner
+                .put(format!("/admin/users/{user_id}/beta"), Option::<()>::None)
+                .await?
+        } else {
+            self.inner
+                .delete(format!("/admin/users/{user_id}/beta"), Option::<()>::None)
+                .await?
+        };
+
+        if !resp.status().is_success() {
+            dbg!(resp);
+            panic!("request failed");
+        }
+
+        Ok(())
+    }
+
     pub async fn gc_free_tier(&self, days: u32) -> Result<Vec<String>> {
         let path = format!("/admin/gc/free/{days}");
         self.inner.get_json(&path).await

admin/src/lib.rs

@@ -34,6 +34,14 @@ pub async fn run(args: Args) {
                 .unwrap();
             println!("{res:?}");
         }
+        Command::SetBetaAccess { user_id } => {
+            client.set_beta_access(&user_id, true).await.unwrap();
+            println!("Set user {user_id} beta access");
+        }
+        Command::UnsetBetaAccess { user_id } => {
+            client.set_beta_access(&user_id, false).await.unwrap();
+            println!("Unset user {user_id} beta access");
+        }
         Command::Gc {
             days,
             stop_deployments,

common/src/models/mod.rs

@@ -6,4 +6,5 @@ pub mod log;
 pub mod project;
 pub mod resource;
 pub mod team;
+pub mod telemetry;
 pub mod user;

common/src/models/team.rs

@@ -1,8 +1,6 @@
 use serde::{Deserialize, Serialize};
 use strum::{Display, EnumString};
 
-use super::user::UserId;
-
 /// Minimal team information
 #[derive(Debug, Default, Serialize, Deserialize, PartialEq)]
 pub struct Response {
@@ -20,7 +18,7 @@ pub struct Response {
 #[derive(Debug, Serialize, Deserialize, PartialEq)]
 pub struct MemberResponse {
     /// User ID
-    pub id: UserId,
+    pub id: String,
 
     /// Role of the user in the team
     pub role: MemberRole,

common/src/models/telemetry.rs

@@ -0,0 +1,129 @@
+use serde::{Deserialize, Serialize};
+
+/// Status of a telemetry export configuration for an external sink
+#[derive(Eq, Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[typeshare::typeshare]
+pub struct TelemetrySinkStatus {
+    /// Indicates that the associated project is configured to export telemetry data to this sink
+    enabled: bool,
+}
+
+/// A safe-for-display representation of the current telemetry export configuration for a given project
+#[derive(Eq, Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
+#[typeshare::typeshare]
+pub struct TelemetryConfigResponse {
+    betterstack: Option<TelemetrySinkStatus>,
+    datadog: Option<TelemetrySinkStatus>,
+    grafana_cloud: Option<TelemetrySinkStatus>,
+}
+
+impl From<Vec<TelemetrySinkConfig>> for TelemetryConfigResponse {
+    fn from(value: Vec<TelemetrySinkConfig>) -> Self {
+        let mut instance = Self::default();
+
+        for sink in value {
+            match sink {
+                TelemetrySinkConfig::Betterstack(_) => {
+                    instance.betterstack = Some(TelemetrySinkStatus { enabled: true })
+                }
+                TelemetrySinkConfig::Datadog(_) => {
+                    instance.datadog = Some(TelemetrySinkStatus { enabled: true })
+                }
+                TelemetrySinkConfig::GrafanaCloud(_) => {
+                    instance.grafana_cloud = Some(TelemetrySinkStatus { enabled: true })
+                }
+            }
+        }
+
+        instance
+    }
+}
+
+/// The user-supplied config required to export telemetry to a given external sink
+#[derive(
+    Eq, Clone, PartialEq, Serialize, Deserialize, strum::AsRefStr, strum::EnumDiscriminants,
+)]
+#[serde(tag = "type", content = "content", rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+#[typeshare::typeshare]
+#[strum_discriminants(derive(Serialize, Deserialize, strum::AsRefStr))]
+#[strum_discriminants(serde(rename_all = "snake_case"))]
+#[strum_discriminants(strum(serialize_all = "snake_case"))]
+pub enum TelemetrySinkConfig {
+    /// [Betterstack](https://betterstack.com/docs/logs/open-telemetry/)
+    Betterstack(BetterstackConfig),
+    /// [Datadog](https://docs.datadoghq.com/opentelemetry/collector_exporter/otel_collector_datadog_exporter)
+    Datadog(DatadogConfig),
+    /// [Grafana Cloud](https://grafana.com/docs/grafana-cloud/send-data/otlp/)
+    GrafanaCloud(GrafanaCloudConfig),
+}
+
+impl TelemetrySinkConfig {
+    pub fn as_db_type(&self) -> String {
+        format!("project::telemetry::{}::config", self.as_ref())
+    }
+}
+
+impl TelemetrySinkConfigDiscriminants {
+    pub fn as_db_type(&self) -> String {
+        format!("project::telemetry::{}::config", self.as_ref())
+    }
+}
+
+#[derive(Eq, Clone, PartialEq, Serialize, Deserialize)]
+#[typeshare::typeshare]
+pub struct BetterstackConfig {
+    pub source_token: String,
+}
+#[derive(Eq, Clone, PartialEq, Serialize, Deserialize)]
+#[typeshare::typeshare]
+pub struct DatadogConfig {
+    pub api_key: String,
+}
+#[derive(Eq, Clone, PartialEq, Serialize, Deserialize)]
+#[typeshare::typeshare]
+pub struct GrafanaCloudConfig {
+    pub token: String,
+    pub endpoint: String,
+    pub instance_id: String,
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn sink_config_enum() {
+        assert_eq!(
+            "betterstack",
+            TelemetrySinkConfig::Betterstack(BetterstackConfig {
+                source_token: "".into()
+            })
+            .as_ref()
+        );
+        assert_eq!(
+            "project::telemetry::betterstack::config",
+            TelemetrySinkConfig::Betterstack(BetterstackConfig {
+                source_token: "".into()
+            })
+            .as_db_type()
+        );
+
+        assert_eq!(
+            "betterstack",
+            TelemetrySinkConfigDiscriminants::Betterstack.as_ref()
+        );
+        assert_eq!(
+            "grafana_cloud",
+            TelemetrySinkConfigDiscriminants::GrafanaCloud.as_ref()
+        );
+        assert_eq!(
+            "\"betterstack\"",
+            serde_json::to_string(&TelemetrySinkConfigDiscriminants::Betterstack).unwrap()
+        );
+        assert_eq!(
+            "\"grafana_cloud\"",
+            serde_json::to_string(&TelemetrySinkConfigDiscriminants::GrafanaCloud).unwrap()
+        );
+    }
+}

common/src/models/user.rs

@@ -7,10 +7,6 @@ use crossterm::style::Stylize;
 #[cfg(feature = "display")]
 use std::fmt::Write;
 
-/// In normal cases, a string with the format `user_<ULID>`.
-/// This is a soft rule and the string can be something different.
-pub type UserId = String;
-
 #[derive(Deserialize, Serialize, Debug)]
 #[typeshare::typeshare]
 pub struct UserResponse {