https://github.com/user-attachments/assets/78db908e-cfe5-4803-b0dc-4f33bc457840 * starts to extract usernames out of `users/` GitHub API responses, and pass those along with e-mails in the collab sessions as part of the `User` data * adjusts various prefill and seed test methods so that the new data can be retrieved from GitHub properly * if there's an active call, where guests have write permissions and e-mails, allow to trigger `FillCoAuthors` action in the context of the git panel, that will fill in `co-authored-by:` lines, using e-mail and names (or GitHub handle names if name is absent) * the action tries to not duplicate such entries, if any are present already, and adds those below the rest of the commit input's text Concerns: * users with write permissions and no e-mails will be silently omitted — adding odd entries that try to indicate this or raising pop-ups is very intrusive (maybe, we can add `#`-prefixed comments?), logging seems pointless * it's not clear whether the data prefill will run properly on the existing users — seems tolerable now, as it seems that we get e-mails properly already, so we'll see GitHub handles instead of names in the worst case. This can be prefilled better later. * e-mails and names for a particular project may be not what the user wants. E.g. my `.gitconfig` has ``` [user] email = mail4score@gmail.com # .....snip [includeif "gitdir:**/work/zed/**/.git"] path = ~/.gitconfig.work ``` and that one has ``` [user] email = kirill@zed.dev ``` while my GitHub profile is configured so, that `mail4score@gmail.com` is the public, commit e-mail. So, when I'm a participant in a Zed session, wrong e-mail will be picked. The problem is, it's impossible for a host to get remote's collaborator git metadata for a particular project, as that might not even exist on disk for the client. Seems that we might want to add some "project git URL <-> user name and email" mapping in the settings(?). The design of this is not very clear, so the PR concentrates on the basics for now. When https://github.com/zed-industries/zed/pull/23308 lands, most of the issues can be solved by collaborators manually, before committing. Release Notes: - N/A
124 lines
3.7 KiB
Rust
124 lines
3.7 KiB
Rust
use std::sync::{Arc, OnceLock};
|
|
|
|
use anyhow::anyhow;
|
|
use axum::{
|
|
extract::{self, Query},
|
|
routing::get,
|
|
Extension, Json, Router,
|
|
};
|
|
use chrono::{NaiveDateTime, SecondsFormat};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::api::AuthenticatedUserParams;
|
|
use crate::db::ContributorSelector;
|
|
use crate::{AppState, Result};
|
|
|
|
pub fn router() -> Router {
|
|
Router::new()
|
|
.route("/contributors", get(get_contributors).post(add_contributor))
|
|
.route("/contributor", get(check_is_contributor))
|
|
}
|
|
|
|
async fn get_contributors(Extension(app): Extension<Arc<AppState>>) -> Result<Json<Vec<String>>> {
|
|
Ok(Json(app.db.get_contributors().await?))
|
|
}
|
|
|
|
#[derive(Debug, Deserialize)]
|
|
struct CheckIsContributorParams {
|
|
github_user_id: Option<i32>,
|
|
github_login: Option<String>,
|
|
}
|
|
|
|
impl CheckIsContributorParams {
|
|
fn into_contributor_selector(self) -> Result<ContributorSelector> {
|
|
if let Some(github_user_id) = self.github_user_id {
|
|
return Ok(ContributorSelector::GitHubUserId { github_user_id });
|
|
}
|
|
|
|
if let Some(github_login) = self.github_login {
|
|
return Ok(ContributorSelector::GitHubLogin { github_login });
|
|
}
|
|
|
|
Err(anyhow!(
|
|
"must be one of `github_user_id` or `github_login`."
|
|
))?
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Serialize)]
|
|
struct CheckIsContributorResponse {
|
|
signed_at: Option<String>,
|
|
}
|
|
|
|
async fn check_is_contributor(
|
|
Extension(app): Extension<Arc<AppState>>,
|
|
Query(params): Query<CheckIsContributorParams>,
|
|
) -> Result<Json<CheckIsContributorResponse>> {
|
|
let params = params.into_contributor_selector()?;
|
|
|
|
if RenovateBot::is_renovate_bot(¶ms) {
|
|
return Ok(Json(CheckIsContributorResponse {
|
|
signed_at: Some(
|
|
RenovateBot::created_at()
|
|
.and_utc()
|
|
.to_rfc3339_opts(SecondsFormat::Millis, true),
|
|
),
|
|
}));
|
|
}
|
|
|
|
Ok(Json(CheckIsContributorResponse {
|
|
signed_at: app
|
|
.db
|
|
.get_contributor_sign_timestamp(¶ms)
|
|
.await?
|
|
.map(|ts| ts.and_utc().to_rfc3339_opts(SecondsFormat::Millis, true)),
|
|
}))
|
|
}
|
|
|
|
/// The Renovate bot GitHub user (`renovate[bot]`).
|
|
///
|
|
/// https://api.github.com/users/renovate[bot]
|
|
struct RenovateBot;
|
|
|
|
impl RenovateBot {
|
|
const LOGIN: &'static str = "renovate[bot]";
|
|
const USER_ID: i32 = 29139614;
|
|
|
|
/// Returns the `created_at` timestamp for the Renovate bot user.
|
|
fn created_at() -> &'static NaiveDateTime {
|
|
static CREATED_AT: OnceLock<NaiveDateTime> = OnceLock::new();
|
|
CREATED_AT.get_or_init(|| {
|
|
chrono::DateTime::parse_from_rfc3339("2017-06-02T07:04:12Z")
|
|
.expect("failed to parse 'created_at' for 'renovate[bot]'")
|
|
.naive_utc()
|
|
})
|
|
}
|
|
|
|
/// Returns whether the given contributor selector corresponds to the Renovate bot user.
|
|
fn is_renovate_bot(contributor: &ContributorSelector) -> bool {
|
|
match contributor {
|
|
ContributorSelector::GitHubLogin { github_login } => github_login == Self::LOGIN,
|
|
ContributorSelector::GitHubUserId { github_user_id } => {
|
|
github_user_id == &Self::USER_ID
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
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(
|
|
¶ms.github_login,
|
|
params.github_user_id,
|
|
params.github_email.as_deref(),
|
|
params.github_name.as_deref(),
|
|
params.github_user_created_at,
|
|
initial_channel_id,
|
|
)
|
|
.await
|
|
}
|