CI status updates sent as direct message to author of commit

documentation/config_docs.md

@@ -163,7 +163,7 @@ The following takes place when a status notification is received.
    - `failure`: `allow`
    - `error`: `allow`
    - `success`: `allow_once`
-1. For those payloads allowed by step 1, if it isn't a main branch build notification, route to the default channel to reduce spam in topic channels. Otherwise, check the notification commit's files according to the prefix rules.
+1. For those payloads allowed by step 1, if it isn't a main branch build notification, query for a slack profile that matches the author of the commit and direct message them. If no profile is found, route to default channel to reduce spam in topic channels. Otherwise, check the notification commit's files according to the prefix rules.
 
 Internally, the bot keeps track of the status of the last allowed payload, for a given pipeline and branch. This information is used to evaluate the status rules (see below).
 

lib/action.ml

@@ -99,7 +99,14 @@ module Action (Github_api : Api.Github) (Slack_api : Api.Slack) = struct
     let current_status = n.state in
     let rules = cfg.status_rules.rules in
     let action_on_match (branches : branch list) =
-      let default = Option.to_list cfg.prefix_rules.default_channel in
+      let%lwt default =
+        match%lwt Slack_api.lookup_user ~ctx ~cfg ~email:n.commit.commit.author.email with
+        (* To send a DM, channel parameter is set to the user id of the recipient *)
+        | Ok res -> Lwt.return [ res.user.id ]
+        | Error e ->
+          log#warn "couldn't match commit email to slack profile: %s" e;
+          Lwt.return (Option.to_list cfg.prefix_rules.default_channel)
+      in
       let%lwt () = State.set_repo_pipeline_status ctx.state repo.url ~pipeline ~branches ~status:current_status in
       match List.is_empty branches with
       | true -> Lwt.return []

lib/api.ml

@@ -18,6 +18,7 @@ module type Github = sig
 end
 
 module type Slack = sig
+  val lookup_user : ctx:Context.t -> cfg:Config_t.config -> email:string -> lookup_user_res slack_response Lwt.t
   val send_notification : ctx:Context.t -> msg:post_message_req -> unit slack_response Lwt.t
 
   val send_chat_unfurl

lib/api_local.ml

@@ -52,6 +52,7 @@ end
 
 (** The base implementation for local check payload debugging and mocking tests *)
 module Slack_base : Api.Slack = struct
+  let lookup_user ~ctx:_ ~cfg:_ ~email:_ = Lwt.return @@ Error "undefined for local setup"
   let send_notification ~ctx:_ ~msg:_ = Lwt.return @@ Error "undefined for local setup"
   let send_chat_unfurl ~ctx:_ ~channel:_ ~ts:_ ~unfurls:_ () = Lwt.return @@ Error "undefined for local setup"
   let send_auth_test ~ctx:_ () = Lwt.return @@ Error "undefined for local setup"
@@ -61,6 +62,18 @@ end
 module Slack : Api.Slack = struct
   include Slack_base
 
+  let lookup_user ~ctx:_ ~(cfg : Config_t.config) ~email =
+    let email = List.Assoc.find cfg.user_mappings ~equal:String.equal email |> Option.value ~default:email in
+    let mock_user =
+      {
+        Slack_t.id = sprintf "id[%s]" email;
+        name = sprintf "name[%s]" email;
+        real_name = sprintf "real_name[%s]" email;
+      }
+    in
+    let mock_response = { Slack_t.user = mock_user } in
+    Lwt.return @@ Ok mock_response
+
   let send_notification ~ctx:_ ~msg =
     let json = msg |> Slack_j.string_of_post_message_req |> Yojson.Basic.from_string |> Yojson.Basic.pretty_to_string in
     Stdio.printf "will notify #%s\n" msg.channel;

lib/api_remote.ml

@@ -117,6 +117,15 @@ module Slack : Api.Slack = struct
     (* must read whole response to update lexer state *)
     ignore (Slack_j.read_ok_res s l)
 
+  (** [lookup_user cfg email] queries slack for a user profile with [email] *)
+  let lookup_user ~(ctx : Context.t) ~(cfg : Config_t.config) ~email =
+    (* Check if config holds the Github to Slack email mapping  *)
+    let email = List.Assoc.find cfg.user_mappings ~equal:String.equal email |> Option.value ~default:email in
+    let data = Slack_j.string_of_lookup_user_req { Slack_t.email } in
+    request_token_auth ~name:"lookup user by email"
+      ~body:(`Raw ("application/json", data))
+      ~ctx `GET "users.lookupByEmail" Slack_j.read_lookup_user_res
+
   (** [send_notification ctx msg] notifies [msg.channel] with the payload [msg];
       uses web API with access token if available, or with webhook otherwise *)
   let send_notification ~(ctx : Context.t) ~(msg : Slack_t.post_message_req) =

lib/config.atd

@@ -37,6 +37,7 @@ type config = {
   ~project_owners <ocaml default="{rules = []}"> : project_owners;
   ~ignored_users <ocaml default="[]">: string list; (* list of ignored users *)
   ?main_branch_name : string nullable; (* the name of the main branch; used to filter out notifications about merges of main branch into other branches *)
+  ~user_mappings <ocaml default="[]">: (string * string) list <json repr="object"> (* list of github to slack profile mappings *)
 }
 
 (* This specifies the Slack webhook to query to post to the channel with the given name *)

lib/slack.atd

@@ -67,6 +67,20 @@ type post_message_res = {
   channel: string;
 }
 
+type lookup_user_req = {
+  email: string;
+}
+
+type lookup_user_res = {
+  user: user;
+}
+
+type user = {
+  id: string;
+  name: string;
+  real_name: string;
+}
+
 type link_shared_link = {
   domain: string;
   url: string;

test/monorobot.json

@@ -95,5 +95,8 @@
                 "channel": "frontend-bot"
             }
         ]
+    },
+    "user_mappings": {
+        "[email protected]": "[email protected]"
     }
 }

test/slack_payloads.expected

@@ -497,9 +497,9 @@ will notify #longest-a1
 }
 ===== file ../mock_payloads/status.cancelled_test.json =====
 ===== file ../mock_payloads/status.failure_test.json =====
-will notify #default
+will notify #id[[email protected]]
 {
-  "channel": "default",
+  "channel": "id[[email protected]]",
   "text": "<https://github.com/ahrefs/monorepo|[ahrefs/monorepo]> CI Build Status notification for <https://buildkite.com/org/pipeline2/builds/2|buildkite/pipeline2>: failure",
   "attachments": [
     {
@@ -520,9 +520,9 @@ will notify #default
 ===== file ../mock_payloads/status.state_hide_success_test.json =====
 ===== file ../mock_payloads/status.state_hide_success_test_disallowed_pipeline.json =====
 ===== file ../mock_payloads/status.success_public_repo_no_buildkite.json =====
-will notify #default
+will notify #id[[email protected]]
 {
-  "channel": "default",
+  "channel": "id[[email protected]]",
   "text": "<https://github.com/Codertocat/Hello-World|[Codertocat/Hello-World]> CI Build Status notification: success",
   "attachments": [
     {
@@ -557,9 +557,9 @@ will notify #all-push-events
   ]
 }
 ===== file ../mock_payloads/status.success_test_non_main_branch.json =====
-will notify #default
+will notify #id[[email protected]]
 {
-  "channel": "default",
+  "channel": "id[[email protected]]",
   "text": "<https://github.com/ahrefs/monorepo|[ahrefs/monorepo]> CI Build Status notification for <https://buildkite.com/org/pipeline2/builds/2|buildkite/pipeline2>: success",
   "attachments": [
     {