Merge pull request #69 from ahrefs/feature/#43

pick up filtering rules from the repo itself

Author: yasunariw

README.md

@@ -20,8 +20,7 @@ and use resulting `_build/default/src/notabot.exe` binary.
 
 ## Running
 
-Configuration is read at startup from `notabot.json` and `secrets.json` files
-according to `lib/notabot.atd` schema.
+At startup time, secrets are read from the local `secrets.json` file. The main configuration is read remotely from a `notabot.json` file in the default branch, and its schema is defined in `lib/notabot.atd`.
 
 ### Documentation
 

documentation/config_docs.md

@@ -36,15 +36,16 @@ Config file is where the variables affecting the behaviour of notabot are define
 **example**
 ```json
 "status_rules": {
-    "name": [
+    "title": [
         "default",
         "buildkite/pipeline2"
     ],
     "status": {
         "pending": false,
-        "success": true,
+        "success": "once",
         "failure": true,
-        "error": true
+        "error": true,
+        "cancelled": "^\\(Build #[0-9]+ canceled by .+\\|Failed (exit status 255)\\)$"
     }
 },
 ```
@@ -56,7 +57,16 @@ Config file is where the variables affecting the behaviour of notabot are define
 
 ### Status State
 
-A json object with fields of bools for each status type. Set them to true to suppress status of that type.
+A json object with fields of bools for each status type.
+
+| value | description | optional | default |
+|-|-|-|-|
+| `pending` | `true` to notify; `false` to ignore | No | - |
+| `success` | `true` to notify; `false` to notify all; `"once"` to notify the first and ignore subsequent consecutive successes| No | - |
+| `failure` | `true` to notify; `false` to ignore | No | - |
+| `error` | `true` to notify; `false` to ignore | No | - |
+| `cancelled` | provide regex to ignore `failure` notifications with a description that matches it | Yes | - |
+
 
 ## Label Config
 

lib/action.ml

@@ -118,22 +118,22 @@ let partition_push cfg n =
     | [] -> None
     | l -> Some (chan, { n with commits = l }))
 
-let filter_label rules label =
+let filter_label rules (label : Github_j.label) =
   rules
   |> List.filter_map ~f:(fun rule ->
        match touching_label rule label.name with
        | false -> None
        | true -> Some rule.chan)
 
-let partition_label cfg labels =
+let partition_label cfg (labels : Github_j.label list) =
   let default = Option.to_list cfg.label_rules.default in
   match labels with
   | [] -> default
   | labels ->
     let rules = cfg.label_rules.rules in
     let channels =
       labels
