kemitix/git-next
1
1
Fork 1
Code Issues 17 Pull requests 2 Projects 1 Releases 41 Packages 2 Wiki Activity Actions

WIP: feat: post webhook to user

Browse source
This commit is contained in:
Paul Campbell 2024-07-21 13:44:44 +01:00
parent 85ed7aeaa1
commit d6245ed65e
16 changed files with 165 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -78,6 +78,8 @@ git-conventional = "0.12"
bytes = "1.6"
ulid = "1.1"
warp = "0.3"
time = "0.3"
standardwebhooks = "1.0"
# boilerplate
derive_more = { version = "1.0.0-beta.6", features = [

4
crates/config/src/branch_name.rs
View file

@ -1 +1,3 @@
crate::newtype!(BranchName: String, derive_more::Display, Default: "The name of a Git branch");
use serde::Serialize;
crate::newtype!(BranchName: String, derive_more::Display, Default, Serialize: "The name of a Git branch");

4
crates/config/src/forge_alias.rs
View file

@ -1,4 +1,6 @@
crate::newtype!(ForgeAlias: String, Hash, PartialOrd, Ord, derive_more::Display, Default: "The name of a Forge to connect to");
use serde::Serialize;
crate::newtype!(ForgeAlias: String, Hash, PartialOrd, Ord, derive_more::Display, Default, Serialize: "The name of a Forge to connect to");
impl From<&ForgeAlias> for std::path::PathBuf {
fn from(value: &ForgeAlias) -> Self {
Self::from(&value.0)

3
crates/config/src/repo_alias.rs
View file

@ -1,7 +1,8 @@
use derive_more::Display;
use serde::Serialize;
use crate::newtype;
newtype!(RepoAlias: String, Display, Default, PartialOrd, Ord: r#"The alias of a repo.
newtype!(RepoAlias: String, Display, Default, PartialOrd, Ord, Serialize: r#"The alias of a repo.
This is the alias for the repo within `git-next-server.toml`."#);

6
crates/config/src/server.rs
View file

@ -199,7 +199,7 @@ impl Notification {
webhook: None,
}
}
pub const fn webhook(webhook: OutboundWebhook) -> Self {
pub const fn new_webhook(webhook: OutboundWebhook) -> Self {
Self {
r#type: NotificationType::Webhook,
webhook: Some(webhook),
@ -210,6 +210,10 @@ impl Notification {
self.r#type
}
pub const fn webhook(&self) -> Option<&OutboundWebhook> {
self.webhook.as_ref()
}
pub fn webhook_url(&self) -> Option<String> {
self.webhook.clone().map(|x| x.url)
}

2
crates/config/src/tests.rs
View file

@ -753,7 +753,7 @@ mod given {
ServerStorage::new(a_name().into())
}
pub fn a_notification_config() -> Notification {
Notification::webhook(an_outbound_webhook())
Notification::new_webhook(an_outbound_webhook())
}
pub fn some_forge_configs() -> BTreeMap<String, ForgeConfig> {
[(a_name(), a_forge_config())].into()

6
crates/git/Cargo.toml
View file

@ -25,11 +25,13 @@ async-trait = { workspace = true }
# fs/network
kxio = { workspace = true }
# # TOML parsing
# serde = { workspace = true }
# TOML parsing
serde_json = { workspace = true }
# toml = { workspace = true }
# webhooks - user notification
serde = { workspace = true }
# Secrets and Password
secrecy = { workspace = true }

6
crates/git/src/commit.rs
View file

@ -2,6 +2,7 @@ use config::newtype;
use derive_more::Display;
//
use git_next_config as config;
use serde::Serialize;
#[derive(
Clone,
@ -13,6 +14,7 @@ use git_next_config as config;
Ord,
derive_more::Constructor,
derive_more::Display,
Serialize,
)]
#[display("{}", sha)]
pub struct Commit {
@ -37,8 +39,8 @@ impl From<config::webhook::Push> for Commit {
}
}
newtype!(Sha: String, Display, Hash,PartialOrd, Ord: "The unique SHA for a git commit.");
newtype!(Message: String, Hash, PartialOrd, Ord: "The commit message for a git commit.");
newtype!(Sha: String, Display, Hash,PartialOrd, Ord, Serialize: "The unique SHA for a git commit.");
newtype!(Message: String, Display, Hash, PartialOrd, Ord, Serialize: "The commit message for a git commit.");
#[derive(Clone, Debug)]
pub struct Histories {

1
crates/repo-actor/Cargo.toml
View file

@ -43,6 +43,7 @@ git-conventional = { workspace = true }
# Webhooks
bytes = { workspace = true }
ulid = { workspace = true }
time = { workspace = true }
# boilerplate
derive_more = { workspace = true }

1
crates/repo-actor/src/lib.rs
View file

@ -2,6 +2,7 @@ mod branch;
pub mod handlers;
mod load;
pub mod messages;
mod notifications;
#[cfg(test)]
mod tests;

72
crates/repo-actor/src/notifications.rs Normal file
View file

@ -0,0 +1,72 @@
use derive_more::Deref as _;
use git_next_git::UserNotification;
use serde_json::json;
use crate::messages::NotifyUser;
impl NotifyUser {
pub fn as_json(self, timestamp: time::OffsetDateTime) -> serde_json::Value {
let timestamp = timestamp.unix_timestamp().to_string();
match self.deref() {
UserNotification::CICheckFailed {
forge_alias,
repo_alias,
commit,
} => json!({
"type": "cicheck.failed",
"timestamp": timestamp,
"data": {
"forge_alias": forge_alias,
"repo_alias": repo_alias,
"commit": {
"sha": commit.sha(),
"message": commit.message()
}
}
}),
UserNotification::RepoConfigLoadFailure {
forge_alias,
repo_alias,
reason,
} => json!({
"type": "config.load.failed",
"timestamp": timestamp,
"data": {
"forge_alias": forge_alias,
"repo_alias": repo_alias,
"reason": reason
}
}),
UserNotification::WebhookRegistration {
forge_alias,
repo_alias,
reason,
} => json!({
"type": "webhook.registration.failed",
"timestamp": timestamp,
"data": {
"forge_alias": forge_alias,
"repo_alias": repo_alias,
"reason": reason
}
}),
UserNotification::DevNotBasedOnMain {
forge_alias,
repo_alias,
dev_branch,
main_branch,
} => json!({
"type": "branch.dev.not-on-main",
"timestamp": timestamp,
"data": {
"forge_alias": forge_alias,
"repo_alias": repo_alias,
"branches": {
"dev": dev_branch,
"main": main_branch
}
}
}),
}
}
}

8
crates/server-actor/Cargo.toml
View file

@ -28,6 +28,14 @@ derive-with = { workspace = true }
# Actors
actix = { workspace = true }
# Webhooks
serde = { workspace = true }
serde_json = { workspace = true }
ulid = { workspace = true }
time = { workspace = true }
secrecy = { workspace = true }
standardwebhooks = { workspace = true }
[dev-dependencies]
# Testing
# assert2 = { workspace = true }

31
crates/server-actor/src/handlers/notify_user.rs
View file

@ -1,5 +1,6 @@
//
use actix::prelude::*;
use git_next_config::server::NotificationType;
use git_next_repo_actor::messages::NotifyUser;
use crate::ServerActor;
@ -7,8 +8,32 @@ use crate::ServerActor;
impl Handler<NotifyUser> for ServerActor {
type Result = ();
fn handle(&mut self, _msg: NotifyUser, _ctx: &mut Self::Context) -> Self::Result {
// TODO: (#95) should notify user
// send post to notification webhook url
fn handle(&mut self, msg: NotifyUser, _ctx: &mut Self::Context) -> Self::Result {
let Some(server_config) = &self.server_config else {
return;
};
let notification = &server_config.notification();
match notification.r#type() {
NotificationType::None => { /* do nothing */ }
NotificationType::Webhook => {
let message_id = format!("msg_{}", ulid::Ulid::new());
let timestamp = time::OffsetDateTime::now_utc(); //.unix_timestamp().to_string();
let payload = msg.as_json(timestamp).to_string();
let timestamp = timestamp.unix_timestamp();
let to_sign = format!("{message_id}.{timestamp}.{payload}");
tracing::info!(?to_sign, "");
let Some(webhook) = self.webhook.as_ref() else {
tracing::warn!("Invalid notification configuration - can't sent notification");
return;
};
#[allow(clippy::expect_used)]
let signature = webhook
.sign(&message_id, timestamp, payload.as_ref())
.expect("signature");
tracing::info!(?signature, "");
// TODO: (#95) should notify user
// send post to notification webhook url
}
}
}
}

27
crates/server-actor/src/handlers/receive_valid_server_config.rs
View file

@ -1,5 +1,7 @@
use actix::prelude::*;
use git_next_config::server::NotificationType;
use git_next_webhook_actor::{AddWebhookRecipient, ShutdownWebhook, WebhookActor, WebhookRouter};
use standardwebhooks::Webhook;
use crate::{
messages::{ReceiveValidServerConfig, ValidServerConfig},
@ -19,6 +21,26 @@ impl Handler<ReceiveValidServerConfig> for ServerActor {
if let Some(webhook_actor_addr) = self.webhook_actor_addr.take() {
webhook_actor_addr.do_send(ShutdownWebhook);
}
match server_config.notification().r#type() {
NotificationType::None => { /* do nothing */ }
NotificationType::Webhook => {
// Create webhook signer
use secrecy::ExposeSecret;
let webhook = server_config
.notification()
.webhook_secret()
.map(|secret| Webhook::new(secret.expose_secret()))
.transpose()
.map_err(|e| {
tracing::error!(
"Invalid notification webhook secret (will not send notifications): {e}"
)
})
.ok()
.flatten();
self.webhook = webhook;
}
}
self.generation.inc();
// Webhook Server
tracing::info!("Starting Webhook Server...");
@ -52,8 +74,9 @@ impl Handler<ReceiveValidServerConfig> for ServerActor {
.insert((forge_alias.clone(), repo_alias), addr);
});
}
let webhook = WebhookActor::new(socket_address, webhook_router.recipient()).start();
let webhook_actor_addr =
WebhookActor::new(socket_address, webhook_router.recipient()).start();
self.webhook_actor_addr.replace(webhook_actor_addr);
self.server_config.replace(server_config);
self.webhook.replace(webhook);
}
}

2
crates/server-actor/src/handlers/shutdown.rs
View file

@ -16,7 +16,7 @@ impl Handler<Shutdown> for ServerActor {
tracing::debug!(%forge_alias, %repo_alias, "removed webhook");
});
tracing::debug!("server shutdown");
if let Some(webhook) = self.webhook.take() {
if let Some(webhook) = self.webhook_actor_addr.take() {
tracing::debug!("shuting down webhook");
webhook.do_send(ShutdownWebhook);
tracing::debug!("webhook shutdown");

7
crates/server-actor/src/lib.rs
View file

@ -14,6 +14,7 @@ use git_next_repo_actor::messages::NotifyUser;
use git_next_repo_actor::{messages::CloneRepo, RepoActor};
use git_next_webhook_actor as webhook;
use kxio::{fs::FileSystem, network::Network};
use standardwebhooks::Webhook;
use std::{
collections::BTreeMap,
path::PathBuf,
@ -47,12 +48,13 @@ type Result<T> = core::result::Result<T, Error>;
pub struct ServerActor {
server_config: Option<ServerConfig>,
generation: Generation,
webhook: Option<Addr<WebhookActor>>,
webhook_actor_addr: Option<Addr<WebhookActor>>,
fs: FileSystem,
net: Network,
repository_factory: Box<dyn RepositoryFactory>,
sleep_duration: std::time::Duration,
repo_actors: BTreeMap<(ForgeAlias, RepoAlias), Addr<RepoActor>>,
webhook: Option<Webhook>,
// testing
message_log: Option<Arc<RwLock<Vec<String>>>>,
@ -72,12 +74,13 @@ impl ServerActor {
Self {
server_config: None,
generation,
webhook: None,
webhook_actor_addr: None,
fs,
net,
repository_factory: repo,
sleep_duration,
repo_actors: BTreeMap::new(),
webhook: None,
message_log: None,
}
}