package octez-internal-libs

  1. Overview
  2. Docs
package octez-internal-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file sync.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
211
212
213
214
215
216
217
218
219
220
221
(*
 * Copyright (c) 2013-2022 Thomas Gazagnaire <thomas@gazagnaire.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

open! Import
include Sync_intf

module type REMOTE = Remote.S

let invalid_argf fmt = Fmt.kstr Lwt.fail_invalid_arg fmt
let src = Logs.Src.create "irmin.sync" ~doc:"Irmin remote sync"

module Log = (val Logs.src_log src : Logs.LOG)

let remote_store m x = Store.Store (m, x)

module Make (S : Store.Generic_key.S) = struct
  module B = S.Backend.Remote

  type db = S.t
  type commit = S.commit
  type commit_key = S.commit_key [@@deriving irmin ~pp]
  type info = S.info

  let conv dx dy =
    let dx_to_bin_string = Type.(unstage (to_bin_string dx)) in
    let dy_of_bin_string = Type.(unstage (of_bin_string dy)) in
    Type.stage (fun x -> dy_of_bin_string (dx_to_bin_string x))

  let convert_slice (type r s) (module RP : Backend.S with type Slice.t = r)
      (module SP : Backend.S with type Slice.t = s) r =
    let conv_contents_k =
      Type.unstage (conv RP.Contents.Hash.t SP.Contents.Hash.t)
    in
    let conv_contents_v =
      Type.unstage (conv RP.Contents.Val.t SP.Contents.Val.t)
    in
    let conv_node_k = Type.unstage (conv RP.Node.Hash.t SP.Node.Hash.t) in
    let conv_node_v = Type.unstage (conv RP.Node.Val.t SP.Node.Val.t) in
    let conv_commit_k = Type.unstage (conv RP.Commit.Hash.t SP.Commit.Hash.t) in
    let conv_commit_v = Type.unstage (conv RP.Commit.Val.t SP.Commit.Val.t) in
    let* s = SP.Slice.empty () in
    let* () =
      RP.Slice.iter r (function
        | `Contents (k, v) -> (
            let k = conv_contents_k k in
            let v = conv_contents_v v in
            match (k, v) with
            | Ok k, Ok v -> SP.Slice.add s (`Contents (k, v))
            | _ -> Lwt.return_unit)
        | `Node (k, v) -> (
            let k = conv_node_k k in
            let v = conv_node_v v in
            match (k, v) with
            | Ok k, Ok v -> SP.Slice.add s (`Node (k, v))
            | _ -> Lwt.return_unit)
        | `Commit (k, v) -> (
            let k = conv_commit_k k in
            let v = conv_commit_v v in
            match (k, v) with
            | Ok k, Ok v -> SP.Slice.add s (`Commit (k, v))
            | _ -> Lwt.return_unit))
    in
    Lwt.return s

  let convs src dst l =
    let conv = Type.unstage (conv src dst) in
    List.fold_left
      (fun acc x -> match conv x with Ok x -> x :: acc | _ -> acc)
      [] l

  let pp_branch = Type.pp S.Branch.t

  type status = [ `Empty | `Head of commit ]

  let pp_status ppf = function
    | `Empty -> Fmt.string ppf "empty"
    | `Head c -> S.Commit.pp_hash ppf c

  let status_t t =
    let open Type in
    variant "status" (fun empty head -> function
      | `Empty -> empty | `Head c -> head c)
    |~ case0 "empty" `Empty
    |~ case1 "head" S.(commit_t @@ repo t) (fun c -> `Head c)
    |> sealv

  let fetch t ?depth remote =
    match remote with
    | Store.Store ((module R), r) -> (
        [%log.debug "fetch store"];
        let s_repo = S.repo t in
        let r_repo = R.repo r in
        let conv =
          Type.unstage (conv R.(commit_t r_repo) S.(commit_t s_repo))
        in
        let* min = S.Repo.heads s_repo in
        let min = convs S.(commit_t s_repo) R.(commit_t r_repo) min in
        R.Head.find r >>= function
        | None -> Lwt.return (Ok `Empty)
        | Some h -> (
            let* r_slice =
              R.Repo.export (R.repo r) ?depth ~min ~max:(`Max [ h ])
            in
            let* s_slice =
              convert_slice (module R.Backend) (module S.Backend) r_slice
            in
            S.Repo.import s_repo s_slice >|= function
            | Error e -> Error e
            | Ok () -> (
                match conv h with Ok h -> Ok (`Head h) | Error e -> Error e)))
    | S.E e -> (
        match S.status t with
        | `Empty | `Commit _ -> Lwt.return (Ok `Empty)
        | `Branch br -> (
            [%log.debug "Fetching branch %a" pp_branch br];
            let* g = B.v (S.repo t) in
            B.fetch g ?depth e br >>= function
            | Error _ as e -> Lwt.return e
            | Ok (Some key) -> (
                [%log.debug "Fetched %a" pp_commit_key key];
                S.Commit.of_key (S.repo t) key >|= function
                | None -> Ok `Empty
                | Some x -> Ok (`Head x))
            | Ok None -> (
                S.Head.find t >>= function
                | Some h -> Lwt.return (Ok (`Head h))
                | None -> Lwt.return (Ok `Empty))))
    | _ -> Lwt.return (Error (`Msg "fetch operation is not available"))

  let fetch_exn t ?depth remote =
    fetch t ?depth remote >>= function
    | Ok h -> Lwt.return h
    | Error (`Msg e) -> invalid_argf "Sync.fetch_exn: %s" e

  type pull_error = [ `Msg of string | Merge.conflict ]

  let pp_pull_error ppf = function
    | `Msg s -> Fmt.string ppf s
    | `Conflict c -> Fmt.pf ppf "conflict: %s" c

  let pull t ?depth remote kind : (status, pull_error) result Lwt.t =
    fetch t ?depth remote >>= function
    | Error e -> Lwt.return (Error (e :> pull_error))
    | Ok (`Head k) -> (
        match kind with
        | `Set -> S.Head.set t k >|= fun () -> Ok (`Head k)
        | `Merge info -> (
            S.Head.merge ~into:t ~info k >>= function
            | Ok () -> Lwt.return (Ok (`Head k))
            | Error e -> Lwt.return (Error (e :> pull_error))))
    | Ok `Empty -> Lwt.return (Ok `Empty)

  let pull_exn t ?depth remote kind =
    pull t ?depth remote kind >>= function
    | Ok x -> Lwt.return x
    | Error e -> invalid_argf "Sync.pull_exn: %a" pp_pull_error e

  type push_error = [ `Msg of string | `Detached_head ]

  let pp_push_error ppf = function
    | `Msg s -> Fmt.string ppf s
    | `Detached_head -> Fmt.string ppf "cannot push to a non-persistent store"

  let push t ?depth remote =
    [%log.debug "push"];
    match remote with
    | Store.Store ((module R), r) -> (
        S.Head.find t >>= function
        | None -> Lwt.return (Ok `Empty)
        | Some h -> (
            [%log.debug "push store"];
            let* min = R.Repo.heads (R.repo r) in
            let r_repo = R.repo r in
            let s_repo = S.repo t in
            let min = convs R.(commit_t r_repo) S.(commit_t s_repo) min in
            let conv =
              Type.unstage (conv S.(commit_t s_repo) R.(commit_t r_repo))
            in
            let* s_slice = S.Repo.export (S.repo t) ?depth ~min in
            let* r_slice =
              convert_slice (module S.Backend) (module R.Backend) s_slice
            in
            R.Repo.import (R.repo r) r_slice >>= function
            | Error e -> Lwt.return (Error (e :> push_error))
            | Ok () -> (
                match conv h with
                | Error e -> Lwt.return (Error (e :> push_error))
                | Ok h ->
                    R.Head.set r h >>= fun () ->
                    let+ head = S.Head.get t in
                    Ok (`Head head))))
    | S.E e -> (
        match S.status t with
        | `Empty -> Lwt.return (Ok `Empty)
        | `Commit _ -> Lwt.return (Error `Detached_head)
        | `Branch br -> (
            let* head = S.of_branch (S.repo t) br >>= S.Head.get in
            let* g = B.v (S.repo t) in
            B.push g ?depth e br >>= function
            | Ok () -> Lwt.return (Ok (`Head head))
            | Error err -> Lwt.return (Error (err :> push_error))))
    | _ -> Lwt.return (Error (`Msg "push operation is not available"))

  let push_exn t ?depth remote =
    push t ?depth remote >>= function
    | Ok x -> Lwt.return x
    | Error e -> invalid_argf "Sync.push_exn: %a" pp_push_error e
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct