Allow setting a channel for new users to auto-join (#9291)

Release Notes:

- Automatically add new users to the #zed channel

crates/collab/k8s/collab.template.yml

@@ -185,6 +185,8 @@ spec:
               value: "true"
             - name: ZED_ENVIRONMENT
               value: ${ZED_ENVIRONMENT}
+            - name: AUTO_JOIN_CHANNEL_ID
+              value: ${AUTO_JOIN_CHANNEL_ID}
           securityContext:
             capabilities:
               # FIXME - Switch to the more restrictive `PERFMON` capability.

crates/collab/k8s/environments/production.sh

@@ -1,4 +1,5 @@
 ZED_ENVIRONMENT=production
 RUST_LOG=info
 INVITE_LINK_PREFIX=https://zed.dev/invites/
+AUTO_JOIN_CHANNEL_ID=283
 DATABASE_MAX_CONNECTIONS=85

crates/collab/k8s/environments/staging.sh

@@ -2,3 +2,4 @@ ZED_ENVIRONMENT=staging
 RUST_LOG=info
 INVITE_LINK_PREFIX=https://staging.zed.dev/invites/
 DATABASE_MAX_CONNECTIONS=5
+AUTO_JOIN_CHANNEL_ID=8

crates/collab/src/api.rs

@@ -89,12 +89,15 @@ async fn get_authenticated_user(
     Query(params): Query<AuthenticatedUserParams>,
     Extension(app): Extension<Arc<AppState>>,
 ) -> Result<Json<AuthenticatedUserResponse>> {
+    let initial_channel_id = app.config.auto_join_channel_id;
+
     let user = app
         .db
         .get_or_create_user_by_github_account(
             &params.github_login,
             params.github_user_id,
             params.github_email.as_deref(),
+            initial_channel_id,
         )
         .await?;
     let metrics_id = app.db.get_user_metrics_id(user.id).await?;
@@ -179,11 +182,13 @@ async fn add_contributor(
     Extension(app): Extension<Arc<AppState>>,
     extract::Json(params): extract::Json<AuthenticatedUserParams>,
 ) -> Result<()> {
+    let initial_channel_id = app.config.auto_join_channel_id;
     app.db
         .add_contributor(
             &params.github_login,
             params.github_user_id,
             params.github_email.as_deref(),
+            initial_channel_id,
         )
         .await
 }

crates/collab/src/bin/seed.rs

@@ -70,6 +70,7 @@ async fn main() {
                 &github_user.login,
                 Some(github_user.id),
                 github_user.email.as_deref(),
+                None,
             )
             .await
             .expect("failed to insert user");

crates/collab/src/db/queries/contributors.rs

@@ -65,6 +65,7 @@ impl Database {
         github_login: &str,
         github_user_id: Option<i32>,
         github_email: Option<&str>,
+        initial_channel_id: Option<ChannelId>,
     ) -> Result<()> {
         self.transaction(|tx| async move {
             let user = self
@@ -72,6 +73,7 @@ impl Database {
                     github_login,
                     github_user_id,
                     github_email,
+                    initial_channel_id,
                     &tx,
                 )
                 .await?;

crates/collab/src/db/queries/users.rs

@@ -74,12 +74,14 @@ impl Database {
         github_login: &str,
         github_user_id: Option<i32>,
         github_email: Option<&str>,
+        initial_channel_id: Option<ChannelId>,
     ) -> Result<User> {
         self.transaction(|tx| async move {
             self.get_or_create_user_by_github_account_tx(
                 github_login,
                 github_user_id,
                 github_email,
+                initial_channel_id,
                 &tx,
             )
             .await
@@ -92,6 +94,7 @@ impl Database {
         github_login: &str,
         github_user_id: Option<i32>,
         github_email: Option<&str>,
+        initial_channel_id: Option<ChannelId>,
         tx: &DatabaseTransaction,
     ) -> Result<User> {
         if let Some(github_user_id) = github_user_id {
@@ -124,6 +127,17 @@ impl Database {
                 })
                 .exec_with_returning(tx)
                 .await?;
+                if let Some(channel_id) = initial_channel_id {
+                    channel_member::Entity::insert(channel_member::ActiveModel {
+                        id: ActiveValue::NotSet,
+                        channel_id: ActiveValue::Set(channel_id),
+                        user_id: ActiveValue::Set(user.id),
+                        accepted: ActiveValue::Set(true),
+                        role: ActiveValue::Set(ChannelRole::Guest),
+                    })
+                    .exec(tx)
+                    .await?;
+                }
                 Ok(user)
             }
         } else {

crates/collab/src/db/tests/contributor_tests.rs

@@ -22,13 +22,17 @@ async fn test_contributors(db: &Arc<Database>) {
 
     assert_eq!(db.get_contributors().await.unwrap(), Vec::<String>::new());
 
-    db.add_contributor("user1", Some(1), None).await.unwrap();
+    db.add_contributor("user1", Some(1), None, None)
+        .await
+        .unwrap();
     assert_eq!(
         db.get_contributors().await.unwrap(),
         vec!["user1".to_string()]
     );
 
-    db.add_contributor("user2", Some(2), None).await.unwrap();
+    db.add_contributor("user2", Some(2), None, None)
+        .await
+        .unwrap();
     assert_eq!(
         db.get_contributors().await.unwrap(),
         vec!["user1".to_string(), "user2".to_string()]

crates/collab/src/db/tests/db_tests.rs

@@ -102,7 +102,7 @@ async fn test_get_or_create_user_by_github_account(db: &Arc<Database>) {
         .user_id;
 
     let user = db
-        .get_or_create_user_by_github_account("the-new-login2", Some(102), None)
+        .get_or_create_user_by_github_account("the-new-login2", Some(102), None, None)
         .await
         .unwrap();
     assert_eq!(user.id, user_id2);
@@ -110,7 +110,7 @@ async fn test_get_or_create_user_by_github_account(db: &Arc<Database>) {
     assert_eq!(user.github_user_id, Some(102));
 
     let user = db
-        .get_or_create_user_by_github_account("login3", Some(103), Some("user3@example.com"))
+        .get_or_create_user_by_github_account("login3", Some(103), Some("user3@example.com"), None)
         .await
         .unwrap();
     assert_eq!(&user.github_login, "login3");

crates/collab/src/lib.rs

@@ -11,7 +11,7 @@ mod tests;
 use anyhow::anyhow;
 use aws_config::{BehaviorVersion, Region};
 use axum::{http::StatusCode, response::IntoResponse};
-use db::Database;
+use db::{ChannelId, Database};
 use executor::Executor;
 use serde::Deserialize;
 use std::{path::PathBuf, sync::Arc};
@@ -128,6 +128,7 @@ pub struct Config {
     pub zed_environment: Arc<str>,
     pub zed_client_checksum_seed: Option<String>,
     pub slack_panics_webhook: Option<String>,
+    pub auto_join_channel_id: Option<ChannelId>,
 }
 
 impl Config {

crates/collab/src/tests/channel_guest_tests.rs

@@ -167,7 +167,7 @@ async fn test_channel_requires_zed_cla(cx_a: &mut TestAppContext, cx_b: &mut Tes
     server
         .app_state
         .db
-        .get_or_create_user_by_github_account("user_b", Some(100), None)
+        .get_or_create_user_by_github_account("user_b", Some(100), None, None)
         .await
         .unwrap();
 
@@ -265,7 +265,7 @@ async fn test_channel_requires_zed_cla(cx_a: &mut TestAppContext, cx_b: &mut Tes
     server
         .app_state
         .db
-        .add_contributor("user_b", Some(100), None)
+        .add_contributor("user_b", Some(100), None, None)
         .await
         .unwrap();
 

crates/collab/src/tests/test_server.rs

@@ -513,6 +513,7 @@ impl TestServer {
                 clickhouse_database: None,
                 zed_client_checksum_seed: None,
                 slack_panics_webhook: None,
+                auto_join_channel_id: None,
             },
         })
     }