Compare commits

...

3 commits

Author SHA1 Message Date
1d3ade6bdd WIP: feat: dispatch NotifyUser messages to server actor (2/2)
All checks were successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
ci/woodpecker/push/cron-docker-builder Pipeline was successful
2024-07-21 13:29:41 +01:00
d8f256bedc refactor: use Option<&T> over &Option<T> 2024-07-21 13:29:05 +01:00
e5f2bac00c WIP: feat: dispatch NotifyUser messages to server actor (1/2) 2024-07-21 13:28:51 +01:00
32 changed files with 267 additions and 134 deletions

View file

@ -10,6 +10,7 @@ mod git_remote;
pub mod push;
mod repo_details;
pub mod repository;
mod user_notification;
pub mod validation;
#[cfg(test)]
@ -24,3 +25,5 @@ pub use git_remote::GitRemote;
pub use repo_details::RepoDetails;
pub use repository::OpenRepository;
pub use repository::Repository;
pub use user_notification::UserNotification;

View file

@ -0,0 +1,15 @@
use crate::Commit;
use git_next_config::{ForgeAlias, RepoAlias};
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum UserNotification {
CICheckFailed(ForgeAlias, RepoAlias, Commit),
RepoConfigLoadFailure(ForgeAlias, RepoAlias, String),
WebhookRegistration(ForgeAlias, RepoAlias, String),
DevNotBasedOnMain {
forge_alias: git_next_config::ForgeAlias,
repo_alias: git_next_config::RepoAlias,
dev_branch: git_next_config::BranchName,
main_branch: git_next_config::BranchName,
},
}

View file