-      |> List.map ~f:(fun label ->
+      |> List.map ~f:(fun (label : Github_j.label) ->
            match filter_label rules label with
            | [] -> default
            | l -> l)
@@ -224,7 +224,7 @@ let partition_status (ctx : Context.t) (n : status_notification) =
     match List.exists n.branches ~f:(fun { name } -> String.equal name main_branch_name) with
     | false -> default ()
     | true ->
-      ( match%lwt Github.generate_query_commmit cfg ~url:n.commit.url ~sha:n.commit.sha with
+      ( match%lwt Github.generate_query_commit cfg ~url:n.commit.url ~sha:n.commit.sha with
       | None -> default ()
       | Some commit ->
         (*

lib/config.ml

@@ -96,7 +96,11 @@ let make (json_config : Notabot_t.config) (secrets : Notabot_t.secrets) =
     status_rules;
   }
 
-let load path secrets =
-  let config = Notabot_j.config_of_string @@ Stdio.In_channel.read_all path in
-  let secrets = Notabot_j.secrets_of_string @@ Stdio.In_channel.read_all secrets in
+let load_config_file ~config_path = Notabot_j.config_of_string @@ Stdio.In_channel.read_all config_path
+
+let load_secrets_file ~secrets_path = Notabot_j.secrets_of_string @@ Stdio.In_channel.read_all secrets_path
+
+let load ~config_path ~secrets_path =
+  let config = load_config_file ~config_path in
+  let secrets = load_secrets_file ~secrets_path in
   make config secrets

lib/context.ml

@@ -1,23 +1,76 @@
+open Devkit
+
+let log = Log.from "context"
+
+exception Context_error of string
+
+type cfg_make_args =
+  | LocalMake of string
+  | RemoteMake of string * Github.t
+
+type cfg_origin =
+  | Local
+  | Remote
+
 type data = {
-  cfg : string;
-  secrets : string;
-  state : string;
+  mutable cfg_path : string;
+  mutable cfg_filename : string;
+  cfg_source : cfg_origin;
+  cfg_action_after_refresh : Config.t -> unit;
+  secrets_path : string;
+  state_path : string;
   disable_write : bool;
 }
 
 type t = {
   mutable state : Notabot_t.state;
   mutable cfg : Config.t;
+  secrets : Notabot_t.secrets;
   data : data;
 }
 
-let refresh_config ctx = ctx.cfg <- Config.load ctx.data.cfg ctx.data.secrets
+type context_thunk = {
+  secrets : Notabot_j.secrets;
+  thunk : ?req:Github.t -> unit -> t Lwt.t;
+  mutable ctx : t option;
+}
+
+let get_secrets secrets_path = Config.load_secrets_file ~secrets_path
+
+let load_config_json_local config_path = Lwt.return @@ Config.load_config_file ~config_path
+
+let resolve_cfg_getter = function
+  | Local -> load_config_json_local
+  | Remote -> Github.load_config_json
+
+let refresh_config ctx =
+  ( match ctx.data.cfg_source with
+  | Local -> log#info "attempting to retrieve config locally"
+  | Remote ->
+  match ctx.secrets.gh_token with
+  | None -> log#info "attempting to retrieve config remotely without gh_token"
+  | Some _ -> log#info "attempting to retrieve config remotely with gh_token"
+  );
+  let getter = resolve_cfg_getter ctx.data.cfg_source in
+  let%lwt cfg_json = getter ctx.data.cfg_path in
+  ctx.cfg <- Config.make cfg_json ctx.secrets;
+  ctx.data.cfg_action_after_refresh ctx.cfg;
+  Lwt.return_unit
 
 let refresh_and_get_config ctx =
-  refresh_config ctx;
-  ctx.cfg
+  let%lwt () = refresh_config ctx in
+  Lwt.return ctx.cfg
+
+let change_remote_url filename ctx req =
+  match ctx.data.cfg_source with
+  | Local -> raise @@ Context_error "can't load remote config from a local context"
+  | Remote ->
+    ctx.data.cfg_filename <- filename;
+    let url = Github.get_remote_config_json_url filename ?token:ctx.secrets.gh_token req in
+    ctx.data.cfg_path <- url;
+    refresh_config ctx
 
-let refresh_state ctx = ctx.state <- State.load ctx.data.state
+let refresh_state ctx = ctx.state <- State.load ctx.data.state_path
 
 let refresh_and_get_state ctx =
   refresh_state ctx;
@@ -26,15 +79,62 @@ let refresh_and_get_state ctx =
 let update_state ctx event =
   ctx.state <- State.update_state ctx.state event;
   match ctx.data.disable_write with
-  | false -> State.save ctx.data.state ctx.state
+  | false -> State.save ctx.data.state_path ctx.state
   | true -> ()
 
 let update_and_get_state ctx event =
   update_state ctx event;
   ctx.state
 
-let make ~state_path ~cfg_path ~secrets_path ?(disable_write = false) () =
-  let cfg = Config.load cfg_path secrets_path in
+let make_with_secrets ~state_path ~cfg_args ~secrets_path ~(secrets : Notabot_t.secrets) ?(disable_write = false)
+  ?(cfg_action_after_refresh = fun _ -> ()) ()
+  =
+  let data_cfg_path, cfg_source, cfg_json, cfg_filename =
+    match cfg_args with
+    | LocalMake p -> p, Local, load_config_json_local p, p
+    | RemoteMake (filename, r) ->
+      let token = secrets.gh_token in
+      let url = Github.get_remote_config_json_url filename ?token r in
+      let cfg_json = Github.load_config_json @@ Github.get_remote_config_json_url filename ?token r in
+      url, Remote, cfg_json, filename
+  in
+  let%lwt cfg_json = cfg_json in
+  let data =
+    {
+      cfg_path = data_cfg_path;
+      cfg_source;
+      cfg_action_after_refresh;
+      secrets_path;
+      state_path;
+      disable_write;
+      cfg_filename;
+    }
+  in
+  let cfg = Config.make cfg_json secrets in
   let state = State.load state_path in
-  let data = { cfg = cfg_path; secrets = secrets_path; state = state_path; disable_write } in
-  { cfg; state; data }
+  Lwt.return { cfg; state; secrets; data }
+
+let make ~state_path ~cfg_args ~secrets_path ?disable_write ?cfg_action_after_refresh () =
+  let secrets = get_secrets secrets_path in
+  make_with_secrets ~state_path ~cfg_args ~secrets_path ~secrets ?disable_write ?cfg_action_after_refresh ()
+
+let make_thunk ~state_path ~cfg_path_or_remote_filename ~secrets_path ?disable_write ?cfg_action_after_refresh () =
+  let secrets = get_secrets secrets_path in
+  let make_args ?req () =
+    match req with
+    | None -> LocalMake cfg_path_or_remote_filename
+    | Some r -> RemoteMake (cfg_path_or_remote_filename, r)
+  in
+  let thunk ?req () =
+    make_with_secrets ~state_path ~cfg_args:(make_args ?req ()) ~secrets_path ~secrets ?disable_write
+      ?cfg_action_after_refresh ()
+  in
+  { secrets; thunk; ctx = None }
+
+let resolve_ctx_in_thunk ctx_thunk req =
+  match ctx_thunk.ctx with
+  | Some ctx -> Lwt.return ctx
+  | None ->
+    let%lwt ctx = ctx_thunk.thunk ~req () in
+    let%lwt () = Lwt.return @@ (ctx_thunk.ctx <- Some ctx) in
+    Lwt.return ctx

lib/context.mli

@@ -0,0 +1,76 @@
+exception Context_error of string
+
+type cfg_make_args =
+  | LocalMake of string
+  | RemoteMake of string * Github.t
+
+type cfg_origin =
+  | Local
+  | Remote
+
+type data = {
+  mutable cfg_path : string;
+  mutable cfg_filename : string;
+  cfg_source : cfg_origin;
+  cfg_action_after_refresh : Config.t -> unit;
+  secrets_path : string;
+  state_path : string;
+  disable_write : bool;
+}
+
+type t = {
+  mutable state : Notabot_t.state;
+  mutable cfg : Config.t;
+  secrets : Notabot_t.secrets;
+  data : data;
+}
+
+type context_thunk = {
+  secrets : Notabot_j.secrets;
+  thunk : ?req:Github.t -> unit -> t Lwt.t;
+  mutable ctx : t option;
+}
+
+val refresh_config : t -> unit Lwt.t
+
+val refresh_and_get_config : t -> Config.t Lwt.t
+
+val change_remote_url : string -> t -> Github.t -> unit Lwt.t
+
+val refresh_state : t -> unit
+
+val refresh_and_get_state : t -> Notabot_t.state
+
+val update_state : t -> Github.t -> unit
+
+val update_and_get_state : t -> Github.t -> Notabot_t.state
+
+val make_with_secrets
+  :  state_path:string ->
+  cfg_args:cfg_make_args ->
+  secrets_path:string ->
+  secrets:Notabot_t.secrets ->
+  ?disable_write:bool ->
+  ?cfg_action_after_refresh:(Config.t -> unit) ->
+  unit ->
+  t Lwt.t
+
+val make
+  :  state_path:string ->
+  cfg_args:cfg_make_args ->
+  secrets_path:string ->
+  ?disable_write:bool ->
+  ?cfg_action_after_refresh:(Config.t -> unit) ->
+  unit ->
+  t Lwt.t
+
+val make_thunk
+  :  state_path:string ->
+  cfg_path_or_remote_filename:string ->
+  secrets_path:string ->
+  ?disable_write:bool ->
+  ?cfg_action_after_refresh:(Config.t -> unit) ->
+  unit ->
+  context_thunk
+
+val resolve_ctx_in_thunk : context_thunk -> Github.t -> t Lwt.t

lib/dune

@@ -1,7 +1,8 @@
 (library
  (name lib)
  (libraries atdgen atdgen-runtime base base.caml biniou cstruct curl curl.lwt
-   devkit devkit.core hex lwt lwt.unix nocrypto omd re stdio uri yojson)
+   devkit devkit.core extlib hex lwt lwt.unix nocrypto omd re stdio uri
+   yojson)
  (preprocess
   (pps lwt_ppx)))
 

lib/github.atd

@@ -231,3 +231,11 @@ type commit_comment_notification = {
   comment: comment;
   sender: user;
 }
+
+type content_api_response = {
+  name : string;
+  path : string;
+  size : int;
+  encoding : string;
+  content : string;
+}