This repository has been archived by the owner on Mar 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
db.cljc
776 lines (632 loc) · 21.4 KB
/
db.cljc
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
(ns shadow.experiments.grove.db
(:refer-clojure :exclude #{ident? remove}))
#?(:cljs
(set! *warn-on-infer* false))
#?(:clj
(defn keyword-identical? [a b]
(identical? a b)))
(defn make-ident [type id]
[type id])
(defn parse-joins [spec joins]
(reduce-kv
(fn [spec attr val]
(if-not (and (vector? val)
(or (= :one (first val))
(= :many (first val))))
(throw (ex-info "invalid join" joins))
;; FIXME: actually make use of :one/:many, right now relying and user supplying proper value
(update spec :joins assoc attr (second val))))
spec
joins))
(defn parse-primary-key
[{:keys [entity-type] :as spec}
{:keys [primary-key] :as config}]
(cond
(and (not primary-key) (:ident-gen config))
spec
(keyword? primary-key)
(assoc spec
:ident-gen
#(make-ident entity-type (get % primary-key)))
(and (vector? primary-key) (every? keyword? primary-key))
(assoc spec
:ident-gen
(fn [item]
(make-ident entity-type
(mapv #(get item %) primary-key))))
:else
(throw (ex-info "invalid :primary-key" config))))
(defn parse-entity-spec [entity-type {:keys [joins] :as config}]
{:pre [(keyword? entity-type)]}
(-> (assoc config :entity-type entity-type :joins {})
(parse-primary-key config)
(parse-joins joins)
))
(defn parse-schema [spec]
(reduce-kv
(fn [schema key {:keys [type] :as config}]
(cond
(= :entity type)
(assoc-in schema [:entities key] (parse-entity-spec key config))
;; only have entities for now, will need custom config later
:else
(throw (ex-info "unknown type" {:key key :config config}))
))
{:entities {}}
spec))
(defn ident? [thing]
(and (vector? thing)
(= (count thing) 2)
(keyword? (first thing))))
(defn nav-fn [db key val]
(cond
(ident? val)
(get db val)
(coll? val)
(vary-meta val assoc
'clojure.core.protocols/datafy
(fn [m]
(vary-meta m assoc
'clojure.core.protocols/nav
(fn [m key val]
(if (ident? val)
(get db val)
val)))))
:else
val))
(defn configure [init-db spec]
;; FIXME: should this use a special key instead of meta?
(let [schema (parse-schema spec)
m {::schema schema
::ident-types (set (keys (:entities schema)))
;; FIXME: conditionalize this, not necessary in release builds
;; convenient for when tapping the db for inspect
'clojure.core.protocols/nav nav-fn}]
(with-meta init-db m)))
(defn ident-key [thing]
{:pre [(ident? thing)]}
(nth thing 0))
(defn coll-key [thing]
{:pre [(ident? thing)]}
[::all (ident-key thing)])
(defn ident-val [thing]
{:pre [(ident? thing)]}
(nth thing 1))
(defn- normalize* [imports schema entity-type item]
(let [{:keys [ident-gen id-pred joins] :as ent-config}
(get-in schema [:entities entity-type])
item-ident
(get item :db/ident)
ident
(ident-gen item)
_ (when (and item-ident (not= item-ident ident))
(throw (ex-info "item contained ident but we generated a different one" {:item item :ident ident})))
;; FIXME: can an item ever have more than one ident?
item
(if (= item-ident ident)
item
(assoc item :db/ident ident))
item
(reduce-kv
(fn [item key join-type]
(let [curr-val
(get item key ::skip)
norm-val
(cond
(keyword-identical? ::skip curr-val)
curr-val
;; already normalized, no nothing
(ident? curr-val)
::skip
(map? curr-val)
(normalize* imports schema join-type curr-val)
(vector? curr-val)
(mapv #(normalize* imports schema join-type %) curr-val)
;; FIXME: add back predicate to check if curr-val is valid id-val to make ident
;; might be garbage leading to invalid ident stored in norm db
(some? curr-val)
(make-ident join-type curr-val)
:else
(throw (ex-info "unexpected value in join attr"
{:item item
:key key
:val curr-val
:type type})))]
(if (keyword-identical? norm-val ::skip)
item
(assoc item key norm-val))))
item
joins)]
(swap! imports conj [ident item])
ident))
(defn- normalize
"returns a seq of [[ident item] ...] tuples"
[schema entity-type vals]
(let [imports (atom [])]
(cond
(map? vals)
(normalize* imports schema entity-type vals)
(sequential? vals)
(doseq [item vals]
(normalize* imports schema entity-type item))
:else
(throw (ex-info "cannot import" {:entity-type entity-type :vals vals})))
@imports
))
(comment
(let [schema
{:foo
{:type :entity
:primary-key :foo-id
:joins {:bar [:one :bar]
:baz [:one :baz]}}
:bar
{:type :entity
:primary-key :bar-id}}
db
(configure {} schema)]
(-> (transacted db)
(add :foo {:foo-id 1 :foo "foo" :bar {:bar-id 1 :bar "bar"}})
(commit!)
(get :data))))
(defn- set-conj [x y]
(if (nil? x)
#{y}
(conj x y)))
(defn merge-or-replace [left right]
(if (keyword-identical? :db/loading left)
right
(merge left right)))
(defn- merge-imports [data imports]
(reduce
(fn [data [ident item]]
(update data ident merge-or-replace item))
data
imports))
(defn merge-seq
([data entity-type coll]
(merge-seq data entity-type coll nil))
([data entity-type coll target-path-or-fn]
{:pre [(sequential? coll)]}
(let [{::keys [schema]}
(meta data)
_ (when-not schema
(throw (ex-info "data missing schema" {:data data})))
{:keys [ident-gen] :as entity-spec}
(get-in schema [:entities entity-type])
_ (when-not entity-spec
(throw (ex-info "entity not defined" {:entity-type entity-type})))
idents
(->> coll
(map ident-gen)
(into []))
imports
(normalize schema entity-type coll)]
(-> data
(merge-imports imports)
(cond->
(vector? target-path-or-fn)
(assoc-in target-path-or-fn idents)
(fn? target-path-or-fn)
(target-path-or-fn idents))
))))
(defn add
([data entity-type item]
(add data entity-type item nil))
([data entity-type item target-path]
{:pre [(map? item)]}
(let [{::keys [schema]}
(meta data)
_ (when-not schema
(throw (ex-info "data missing schema" {:data data})))
{:keys [ident-gen] :as entity-spec}
(get-in schema [:entities entity-type])
_ (when-not entity-spec
(throw (ex-info "entity not defined" {:entity-type entity-type})))
ident
(ident-gen item)
imports
(normalize schema entity-type [item])]
(-> data
(merge-imports imports)
(cond->
target-path
(update-in target-path conj ident))))))
(defn update-entity [data entity-type id update-fn & args]
;; FIXME: validate that both entity-type is defined and id matches type
(update data (make-ident entity-type id) #(apply update-fn % args)))
(defn all-idents-of [db entity-type]
;; FIXME: check in schema if entity-type is actually declared
(get db [::all entity-type]))
(defn all-of [db entity-type]
(->> (all-idents-of db entity-type)
(map #(get db %))))
;; keep this as the very last thing since we excluded clojure remove
;; don't want to write code that assumes it uses core remove
(defn remove [data thing]
(cond
(ident? thing)
(dissoc data thing)
(and (map? thing) (:db/ident thing))
(dissoc data (:db/ident thing))
:else
(throw (ex-info "don't know how to remove thing" {:thing thing}))))
(defn remove-idents [data idents]
(reduce remove data idents))
(defprotocol IObserved
(observed-keys [this]))
#?(:clj
(deftype ObservedData
[^:unsynchronized-mutable keys-used
^clojure.lang.IPersistentMap data]
IObserved
(observed-keys [_]
(persistent! keys-used))
clojure.lang.IMeta
(meta [_]
(.meta data))
;; FIXME: implement rest of seq functions
clojure.lang.IPersistentMap
(assoc [this key val]
(throw (ex-info "read-only" {})))
(assocEx [this key val]
(throw (ex-info "read-only" {})))
(without [this key]
(throw (ex-info "read-only" {})))
(containsKey [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(.containsKey data key))
(valAt [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(.valAt data key))
(valAt [this key not-found]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(.valAt data key not-found))
(entryAt [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(.entryAt data key)))
:cljs
(deftype ObservedData [^:mutable keys-used ^not-native data]
IObserved
(observed-keys [_]
(persistent! keys-used))
IMeta
(-meta [_]
(-meta data))
;; map? predicate checks for this protocol
IMap
(-dissoc [coll k]
(throw (ex-info "observed data is read-only" {})))
IAssociative
(-contains-key? [coll k]
(-contains-key? data k))
(-assoc [coll k v]
(throw (ex-info "observed data is read-only, assoc not allowed" {:k k :v v})))
ILookup
(-lookup [_ key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(-lookup data key))
(-lookup [_ key default]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(set! keys-used (conj! keys-used key))
(-lookup data key default))))
(defn observed [data]
(ObservedData. (transient #{}) data))
#?(:clj
(defprotocol ITxCheck
(check-completed! [this])))
(defprotocol ITxCommit
(commit! [this]))
#?(:clj
(deftype TransactedData
[^clojure.lang.IPersistentMap data
keys-new
keys-updated
keys-removed
;; using a ref not a mutable local since it must apply to all created instances of this
;; every "write" creates a new instance
completed-ref]
;; useful for debugging purposes that want the actual data
clojure.lang.IDeref
(deref [_]
data)
clojure.lang.IMeta
(meta [_]
(.meta data))
clojure.lang.IPersistentMap
(count [this]
(.count data))
(containsKey [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(.containsKey data key))
(valAt [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(.valAt data key))
(valAt [this key not-found]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(.valAt data key not-found))
(entryAt [this key]
(when (nil? key)
(throw (ex-info "cannot read nil key" {})))
(.entryAt data key))
(assoc [this key value]
(check-completed! this)
(when (nil? key)
(throw (ex-info "nil key not allowed" {:value value})))
;; FIXME: should it really check each write if anything changed?
;; FIXME: enforce that ident keys have a map value with ::ident key?
(let [prev-val
(.valAt data key ::not-found)
;; FIXME: this should only be checking the key
;; but since using vectors as ident we can't tell the difference from
;; [::all :some.app.model/thing]
is-ident-update?
(and (ident? key)
(contains? (::ident-types (meta data)) (ident-key key)))]
(if (identical? prev-val value)
this
(if (= ::not-found prev-val)
;; new
(if-not is-ident-update?
;; new non-ident key
(TransactedData.
(assoc data key value)
(conj! keys-new key)
keys-updated
keys-removed
completed-ref)
;; new ident
(TransactedData.
(-> data
(assoc key value)
(update (coll-key key) set-conj key))
(conj! keys-new key)
(conj! keys-updated (coll-key key))
keys-removed
completed-ref))
;; update, non-ident key
(if-not is-ident-update?
(TransactedData.
(assoc data key value)
(conj! keys-updated key)
(conj! keys-updated key)
keys-removed
completed-ref)
;; FIXME: no need to track (ident-key key) since it should be present?
(TransactedData.
(.assoc data key value)
keys-new
(-> keys-updated
(conj! key)
;; need to update the entity-type collection since some queries might change if one in the list changes
;; FIXME: this makes any update potentially expensive, maybe should leave this to the user?
(conj! (coll-key key)))
keys-removed
completed-ref))
))))
(assocEx [this key value]
(check-completed! this)
(when (nil? key)
(throw (ex-info "nil key not allowed" {:value value})))
;; FIXME: should it really check each write if anything changed?
;; FIXME: enforce that ident keys have a map value with ::ident key?
(let [prev-val
(.valAt data key ::not-found)
;; FIXME: this should only be checking the key
;; but since using vectors as ident we can't tell the difference from
;; [::all :some.app.model/thing]
is-ident-update?
(and (ident? key)
(contains? (::ident-types (meta data)) (ident-key key)))]
(if (identical? prev-val value)
this
(if (= ::not-found prev-val)
;; new
(if-not is-ident-update?
;; new non-ident key
(TransactedData.
(.assocEx data key value)
(conj! keys-new key)
keys-updated
keys-removed
completed-ref)
;; new ident
(TransactedData.
(-> data
(.assocEx key value)
(update (coll-key key) set-conj key))
(conj! keys-new key)
(conj! keys-updated (coll-key key))
keys-removed
completed-ref))
;; update, non-ident key
(if-not is-ident-update?
(TransactedData.
(.assocEx data key value)
keys-new
(conj! keys-updated key)
keys-removed
completed-ref)
;; FIXME: no need to track (ident-key key) since it should be present?
(TransactedData.
(.assocEx data key value)
keys-new
(-> keys-updated
(conj! key)
;; need to update the entity-type collection since some queries might change if one in the list changes
;; FIXME: this makes any update potentially expensive, maybe should leave this to the user?
(conj! (coll-key key)))
keys-removed
completed-ref))
))))
(without [this key]
(check-completed! this)
(let [key-is-ident?
(ident? key)
next-data
(-> (.without data key)
(cond->
key-is-ident?
(update (coll-key key) disj key)))
next-removed
(-> keys-removed
(conj! key)
(cond->
key-is-ident?
(conj! (coll-key key))))]
(TransactedData.
next-data
keys-new
keys-updated
next-removed
completed-ref)))
ITxCheck
(check-completed! [this]
(when @completed-ref
(throw (ex-info "transaction concluded, don't hold on to db while in tx" {}))))
ITxCommit
(commit! [_]
(vreset! completed-ref true)
{:data data
:keys-new (persistent! keys-new)
:keys-updated (persistent! keys-updated)
:keys-removed (persistent! keys-removed)}))
:cljs
(deftype TransactedData
[^not-native data
keys-new
keys-updated
keys-removed
;; using a ref not a mutable local since it must apply to all created instances of this
;; every "write" creates a new instance
completed-ref]
;; useful for debugging purposes that want the actual data
IDeref
(-deref [_]
data)
IMeta
(-meta [_]
(-meta data))
ILookup
(-lookup [this key]
(.check-completed! this)
(-lookup data key))
(-lookup [this key default]
(.check-completed! this)
(-lookup data key default))
ICounted
(-count [this]
(.check-completed! this)
(-count data))
IMap
(-dissoc [this key]
(.check-completed! this)
(let [key-is-ident?
(ident? key)
next-data
(-> (-dissoc data key)
(cond->
key-is-ident?
(update (coll-key key) disj key)))
next-removed
(-> keys-removed
(conj! key)
(cond->
key-is-ident?
(conj! (coll-key key))))]
(TransactedData.
next-data
keys-new
keys-updated
next-removed
completed-ref)))
IAssociative
(-contains-key? [coll k]
(-contains-key? data k))
(-assoc [this key value]
(.check-completed! this)
(when (nil? key)
(throw (ex-info "nil key not allowed" {:value value})))
;; FIXME: should it really check each write if anything changed?
;; FIXME: enforce that ident keys have a map value with ::ident key?
(let [prev-val
(-lookup data key ::not-found)
;; FIXME: this should only be checking the key
;; but since using vectors as ident we can't tell the difference from
;; [::all :some.app.model/thing]
is-ident-update?
(and (ident? key)
(contains? (::ident-types (meta data)) (ident-key key)))]
(if (identical? prev-val value)
this
(if (= ::not-found prev-val)
;; new
(if-not is-ident-update?
;; new non-ident key
(TransactedData.
(-assoc data key value)
(conj! keys-new key)
keys-updated
keys-removed
completed-ref)
;; new ident
(TransactedData.
(-> data
(-assoc key value)
(update (coll-key key) set-conj key))
(conj! keys-new key)
(conj! keys-updated (coll-key key))
keys-removed
completed-ref))
;; update, non-ident key
(if-not is-ident-update?
(TransactedData.
(-assoc data key value)
keys-new
(conj! keys-updated key)
keys-removed
completed-ref)
;; FIXME: no need to track (ident-key key) since it should be present?
(TransactedData.
(-assoc data key value)
keys-new
(-> keys-updated
(conj! key)
;; need to update the entity-type collection since some queries might change if one in the list changes
;; FIXME: this makes any update potentially expensive, maybe should leave this to the user?
(conj! (coll-key key)))
keys-removed
completed-ref))
))))
ITxCommit
(commit! [_]
(vreset! completed-ref true)
{:data data
:keys-new (persistent! keys-new)
:keys-updated (persistent! keys-updated)
:keys-removed (persistent! keys-removed)})
Object
(check-completed! [this]
(when @completed-ref
(throw (ex-info "transaction concluded, don't hold on to db while in tx" {}))))))
(defn transacted [data]
(TransactedData.
data
(transient #{})
(transient #{})
(transient #{})
(volatile! false)))