@ -1,5 +1,5 @@
//
use crate as git;
use crate::{self as git, UserNotification};
use git_next_config as config;
pub type Result<T> = core::result::Result<T, Error>;
@ -40,10 +40,14 @@ pub fn validate_positions(
// Validations:
// Dev must be on main branch, else the USER must rebase it
if is_not_based_on(&commit_histories.dev, &main) {
return Err(Error::UserIntervention(format!(
"Branch '{}' not based on '{}'",
dev_branch, main_branch
)));
return Err(Error::UserIntervention(
UserNotification::DevNotBasedOnMain {
forge_alias: repo_details.forge.forge_alias().clone(),
repo_alias: repo_details.repo_alias.clone(),
dev_branch,
main_branch,
},
));
}
// verify that next is on main or at most one commit on top of main, else reset it back to main
if is_not_based_on(
@ -120,8 +124,8 @@ pub enum Error {
#[error("{0} - not retrying")]
NonRetryable(String),
#[error("{0} - user intervention required")]
UserIntervention(String),
#[error("user intervention required")]
UserIntervention(UserNotification),
}
impl From<git::fetch::Error> for Error {
fn from(value: git::fetch::Error) -> Self {

View file

@ -30,21 +30,18 @@ impl Handler<actor::messages::AdvanceMain> for actor::RepoActor {
Err(err) => {
tracing::warn!("advance main: {err}");
}
Ok(_) => {
let log = self.log.clone();
match repo_config.source() {
git_next_config::RepoConfigSource::Repo => {
actor::do_send(addr, actor::messages::LoadConfigFromRepo, &log);
}
git_next_config::RepoConfigSource::Server => {
actor::do_send(
addr,
actor::messages::ValidateRepo::new(message_token),
&log,
);
}
Ok(_) => match repo_config.source() {
git_next_config::RepoConfigSource::Repo => {
actor::do_send(addr, actor::messages::LoadConfigFromRepo, self.log.as_ref());
}
}
git_next_config::RepoConfigSource::Server => {
actor::do_send(
addr,
actor::messages::ValidateRepo::new(message_token),
self.log.as_ref(),
);
}
},
}
}
}

View file

@ -35,7 +35,7 @@ impl Handler<actor::messages::AdvanceNext> for actor::RepoActor {
actor::do_send(
addr,
actor::messages::ValidateRepo::new(message_token),
&self.log,
self.log.as_ref(),
);
}
Err(err) => tracing::warn!("advance next: {err}"),

View file

@ -11,7 +11,7 @@ impl Handler<actor::messages::CheckCIStatus> for actor::RepoActor {
msg: actor::messages::CheckCIStatus,
ctx: &mut Self::Context,
) -> Self::Result {
actor::logger(&self.log, "start: CheckCIStatus");
actor::logger(self.log.as_ref(), "start: CheckCIStatus");
let addr = ctx.address();
let forge = self.forge.duplicate();
let next = msg.unwrap();
@ -24,7 +24,7 @@ impl Handler<actor::messages::CheckCIStatus> for actor::RepoActor {
actor::do_send(
addr,
actor::messages::ReceiveCIStatus::new((next, status)),
&log,
log.as_ref(),
);
}
.in_current_span()

View file

@ -12,29 +12,29 @@ impl Handler<actor::messages::CloneRepo> for actor::RepoActor {
_msg: actor::messages::CloneRepo,
ctx: &mut Self::Context,
) -> Self::Result {
actor::logger(&self.log, "Handler: CloneRepo: start");
actor::logger(self.log.as_ref(), "Handler: CloneRepo: start");
tracing::debug!("Handler: CloneRepo: start");
match git::repository::open(&*self.repository_factory, &self.repo_details) {
Ok(repository) => {
actor::logger(&self.log, "open okay");
actor::logger(self.log.as_ref(), "open okay");
tracing::debug!("open okay");
self.open_repository.replace(repository);
if self.repo_details.repo_config.is_none() {
actor::do_send(
ctx.address(),
actor::messages::LoadConfigFromRepo,
&self.log,
self.log.as_ref(),
);
} else {
actor::do_send(
ctx.address(),
actor::messages::RegisterWebhook::new(),
&self.log,
self.log.as_ref(),
);
}
}
Err(err) => {
actor::logger(&self.log, "open failed");
actor::logger(self.log.as_ref(), "open failed");
tracing::debug!("err: {err:?}");
tracing::warn!("Could not open repo: {err}")
}

View file

@ -1,8 +1,9 @@
//
use actix::prelude::*;
use git_next_git::UserNotification;
use tracing::Instrument as _;
use crate as actor;
use crate::{self as actor};
impl Handler<actor::messages::LoadConfigFromRepo> for actor::RepoActor {
type Result = ();
@ -18,16 +19,27 @@ impl Handler<actor::messages::LoadConfigFromRepo> for actor::RepoActor {
};
let open_repository = open_repository.duplicate();
let repo_details = self.repo_details.clone();
let forge_alias = repo_details.forge.forge_alias().clone();
let repo_alias = repo_details.repo_alias.clone();
let addr = ctx.address();
let notify_user_recipient = self.notify_user_recipient.clone();
let log = self.log.clone();
async move {
match actor::load::config_from_repository(repo_details, &*open_repository).await {
Ok(repo_config) => {
actor::logger(&log, "send: LoadedConfig");
addr.do_send(actor::messages::ReceiveRepoConfig::new(repo_config))
}
Err(err) => tracing::warn!(?err, "Failed to load config"),
// TODO: (#95) should notify user
Ok(repo_config) => actor::do_send(
addr,
actor::messages::ReceiveRepoConfig::new(repo_config),
log.as_ref(),
),
Err(err) => actor::notify_user(
notify_user_recipient.as_ref(),
UserNotification::RepoConfigLoadFailure(
forge_alias,
repo_alias,
err.to_string(),
),
log.as_ref(),
),
}
}
.in_current_span()

View file

@ -1,6 +1,7 @@
//
use crate as actor;
use crate::{self as actor};
use actix::prelude::*;
use git::UserNotification;
use git_next_git as git;
impl Handler<actor::messages::ReceiveCIStatus> for actor::RepoActor {
@ -12,33 +13,43 @@ impl Handler<actor::messages::ReceiveCIStatus> for actor::RepoActor {
ctx: &mut Self::Context,
) -> Self::Result {
let log = self.log.clone();
actor::logger(&log, "start: ReceiveCIStatus");
actor::logger(log.as_ref(), "start: ReceiveCIStatus");
let addr = ctx.address();
let (next, status) = msg.unwrap();
let forge_alias = self.repo_details.forge.forge_alias().clone();
let repo_alias = self.repo_details.repo_alias.clone();
let message_token = self.message_token;
let sleep_duration = self.sleep_duration;
tracing::debug!(?status, "");
match status {
git::forge::commit::Status::Pass => {
actor::do_send(addr, actor::messages::AdvanceMain::new(next), &self.log);
actor::do_send(
addr,
actor::messages::AdvanceMain::new(next),
self.log.as_ref(),
);
}
git::forge::commit::Status::Pending => {
std::thread::sleep(sleep_duration);
actor::do_send(
addr,
actor::messages::ValidateRepo::new(message_token),
&self.log,
self.log.as_ref(),
);
}
git::forge::commit::Status::Fail => {
tracing::warn!("Checks have failed");
// TODO: (#95) test: repo with next ahead of main and failing CI should notify user
actor::notify_user(
self.notify_user_recipient.as_ref(),
UserNotification::CICheckFailed(forge_alias, repo_alias, next),
log.as_ref(),
);
actor::delay_send(
addr,
sleep_duration,
actor::messages::ValidateRepo::new(message_token),
&self.log,
self.log.as_ref(),
);
}
}

View file

@ -17,7 +17,7 @@ impl Handler<actor::messages::ReceiveRepoConfig> for actor::RepoActor {
actor::do_send(
ctx.address(),
actor::messages::RegisterWebhook::new(),
&self.log,
self.log.as_ref(),
);
}
}

View file

@ -2,19 +2,21 @@
use actix::prelude::*;
use tracing::Instrument as _;
use crate as actor;
use crate::{self as actor};
use actor::{messages::RegisterWebhook, RepoActor};
use git_next_git::UserNotification;
impl Handler<RegisterWebhook> for RepoActor {
type Result = ();
fn handle(&mut self, _msg: RegisterWebhook, ctx: &mut Self::Context) -> Self::Result {
if self.webhook_id.is_none() {
let forge_alias = self.repo_details.forge.forge_alias();
let repo_alias = &self.repo_details.repo_alias;
let webhook_url = self.webhook.url(forge_alias, repo_alias);
let forge_alias = self.repo_details.forge.forge_alias().clone();
let repo_alias = self.repo_details.repo_alias.clone();
let webhook_url = self.webhook.url(&forge_alias, &repo_alias);
let forge = self.forge.duplicate();
let addr = ctx.address();
let notify_user_recipient = self.notify_user_recipient.clone();
let log = self.log.clone();
tracing::debug!("registering webhook");
async move {
@ -24,16 +26,25 @@ impl Handler<RegisterWebhook> for RepoActor {
actor::do_send(
addr,
actor::messages::WebhookRegistered::from(registered_webhook),
&log,
log.as_ref(),
);
}
Err(err) => {
actor::notify_user(
notify_user_recipient.as_ref(),
UserNotification::WebhookRegistration(
forge_alias,
repo_alias,
err.to_string(),
),
log.as_ref(),
);
}
Err(err) => tracing::warn!(?err, "registering webhook"),
}
}
.in_current_span()
.into_actor(self)
.wait(ctx);
tracing::debug!("registering webhook done");
}
}
}

View file

@ -14,14 +14,14 @@ impl Handler<actor::messages::ValidateRepo> for actor::RepoActor {
msg: actor::messages::ValidateRepo,
ctx: &mut Self::Context,
) -> Self::Result {
actor::logger(&self.log, "start: ValidateRepo");
actor::logger(self.log.as_ref(), "start: ValidateRepo");
// Message Token - make sure we are only triggered for the latest/current token
match self.token_status(msg.unwrap()) {
TokenStatus::Current => {} // do nothing
TokenStatus::Expired => {
actor::logger(
&self.log,
self.log.as_ref(),
format!("discarded: old message token: {}", self.message_token),
);
return; // message is expired
@ -29,24 +29,27 @@ impl Handler<actor::messages::ValidateRepo> for actor::RepoActor {
TokenStatus::New(message_token) => {
self.message_token = message_token;
actor::logger(
&self.log,
self.log.as_ref(),
format!("new message token: {}", self.message_token),
);
}
}
actor::logger(&self.log, format!("accepted token: {}", self.message_token));
actor::logger(
self.log.as_ref(),
format!("accepted token: {}", self.message_token),
);
// Repository positions
let Some(ref open_repository) = self.open_repository else {
actor::logger(&self.log, "no open repository");
actor::logger(self.log.as_ref(), "no open repository");
return;
};
actor::logger(&self.log, "have open repository");
actor::logger(self.log.as_ref(), "have open repository");
let Some(repo_config) = self.repo_details.repo_config.clone() else {
actor::logger(&self.log, "no repo config");
actor::logger(self.log.as_ref(), "no repo config");
return;
};
actor::logger(&self.log, "have repo config");
actor::logger(self.log.as_ref(), "have repo config");
match git::validation::positions::validate_positions(
&**open_repository,
@ -64,46 +67,50 @@ impl Handler<actor::messages::ValidateRepo> for actor::RepoActor {
actor::do_send(
ctx.address(),
actor::messages::CheckCIStatus::new(next),
&self.log,
self.log.as_ref(),
);
} else if next != dev {
actor::do_send(
ctx.address(),
actor::messages::AdvanceNext::new((next, dev_commit_history)),
&self.log,
self.log.as_ref(),
)
} else {
// do nothing
}
}
Err(git::validation::positions::Error::Retryable(message)) => {
actor::logger(&self.log, message);
actor::logger(self.log.as_ref(), message);
let addr = ctx.address();
let message_token = self.message_token;
let sleep_duration = self.sleep_duration;
let log = self.log.clone();
async move {
tracing::debug!("sleeping before retrying...");
actor::logger(&log, "before sleep");
actor::logger(log.as_ref(), "before sleep");
tokio::time::sleep(sleep_duration).await;
actor::logger(&log, "after sleep");
actor::logger(log.as_ref(), "after sleep");
actor::do_send(
addr,
actor::messages::ValidateRepo::new(message_token),
&log,
log.as_ref(),
);
}
.in_current_span()
.into_actor(self)
.wait(ctx);
}
Err(git::validation::positions::Error::NonRetryable(message))
| Err(git::validation::positions::Error::UserIntervention(message)) => {
actor::logger(&self.log, message);
Err(git::validation::positions::Error::UserIntervention(user_notification)) => {
actor::notify_user(
self.notify_user_recipient.as_ref(),
user_notification,
self.log.as_ref(),
)
}
Err(git::validation::positions::Error::NonRetryable(message)) => {
actor::logger(self.log.as_ref(), message);
}
}
tracing::debug!("Handler: ValidateRepo: finish");
}
}

View file

@ -17,23 +17,30 @@ impl Handler<WebhookNotification> for actor::RepoActor {
#[tracing::instrument(name = "RepoActor::WebhookMessage", skip_all, fields(token = %self.message_token, repo = %self.repo_details))]
fn handle(&mut self, msg: WebhookNotification, ctx: &mut Self::Context) -> Self::Result {
let Some(config) = &self.repo_details.repo_config else {
actor::logger(&self.log, "server has no repo config");
actor::logger(self.log.as_ref(), "server has no repo config");
warn!("No repo config");
return;
};
if validate_notification(&msg, &self.webhook_auth, &*self.forge, &self.log).is_err() {
if validate_notification(
&msg,
self.webhook_auth.as_ref(),
&*self.forge,
self.log.as_ref(),
)
.is_err()
{
return;
}
let body = msg.body();
match self.forge.parse_webhook_body(body) {
Err(err) => {
actor::logger(&self.log, "message parse error - not a push");
actor::logger(self.log.as_ref(), "message parse error - not a push");
warn!(?err, "Not a 'push'");
return;
}
Ok(push) => match push.branch(config.branches()) {
None => {
actor::logger(&self.log, "unknown branch");
actor::logger(self.log.as_ref(), "unknown branch");
warn!(
?push,
"Unrecognised branch, we should be filtering to only the ones we want"
@ -45,7 +52,7 @@ impl Handler<WebhookNotification> for actor::RepoActor {
push,
config.branches().main(),
&mut self.last_main_commit,
&self.log,
self.log.as_ref(),
)
.is_err()
{
@ -57,7 +64,7 @@ impl Handler<WebhookNotification> for actor::RepoActor {
push,
config.branches().next(),
&mut self.last_next_commit,
&self.log,
self.log.as_ref(),
)
.is_err()
{
@ -69,7 +76,7 @@ impl Handler<WebhookNotification> for actor::RepoActor {
push,
config.branches().dev(),
&mut self.last_dev_commit,
&self.log,
self.log.as_ref(),
)
.is_err()
{
@ -86,16 +93,16 @@ impl Handler<WebhookNotification> for actor::RepoActor {
actor::do_send(
ctx.address(),
actor::messages::ValidateRepo::new(message_token),
&self.log,
self.log.as_ref(),
);
}
}
fn validate_notification(
msg: &WebhookNotification,
webhook_auth: &Option<WebhookAuth>,
webhook_auth: Option<&WebhookAuth>,
forge: &dyn ForgeLike,
log: &Option<RepoActorLog>,
log: Option<&RepoActorLog>,
) -> Result<(), ()> {
let Some(expected_authorization) = webhook_auth else {
actor::logger(log, "server has no auth token");
@ -122,7 +129,7 @@ fn handle_push(
push: Push,
branch: BranchName,
last_commit: &mut Option<Commit>,
log: &Option<RepoActorLog>,
log: Option<&RepoActorLog>,
) -> Result<(), ()> {
actor::logger(log, "message is for dev branch");
let commit = git::Commit::from(push);

View file

@ -16,7 +16,7 @@ impl Handler<actor::messages::WebhookRegistered> for actor::RepoActor {
actor::do_send(
ctx.address(),
actor::messages::ValidateRepo::new(self.message_token),
&self.log,
self.log.as_ref(),
);
}
}

View file

@ -12,7 +12,8 @@ use actix::prelude::*;
use derive_more::Deref;
use git_next_config as config;
use git_next_git as git;
use git_next_git::{self as git, UserNotification};
use messages::NotifyUser;
use kxio::network::Network;
use tracing::{info, warn, Instrument};
@ -48,8 +49,10 @@ pub struct RepoActor {
net: Network,
forge: Box<dyn git::ForgeLike>,
log: Option<RepoActorLog>,
notify_user_recipient: Option<Recipient<NotifyUser>>,
}
impl RepoActor {
#[allow(clippy::too_many_arguments)]
pub fn new(
repo_details: git::RepoDetails,
forge: Box<dyn git::ForgeLike>,
@ -58,6 +61,7 @@ impl RepoActor {
net: Network,
repository_factory: Box<dyn git::repository::RepositoryFactory>,
sleep_duration: std::time::Duration,
notify_user_recipient: Option<Recipient<NotifyUser>>,
) -> Self {
let message_token = messages::MessageToken::default();
Self {
@ -76,6 +80,7 @@ impl RepoActor {
net,
sleep_duration,
log: None,
notify_user_recipient,
}
}
}
@ -105,12 +110,8 @@ impl Actor for RepoActor {
}
}
pub fn delay_send<M>(
addr: Addr<RepoActor>,
delay: Duration,
msg: M,
log: &Option<crate::RepoActorLog>,
) where
pub fn delay_send<M>(addr: Addr<RepoActor>, delay: Duration, msg: M, log: Option<&RepoActorLog>)
where
M: actix::Message + Send + 'static + std::fmt::Debug,
RepoActor: actix::Handler<M>,
<M as actix::Message>::Result: Send,
@ -122,7 +123,7 @@ pub fn delay_send<M>(
do_send(addr, msg, log)
}
pub fn do_send<M>(_addr: Addr<RepoActor>, msg: M, log: &Option<crate::RepoActorLog>)
pub fn do_send<M>(_addr: Addr<RepoActor>, msg: M, log: Option<&RepoActorLog>)
where
M: actix::Message + Send + 'static + std::fmt::Debug,
RepoActor: actix::Handler<M>,
@ -135,10 +136,23 @@ where
_addr.do_send(msg)
}
pub fn logger(log: &Option<crate::RepoActorLog>, message: impl Into<String>) {
pub fn logger(log: Option<&RepoActorLog>, message: impl Into<String>) {
if let Some(log) = log {
let message: String = message.into();
tracing::debug!(message);
let _ = log.write().map(|mut l| l.push(message));
}
}
pub fn notify_user(
recipient: Option<&Recipient<NotifyUser>>,
user_notification: UserNotification,
log: Option<&RepoActorLog>,
) {
let msg = NotifyUser::from(user_notification);
let log_message = format!("send: {:?}", msg);
tracing::debug!(log_message);
logger(log, log_message);
if let Some(recipient) = &recipient {
recipient.do_send(msg);
}
}

View file

@ -2,6 +2,7 @@
use config::newtype;
use derive_more::Display;
use git::UserNotification;
use git_next_actor_macros::message;
use git_next_config as config;
use git_next_git as git;
@ -63,3 +64,4 @@ Contains a tuple of the commit that was checked (the tip of the `next` branch) a
message!(AdvanceNext: (git::Commit, Vec<git::Commit>): "Request to advance the `next` branch on to the next commit on the `dev branch."); // next commit and the dev commit history
message!(AdvanceMain: git::Commit: "Request to advance the `main` branch on to same commit as the `next` branch."); // next commit
message!(WebhookNotification: config::webhook::forge_notification::ForgeNotification: "Notification of a webhook message from the forge.");
message!(NotifyUser: UserNotification: "Request to send the message payload to the notification webhook");

View file

@ -209,6 +209,7 @@ pub fn a_repo_actor(
net,
repository_factory,
std::time::Duration::from_nanos(1),
None,
)
.with_log(actors_log),
log,

View file

@ -45,16 +45,12 @@ async fn when_read_file_ok_should_send_config_loaded() -> TestResult {
//then
tracing::debug!(?log, "");
log.read().map_err(|e| e.to_string()).map(|l| {
assert!(l
.iter()
.any(|message| message.contains("send: LoadedConfig")))
})?;
log.require_message_containing("send: ReceiveRepoConfig")?;
log.no_message_contains("send: NotifyUsers")?;
Ok(())
}
#[actix::test]
#[ignore] //TODO: (#95) should notify user
async fn when_read_file_err_should_notify_user() -> TestResult {
//given
let fs = given::a_filesystem();
@ -80,13 +76,7 @@ async fn when_read_file_err_should_notify_user() -> TestResult {
//then
tracing::debug!(?log, "");
log.read().map_err(|e| e.to_string()).map(|l| {
assert!(l.iter().any(|message| message.contains("send: NotifyUser")));
assert!(
!l.iter()
.any(|message| message.contains("send: LoadedConfig")),
"not send LoadedConfig"
);
})?;
log.require_message_containing("send: NotifyUser")?;
log.no_message_contains("send: ReceiveRepoConfig")?;
Ok(())
}

View file

@ -88,7 +88,6 @@ async fn when_fail_should_recheck_after_delay() -> TestResult {
}
#[test_log::test(actix::test)]
#[ignore] //TODO: (#95) should notify user
async fn when_fail_should_notify_user() -> TestResult {
//given
let fs = given::a_filesystem();

View file

@ -36,7 +36,6 @@ async fn when_registered_ok_should_send_webhook_registered() -> TestResult {
}
#[actix::test]
#[ignore] //TODO: (#95) should notify user
async fn when_registered_error_should_send_notify_user() -> TestResult {
//given
let fs = given::a_filesystem();

View file

@ -279,7 +279,52 @@ async fn repo_with_dev_ahead_of_next_should_advance_next() -> TestResult {
Ok(())
}
// TODO: (#95) test: repo with dev not a child of main should notify user
#[test_log::test(actix::test)]
async fn repo_with_dev_not_ahead_of_main_should_notify_user() -> TestResult {
//given
let fs = given::a_filesystem();
let (mut open_repository, repo_details) = given::an_open_repository(&fs);
#[allow(clippy::unwrap_used)]
let repo_config = repo_details.repo_config.clone().unwrap();
// Validate repo branches
expect::fetch_ok(&mut open_repository);
let branches = repo_config.branches();
// commit_log main
let main_commit = expect::main_commit_log(&mut open_repository, branches.main());
// next - on main
let next_commit = main_commit.clone();
let next_branch_log = vec![next_commit.clone(), given::a_commit()];
// dev - not ahead of next
let dev_commit = given::a_named_commit("dev");
let dev_branch_log = vec![dev_commit];
// commit_log next
open_repository
.expect_commit_log()
.times(1)
.with(eq(branches.next()), eq([main_commit.clone()]))
.return_once(move |_, _| Ok(next_branch_log));
// commit_log dev
let dev_commit_log = dev_branch_log.clone();
open_repository
.expect_commit_log()
.times(1)
.with(eq(branches.dev()), eq([main_commit]))
.return_once(move |_, _| Ok(dev_commit_log));
//when
let (addr, log) = when::start_actor_with_open_repository(
Box::new(open_repository),
repo_details,
given::a_forge(),
);
addr.send(crate::messages::ValidateRepo::new(MessageToken::default()))
.await?;
System::current().stop();
//then
log.require_message_containing("send: NotifyUser")?;
Ok(())
}
#[test_log::test(actix::test)]
async fn should_accept_message_with_current_token() -> TestResult {
@ -382,7 +427,7 @@ async fn should_send_validate_repo_when_retryable_error() -> TestResult {
}
#[test_log::test(actix::test)]
async fn should_send_nothing_when_non_retryable_error() -> TestResult {
async fn should_send_notify_user_when_non_retryable_error() -> TestResult {
//given
let fs = given::a_filesystem();
let (mut open_repository, repo_details) = given::an_open_repository(&fs);
@ -424,6 +469,6 @@ async fn should_send_nothing_when_non_retryable_error() -> TestResult {
//then
log.require_message_containing("accepted token")?;
log.no_message_contains("send:")?;
log.require_message_containing("send: NotifyUser")?;
Ok(())
}

View file

@ -3,9 +3,9 @@ use actix::prelude::*;
use git_next_config::server::ServerConfig;
use git_next_file_watcher_actor::FileUpdated;
use crate::{messages::ReceiveServerConfig, Server};
use crate::{messages::ReceiveServerConfig, ServerActor};
impl Handler<FileUpdated> for Server {
impl Handler<FileUpdated> for ServerActor {
type Result = ();
fn handle(&mut self, _msg: FileUpdated, ctx: &mut Self::Context) -> Self::Result {

View file

@ -1,4 +1,5 @@
mod file_updated;
mod notify_user;
mod receive_server_config;
mod receive_valid_server_config;
mod shutdown;

View file

@ -1,12 +1,14 @@
//
use actix::prelude::*;
use git_next_repo_actor::messages::NotifyUser;
use crate::{messages::NotifyUser, WebhookActor};
use crate::ServerActor;
impl Handler<NotifyUser> for WebhookActor {
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
}
}

View file

@ -2,10 +2,10 @@ use actix::prelude::*;
use crate::{
messages::{ReceiveServerConfig, ReceiveValidServerConfig, ValidServerConfig},
Server,
ServerActor,
};
impl Handler<ReceiveServerConfig> for Server {
impl Handler<ReceiveServerConfig> for ServerActor {
type Result = ();
#[allow(clippy::cognitive_complexity)]

View file

@ -3,13 +3,13 @@ use git_next_webhook_actor::{AddWebhookRecipient, ShutdownWebhook, WebhookActor,
use crate::{
messages::{ReceiveValidServerConfig, ValidServerConfig},
Server,
ServerActor,
};
impl Handler<ReceiveValidServerConfig> for Server {
impl Handler<ReceiveValidServerConfig> for ServerActor {
type Result = ();
fn handle(&mut self, msg: ReceiveValidServerConfig, _ctx: &mut Self::Context) -> Self::Result {
fn handle(&mut self, msg: ReceiveValidServerConfig, ctx: &mut Self::Context) -> Self::Result {
let ValidServerConfig {
server_config,
socket_address,
@ -26,7 +26,13 @@ impl Handler<ReceiveValidServerConfig> for Server {
// Forge Actors
for (forge_alias, forge_config) in server_config.forges() {
let repo_actors = self
.create_forge_repos(forge_config, forge_alias.clone(), &server_storage, webhook)
.create_forge_repos(
forge_config,
forge_alias.clone(),
&server_storage,
webhook,
ctx.address().recipient(),
)
.into_iter()
.map(|a| self.start_actor(a))
.collect::<Vec<_>>();

View file

@ -2,9 +2,9 @@
use actix::prelude::*;
use git_next_webhook_actor::ShutdownWebhook;
use crate::{messages::Shutdown, Server};
use crate::{messages::Shutdown, ServerActor};
impl Handler<Shutdown> for Server {
impl Handler<Shutdown> for ServerActor {
type Result = ();
fn handle(&mut self, _msg: Shutdown, _ctx: &mut Self::Context) -> Self::Result {

View file

@ -10,6 +10,7 @@ use git_next_config as config;
use git_next_config::server::{InboundWebhook, ServerConfig, ServerStorage};
use git_next_config::{ForgeAlias, ForgeConfig, GitDir, RepoAlias, ServerRepoConfig};
use git_next_git::{Generation, RepoDetails};
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};
@ -43,7 +44,7 @@ type Result<T> = core::result::Result<T, Error>;
#[derive(derive_with::With)]
#[with(message_log)]
pub struct Server {
pub struct ServerActor {
generation: Generation,
webhook: Option<Addr<WebhookActor>>,
fs: FileSystem,
@ -55,11 +56,11 @@ pub struct Server {
// testing
message_log: Option<Arc<RwLock<Vec<String>>>>,
}
impl Actor for Server {
impl Actor for ServerActor {
type Context = Context<Self>;
}
impl Server {
impl ServerActor {
pub fn new(
fs: FileSystem,
net: Network,
@ -105,6 +106,7 @@ impl Server {
forge_name: ForgeAlias,
server_storage: &ServerStorage,
webhook: &InboundWebhook,
notify_user_recipient: Recipient<NotifyUser>,
) -> Vec<(ForgeAlias, RepoAlias, RepoActor)> {
let span =
tracing::info_span!("create_forge_repos", name = %forge_name, config = %forge_config);
@ -114,7 +116,11 @@ impl Server {
let mut repos = vec![];
let creator = self.create_actor(forge_name, forge_config.clone(), server_storage, webhook);
for (repo_alias, server_repo_config) in forge_config.repos() {
let forge_repo = creator((repo_alias, server_repo_config));
let forge_repo = creator((
repo_alias,
server_repo_config,
notify_user_recipient.clone(),
));
info!(
alias = %forge_repo.1,
"Created Repo"
@ -130,14 +136,17 @@ impl Server {
forge_config: ForgeConfig,
server_storage: &ServerStorage,
webhook: &InboundWebhook,
) -> impl Fn((RepoAlias, &ServerRepoConfig)) -> (ForgeAlias, RepoAlias, RepoActor) {
) -> impl Fn(
(RepoAlias, &ServerRepoConfig, Recipient<NotifyUser>),
) -> (ForgeAlias, RepoAlias, RepoActor) {
let server_storage = server_storage.clone();
let webhook = webhook.clone();
let net = self.net.clone();
let repository_factory = self.repository_factory.duplicate();
let generation = self.generation;
let sleep_duration = self.sleep_duration;
move |(repo_alias, server_repo_config)| {
// let notify_user_recipient = server_addr.recipient();
move |(repo_alias, server_repo_config, notify_user_recipient)| {
let span = tracing::info_span!("create_actor", alias = %repo_alias, config = %server_repo_config);
let _guard = span.enter();
info!("Creating Repo");
@ -173,6 +182,7 @@ impl Server {
net.clone(),
repository_factory.duplicate(),
sleep_duration,
Some(notify_user_recipient),
);
(forge_name.clone(), repo_alias, actor)
}

View file

@ -1,5 +1,5 @@
//
use crate::{tests::given, ReceiveServerConfig, Server};
use crate::{tests::given, ReceiveServerConfig, ServerActor};
use actix::prelude::*;
use git_next_config::server::{Http, InboundWebhook, Notification, ServerConfig, ServerStorage};
use std::{
@ -17,7 +17,7 @@ async fn when_webhook_url_has_trailing_slash_should_not_send() {
let duration = std::time::Duration::from_millis(1);
// sut
let server = Server::new(fs.clone(), net.into(), repo, duration);
let server = ServerActor::new(fs.clone(), net.into(), repo, duration);
// collaborators
let http = Http::new("0.0.0.0".to_string(), 80);

View file

@ -1,7 +1,7 @@
//
use actix::prelude::*;
use git_next_file_watcher_actor::{FileUpdated, FileWatcher};
use git_next_server_actor::Server;
use git_next_server_actor::ServerActor;
use kxio::{fs::FileSystem, network::Network};
use std::path::PathBuf;
use tracing::{error, info, level_filters::LevelFilter};
@ -40,7 +40,7 @@ pub fn start(
info!("Starting Server...");
let execution = async move {
let server = Server::new(fs.clone(), net.clone(), repo, sleep_duration).start();
let server = ServerActor::new(fs.clone(), net.clone(), repo, sleep_duration).start();
server.do_send(FileUpdated);
info!("Starting File Watcher...");

View file

@ -1,2 +1 @@
mod notify_user;
mod shutdown_webhook;

View file

@ -2,5 +2,3 @@
use git_next_actor_macros::message;
message!(ShutdownWebhook: "Request to shutdown the Webhook actor");
message!(NotifyUser: String: "Request to send the message payload to the notification webhook");