Source file persistence.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
type context = (string * string) list

module type Backend = sig
  type 'a actor
  type 'b target
  type actor_spec
  type effect
  type kind
  type role_set
  type roles
  type rule
  type target_spec
  type validation_set
  type ('rv, 'err) monad = ('rv, 'err) Lwt_result.t

  module Repo : sig
    module Rule : sig
      val find_all : ?ctx:context -> target_spec -> rule list Lwt.t
      val save : ?ctx:context -> rule -> (unit, string) monad
      val delete : ?ctx:context -> rule -> (unit, string) monad
    end

    module Actor : sig
      val create
        :  ?ctx:context
        -> ?owner:Uuid.Actor.t
        -> role_set
        -> Uuid.Actor.t
        -> (unit, string) monad

      val mem : ?ctx:context -> Uuid.Actor.t -> (bool, string) monad

      val find
        :  ?ctx:context
        -> 'kind
        -> Uuid.Actor.t
        -> ('kind actor, string) monad

      val find_roles : ?ctx:context -> Uuid.Actor.t -> (role_set, string) monad

      val find_owner
        :  ?ctx:context
        -> Uuid.Actor.t
        -> (Uuid.Actor.t option, string) monad

      val grant_roles
        :  ?ctx:context
        -> Uuid.Actor.t
        -> role_set
        -> (unit, string) monad

      val revoke_roles
        :  ?ctx:context
        -> Uuid.Actor.t
        -> role_set
        -> (unit, string) monad

      val save_owner
        :  ?ctx:context
        -> ?owner:Uuid.Actor.t
        -> Uuid.Actor.t
        -> (unit, string) monad
    end

    module Target : sig
      val create
        :  ?ctx:context
        -> ?owner:Uuid.Actor.t
        -> kind
        -> Uuid.Target.t
        -> (unit, string) monad

      val mem : ?ctx:context -> Uuid.Target.t -> (bool, string) monad

      val find
        :  ?ctx:context
        -> kind
        -> Uuid.Target.t
        -> (kind target, string) monad

      val find_kind : ?ctx:context -> Uuid.Target.t -> (kind, string) monad

      val find_owner
        :  ?ctx:context
        -> kind
        -> Uuid.Target.t
        -> (Uuid.Actor.t option, string) monad

      val save_owner
        :  ?ctx:context
        -> ?owner:Uuid.Actor.t
        -> Uuid.Target.t
        -> (unit, string) monad
    end
  end

  val find_migrations : unit -> (string * string * string) list
  val find_clean : unit -> (string * string) list
  val migrate : ?ctx:context -> unit -> unit Lwt.t
  val clean : ?ctx:context -> unit -> unit Lwt.t
end

module type Contract = sig
  include Backend

  module Dependency : sig
    type parent_fcn = ?ctx:context -> effect -> (effect option, string) monad

    val register
      :  ?tags:Logs.Tag.set
      -> ?ignore_duplicates:bool
      -> parent:kind
      -> kind
      -> parent_fcn
      -> (unit, string) result

    val find : ?default_fcn:parent_fcn -> parent:kind -> kind -> parent_fcn
    val find_opt : parent:kind -> kind -> parent_fcn option
    val find_all : kind -> parent_fcn list

    val find_all_combined
      :  kind
      -> ?ctx:context
      -> effect
      -> (effect list, string) monad
  end

  module Rule : sig
    include module type of Repo.Rule

    val save_all : ?ctx:context -> rule list -> (rule list, rule list) monad
    val delete_exn : ?ctx:context -> rule -> unit Lwt.t
  end

  module Actor : sig
    include module type of Repo.Actor

    val create
      :  ?ctx:context
      -> ?owner:Uuid.Actor.t
      -> role_set
      -> Uuid.Actor.t
      -> (unit, string) monad

    val mem : ?ctx:context -> Uuid.Actor.t -> (bool, string) monad

    val revoke_role
      :  ?ctx:context
      -> Uuid.Actor.t
      -> roles
      -> (unit, string) monad

    val find_roles_exn : ?ctx:context -> Uuid.Actor.t -> role_set Lwt.t

    val find
      :  ?ctx:context
      -> 'kind
      -> Uuid.Actor.t
      -> ('kind actor, string) monad

    val decorate
      :  ?ctx:context
      -> ('a -> 'kind actor)
      -> 'a
      -> ('kind actor, string) monad
  end

  module Target : sig
    include module type of Repo.Target

    val create
      :  ?ctx:context
      -> ?owner:Uuid.Actor.t
      -> kind
      -> Uuid.Target.t
      -> (unit, string) monad

    val mem : ?ctx:context -> Uuid.Target.t -> (bool, string) monad

    val decorate
      :  ?ctx:context
      -> ('a -> kind target)
      -> 'a
      -> (kind target, string) monad

    val find_checker
      :  ?ctx:context
      -> kind target
      -> ('a actor -> Action.t -> bool, string) monad

    val find_kind_checker
      :  ?ctx:context
      -> kind
      -> ('b actor -> Action.t -> bool, string) monad
  end

  val wrap_function
    :  ?ctx:context
    -> (string -> 'etyp)
    -> validation_set
    -> ('param -> ('rval, 'etyp) monad)
    -> ('a actor -> 'param -> ('rval, 'etyp) monad, string) monad

  val validate
    :  ?ctx:context
    -> (string -> 'etyp)
    -> validation_set
    -> 'a actor
    -> (unit, 'etyp) monad
end