Merge pull request #1813 from Kobzol/lookup-zulip-id

Allow automatically fetching Zulip ID for newly added users

Author: Mark-Simulacrum

README.md

@@ -74,7 +74,12 @@ cargo run add-person <github-username>
 
 You can also add additional information, such as someone's Discord or Zulip ID by adding additional fields to their `.toml` file.
 
-To determine someone's Zulip ID, find them in the list of people on the
+You can use the `--fetch-zulip-id` flag to automatically try to find the Zulip ID for the added user based on their GitHub login. This will only work if the user has linked their Zulip and GitHub accounts. You will need to get a [Zulip API key](https://zulip.com/api/api-keys#get-your-api-key) for this to work, and set the following environment variables:
+
+- `ZULIP_USER`: should be set to the e-mail address of your Zulip account
+- `ZULIP_TOKEN`: should be set to your API key
+
+If you need to determine someone's Zulip ID manually, find them in the list of people on the
 right-hand side in Zulip, click the "three dots" menu and then "View profile", and copy the 'User ID'
 into the toml file:
 

src/api/zulip.rs

@@ -42,9 +42,14 @@ impl ZulipApi {
     }
 
     /// Get all users of the Rust Zulip instance
-    pub(crate) fn get_users(&self) -> Result<Vec<ZulipUser>, Error> {
+    pub(crate) fn get_users(&self, include_profile_fields: bool) -> Result<Vec<ZulipUser>, Error> {
+        let url = if include_profile_fields {
+            "/users?include_custom_profile_fields=true"
+        } else {
+            "/users"
+        };
         let response = self
-            .req(Method::GET, "/users", None)?
+            .req(Method::GET, url, None)?
             .error_for_status()?
             .json::<ZulipUsers>()?
             .members;
@@ -97,10 +102,24 @@ struct ZulipOneUser {
     user: ZulipUser,
 }
 
+#[derive(Clone, Deserialize, Debug, PartialEq, Eq)]
+pub(crate) struct ProfileValue {
+    value: String,
+}
+
 /// A single Zulip user
-#[derive(Clone, Deserialize, PartialEq, Eq, Hash)]
+#[derive(Clone, Deserialize, Debug, PartialEq, Eq)]
 pub(crate) struct ZulipUser {
     pub(crate) user_id: u64,
     #[serde(rename = "full_name")]
     pub(crate) name: String,
+    #[serde(default)]
+    pub(crate) profile_data: HashMap<String, ProfileValue>,
+}
+
+impl ZulipUser {
+    // The GitHub profile data key is 3873
+    pub(crate) fn get_github_username(&self) -> Option<&str> {
+        self.profile_data.get("3873").map(|v| v.value.as_str())
+    }
 }

src/main.rs

@@ -19,7 +19,7 @@ use schema::{Email, Team, TeamKind};
 
 use crate::ci::{check_codeowners, generate_codeowners_file};
 use crate::schema::RepoPermission;
-use anyhow::{bail, format_err, Error};
+use anyhow::{bail, format_err, Context, Error};
 use api::github;
 use clap::Parser;
 use log::{error, info, warn};
@@ -48,7 +48,12 @@ enum Cli {
         skip: Vec<String>,
     },
     /// Add a new person from their GitHub profile
-    AddPerson { github_name: String },
+    AddPerson {
+        github_name: String,
+        /// Try to fetch the Zulip ID of the user, based on their GitHub handle or e-mail.
+        #[arg(long)]
+        fetch_zulip_id: bool,
+    },
     /// Generate the static API
     StaticApi { dest: String },
     /// Print information about a person
@@ -212,22 +217,42 @@ fn run() -> Result<(), Error> {
                 &skip.iter().map(|s| s.as_ref()).collect::<Vec<_>>(),
             )?;
         }
-        Cli::AddPerson { ref github_name } => {
-            #[derive(serde::Serialize)]
+        Cli::AddPerson {
+            ref github_name,
+            fetch_zulip_id,
+        } => {
+            #[derive(serde::Serialize, Debug)]
             #[serde(rename_all = "kebab-case")]
             struct PersonToAdd<'a> {
                 name: &'a str,
                 github: &'a str,
                 github_id: u64,
                 #[serde(skip_serializing_if = "Option::is_none")]
                 email: Option<&'a str>,
+                #[serde(skip_serializing_if = "Option::is_none")]
+                zulip_id: Option<u64>,
             }
 
             let github = github::GitHubApi::new();
             let user = github.user(github_name)?;
             let github_name = user.login;
             let github_id = user.id;
 
+            let mut zulip_id: Option<u64> = None;
+            if fetch_zulip_id {
+                let zulip = ZulipApi::new();
+                let users = zulip.get_users(true).context("Cannot get user data from Zulip. Configure ZULIP_USER and ZULIP_TOKEN environment variables")?;
+
+                // Try to find user by GitHub handle
+                if let Some(zulip_user) = users.iter().find(|u| {
+                    u.get_github_username().map(|login| login.to_lowercase())
+                        == Some(github_name.to_lowercase())
+                }) {
+                    info!("Found Zulip ID {}", zulip_user.user_id);
+                    zulip_id = Some(zulip_user.user_id);
+                }
+            }
+
             if data.person(&github_name).is_some() {
                 bail!("person already in the repo: {}", github_name);
             }
@@ -248,6 +273,7 @@ fn run() -> Result<(), Error> {
                         warn!("the person is missing the email on GitHub, leaving the field empty");
                         None
                     }),
+                    zulip_id,
                 })?
                 .as_bytes(),
             )?;

src/validate.rs

@@ -676,7 +676,7 @@ fn validate_discord_team_members_have_discord_ids(data: &Data, errors: &mut Vec<
 
 /// Ensure every member of a team that has a Zulip group has a Zulip id
 fn validate_zulip_users(data: &Data, zulip: &ZulipApi, errors: &mut Vec<String>) {
-    let by_id = match zulip.get_users() {
+    let by_id = match zulip.get_users(false) {
         Ok(u) => u.iter().map(|u| u.user_id).collect::<HashSet<_>>(),
         Err(err) => {
             errors.push(format!("couldn't verify Zulip users: {}", err));