cfg and action: add support to ignore comments from certain users

Author: dombong

documentation/config_docs.md

@@ -15,6 +15,9 @@ Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks
 ```json
 {
     "main_branch_name": "develop",
+    "ignored_users": [
+        "ignored_user"
+    ],
     "prefix_rules": {
         ...
     },
@@ -37,6 +40,7 @@ Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks
 | `prefix_rules` | prefix rules config object | required field |
 | `status_rules` | status rules config object | all status notifications are ignored |
 | `project_owners` | project owners config object | no project owners are defined |
+| `ignored_users` | list of users to be ignored on all notifications | no user is ignored |
 
 ## Label Options
 

lib/action.ml

@@ -155,9 +155,28 @@ module Action (Github_api : Api.Github) (Slack_api : Api.Slack) = struct
         )
       )
 
-  let generate_notifications (ctx : Context.t) req =
+  let ignore_notifications_from_user cfg req =
+    let sender_login =
+      match req with
+      | Github.Push n -> Some n.sender.login
+      | Pull_request n -> Some n.sender.login
+      | PR_review n -> Some n.sender.login
+      | PR_review_comment n -> Some n.sender.login
+      | Issue n -> Some n.sender.login
+      | Issue_comment n -> Some n.sender.login
+      | Commit_comment n -> Some n.sender.login
+      | _ -> None
+    in
+    match sender_login with
+    | Some sender_login -> List.exists cfg.ignored_users ~f:(String.equal sender_login)
+    | None -> false
+
+  let generate_notifications (ctx : Context.t) (req : Github.t) =
     let repo = Github.repo_of_notification req in
     let cfg = Context.find_repo_config_exn ctx repo.url in
+    match ignore_notifications_from_user cfg req with
+    | true -> Lwt.return []
+    | false ->
     match req with
     | Github.Push n ->
       partition_push cfg n |> List.map ~f:(fun (channel, n) -> generate_push_notification n channel) |> Lwt.return

lib/config.atd

@@ -35,6 +35,7 @@ type config = {
   label_rules : label_rules;
   ~status_rules <ocaml default="{allowed_pipelines = Some []; rules = []}"> : status_rules;
   ~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 *)
 }
 

test/monorobot.json

@@ -18,6 +18,9 @@
             }
         ]
     },
+    "ignored_users": [
+        "ignored_user"
+    ],
     "prefix_rules": {
         "default_channel": "default",
         "filter_main_branch": true,
@@ -64,9 +67,6 @@
     },
     "label_rules": {
         "default_channel": "default",
-        "ignored_users": [
-            "ignored_user"
-        ],
         "rules": [
             {
                 "match": [

test/slack_payloads.expected

@@ -128,19 +128,6 @@ will notify #default
   ]
 }
 ===== file ../mock_payloads/issue_comment.created_in_issue_by_ignored.json =====
-will notify #default
-{
-  "channel": "default",
-  "text": "<https://github.com/sewenthy/monorobot|[sewenthy/monorobot]> *ignored_user* <https://github.com/sewenthy/monorobot/pull/1#issuecomment-1286545775|commented> on #1 <https://github.com/sewenthy/monorobot/pull/1|something test>",
-  "attachments": [
-    {
-      "fallback": null,
-      "mrkdwn_in": [ "text" ],
-      "color": "#ccc",
-      "text": "new comment"
-    }
-  ]
-}
 ===== file ../mock_payloads/issue_comment.created_in_pr.json =====
 will notify #a1-bot
 {