move project atd bindings into separate files based on use case

state types are in `state.atd`; config options (both repo + secret) are
in `config.atd`; rule-related types are in `rule.atd`

Author: yasunariw

lib/action.ml

@@ -2,7 +2,8 @@ open Devkit
 open Printf
 open Base
 open Slack
-open Notabot_t
+open Config_t
+open Rule_t
 open Config
 open Common
 open Github_j
@@ -15,7 +16,7 @@ type prefix_match =
 
 let chan_of_prefix_rule (r : prefix_rule) = r.channel_name
 
-let touching_prefix (rule : Notabot_t.prefix_rule) name =
+let touching_prefix (rule : prefix_rule) name =
   let match_lengths filename prefixes =
     List.filter_map
       ~f:(fun prefix -> if String.is_prefix filename ~prefix then Some (String.length prefix) else None)

lib/config.atd

@@ -0,0 +1,46 @@
+type status_state <ocaml from="Rule"> = abstract
+type prefix_rule <ocaml from="Rule"> = abstract
+type label_rule <ocaml from="Rule"> = abstract
+
+(* This type of rule is used for CI build notifications. *)
+type status_rules = {
+  ?allowed_pipelines: string list option; (* keep only status events with a title matching this list *)
+  rules: status_state;
+}
+
+(* This type of rule is used for CI build notifications. *)
+type prefix_rules = {
+  ?default_channel: string nullable; (* if none of the rules is matching *)
+  rules: prefix_rule list;
+}
+
+(* This type of rule is used for events that must be routed based on the
+  files they are related to. *)
+type label_rules = {
+  ?default_channel: string nullable; (* if none of the rules is matching *)
+  rules: label_rule list;
+}
+
+(* This is the structure of the repository configuration file. It should be at the
+   root of the monorepo, on the main branch. *)
+type config = {
+  prefix_rules : prefix_rules;
+  label_rules : label_rules;
+  status_rules : status_rules;
+  ?main_branch_name: string option; (* used to filter out notifications about merges of main branch into other branches *)
+  ?offline: string option; (* where to find github api data when http calls are not allowed *)
+}
+
+(* This specifies the Slack webhook to query to post to the channel with the given name *)
+type webhook = {
+  url : string; (* url to call to send the message *)
+  channel : string; (* name of the channel where the message will be posted *)
+}
+
+(* This is the structure of the secrets file which stores sensitive information, and
+   shouldn't be checked into version control.  *)
+type secrets = {
+  slack_hooks : webhook list;
+  ?gh_token: string option; (* must not be specified for public repositories *)
+  ?gh_webhook_secret: string option; (* if not specified - signatures will not be checked *)
+}

lib/config.ml

@@ -13,35 +13,35 @@ type status_rules = {
 
 type t = {
   chans : string Chan_map.t;
-  prefix_rules : Notabot_t.prefix_rules;
-  label_rules : Notabot_t.label_rules;
+  prefix_rules : Config_t.prefix_rules;
+  label_rules : Config_t.label_rules;
   gh_webhook_secret : string option;
   main_branch_name : string option;
   gh_token : string option;
   offline : string option;
   status_rules : status_rules;
 }
 
-let make (json_config : Notabot_t.config) (secrets : Notabot_t.secrets) =
+let make (json_config : Config_t.config) (secrets : Config_t.secrets) =
   let chans =
     List.fold_left
-      (fun acc (webhook : Notabot_t.webhook) ->
+      (fun acc (webhook : Config_t.webhook) ->
         match Chan_map.find_opt webhook.channel acc with
         | None -> Chan_map.add webhook.channel webhook.url acc
         | Some c -> Exn.fail "chan %s is defined multiple time in the config" c)
       Chan_map.empty secrets.slack_hooks
   in
   let () =
     List.iteri
-      (fun i ({ channel_name; _ } : Notabot_t.prefix_rule) ->
+      (fun i ({ channel_name; _ } : Config_t.prefix_rule) ->
         match Chan_map.find_opt channel_name chans with
         | None -> Exn.fail "chan %s in prefix_rules %d is missing from slack_hooks" channel_name i
         | Some _ -> ())
       json_config.prefix_rules.rules
   in
   let () =
     List.iteri
-      (fun i ({ channel_name; _ } : Notabot_t.label_rule) ->
+      (fun i ({ channel_name; _ } : Config_t.label_rule) ->
         match Chan_map.find_opt channel_name chans with
         | None -> Exn.fail "chan %s in labels_rules %d is missing from slack_hooks" channel_name i
         | Some _ -> ())
@@ -96,9 +96,9 @@ let make (json_config : Notabot_t.config) (secrets : Notabot_t.secrets) =
     status_rules;
   }
 
-let load_config_file ~config_path = Notabot_j.config_of_string @@ Stdio.In_channel.read_all config_path
+let load_config_file ~config_path = Config_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_secrets_file ~secrets_path = Config_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

lib/context.ml

@@ -23,14 +23,14 @@ type data = {
 }
 
 type t = {
-  mutable state : Notabot_t.state;
+  mutable state : State_t.state;
   mutable cfg : Config.t;
-  secrets : Notabot_t.secrets;
+  secrets : Config_t.secrets;
   data : data;
 }
 
 type context_thunk = {
-  secrets : Notabot_j.secrets;
+  secrets : Config_t.secrets;
   thunk : ?req:Github.t -> unit -> t Lwt.t;
   mutable ctx : t option;
 }
@@ -86,7 +86,7 @@ let update_and_get_state ctx event =
   update_state ctx event;
   ctx.state
 
-let make_with_secrets ~state_path ~cfg_args ~secrets_path ~(secrets : Notabot_t.secrets) ?(disable_write = false)
+let make_with_secrets ~state_path ~cfg_args ~secrets_path ~(secrets : Config_t.secrets) ?(disable_write = false)
   ?(cfg_action_after_refresh = fun _ -> ()) ()
   =
   let data_cfg_path, cfg_source, cfg_json, cfg_filename =

lib/context.mli

@@ -19,14 +19,14 @@ type data = {
 }
 
 type t = {
-  mutable state : Notabot_t.state;
+  mutable state : State_t.state;
   mutable cfg : Config.t;
-  secrets : Notabot_t.secrets;
+  secrets : Config_t.secrets;
   data : data;
 }
 
 type context_thunk = {
-  secrets : Notabot_j.secrets;
+  secrets : Config_t.secrets;
   thunk : ?req:Github.t -> unit -> t Lwt.t;
   mutable ctx : t option;
 }
@@ -39,17 +39,17 @@ 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 refresh_and_get_state : t -> State_t.state
 
 val update_state : t -> Github.t -> unit
 
-val update_and_get_state : t -> Github.t -> Notabot_t.state
+val update_and_get_state : t -> Github.t -> State_t.state
 
 val make_with_secrets
   :  state_path:string ->
   cfg_args:cfg_make_args ->
   secrets_path:string ->
-  secrets:Notabot_t.secrets ->
+  secrets:Config_t.secrets ->
   ?disable_write:bool ->
   ?cfg_action_after_refresh:(Config.t -> unit) ->
   unit ->

lib/dune

@@ -31,13 +31,37 @@
   (run atdgen -j -j-std %{deps})))
 
 (rule
- (targets notabot_t.ml notabot_t.mli)
- (deps notabot.atd)
+ (targets rule_t.ml rule_t.mli)
+ (deps rule.atd)
  (action
   (run atdgen -t %{deps})))
 
 (rule
- (targets notabot_j.ml notabot_j.mli)
- (deps notabot.atd)
+ (targets rule_j.ml rule_j.mli)
+ (deps rule.atd)
+ (action
+  (run atdgen -j -j-std %{deps})))
+
+(rule
+ (targets config_t.ml config_t.mli)
+ (deps config.atd)
+ (action
+  (run atdgen -t %{deps})))
+
+(rule
+ (targets config_j.ml config_j.mli)
+ (deps config.atd)
+ (action
+  (run atdgen -j -j-std %{deps})))
+
+(rule
+ (targets state_t.ml state_t.mli)
+ (deps state.atd)
+ (action
+  (run atdgen -t %{deps})))
+
+(rule
+ (targets state_j.ml state_j.mli)
+ (deps state.atd)
  (action
   (run atdgen -j -j-std %{deps})))

lib/github.ml

@@ -89,7 +89,7 @@ let config_of_content_api_response response =
     match response.encoding with
     | "base64" ->
       Lwt.return
-      @@ Notabot_j.config_of_string
+      @@ Config_j.config_of_string
       @@ decode_string_pad
       @@ String.concat
       @@ String.split_lines

lib/notabot.atd

@@ -0,0 +1,40 @@
+type tristate = [ True | False | Once <json name="once"> ] <ocaml repr="classic"> <json adapter.ocaml="Common.Tristate">
+
+type status_state = {
+  success: tristate;
+  failure: bool;
+  pending: bool;
+  error: bool;
+  ?cancelled: string option; (* if specified, it will use the string as regex to match the description from the payload to determine if the status_state is cancelled *)
+}
+
+(* A filename matches a prefix rule with the channel name if it isn't in the ignore
+   list and it is in the allow list. If multiple prefix rules match for a given
+   file, the one to match with the longest prefix is used.
+
+   If a commit affects 3 files:
+   - some/dir/a
+   - some/dir/b
+   - some/other/dir/c
+
+   And we are only interested by commits affecting files in some/dir
+
+   allow should be ["some/dir"]
+
+   or
+
+   ignore should be ["some/other"] 
+*)
+type prefix_rule = {
+  allow : string list; (* empty list means match any *)
+  ~ignore : string list;
+  channel_name <json name="channel"> : string;
+}
+
+(* A payload matches a label rule with a channel name if absent from the ignore list
+   and present in the allow list. *)
+type label_rule = {
+  allow : string list;
+  ~ignore : string list;
+  channel_name <json name="channel"> : string;
+}

lib/rule.atd

@@ -0,0 +1,14 @@
+type build_state = [
+  | Success
+  | Failure
+] <ocaml repr="classic">
+
+type branch_info = {
+  last_build_state : build_state; (* if unknown or not built before, set to 'Failure' *)
+  updated_at : string;
+}
+
+(* The serializable runtime state of the bot *)
+type state = {
+  pipeline_statuses : (string * branch_info) list;
+}