@@ -2,1140 +2,647 @@ module Test.Main where
22
33import Prelude
44
5−import Data.Array (head, drop)
6−import Data.Date as Date
7−import Data.DateTime (DateTime(..), Time(..))
8−import Data.DateTime.Instant (toDateTime)
9−import Data.Either (Either(..))
10−import Data.Enum (toEnum)
11−import Data.Maybe (Maybe(..), isNothing, maybe)
12−import Data.Time.Duration (Milliseconds(..))
13−import Data.Traversable (traverse)
14−import Data.Tuple (Tuple(..), uncurry)
15−import Database.IndexedDB.Core (CursorDirection(..), Database, Index, ObjectStore, Transaction, TransactionMode(..))
16−import Database.IndexedDB.IDBCursor as IDBCursor
17−import Database.IndexedDB.IDBDatabase as IDBDatabase
18−import Database.IndexedDB.IDBFactory as IDBFactory
19−import Database.IndexedDB.IDBIndex as IDBIndex
20−import Database.IndexedDB.IDBKey (Key, none, toKey)
21−import Database.IndexedDB.IDBKeyRange as IDBKeyRange
22−import Database.IndexedDB.IDBObjectStore as IDBObjectStore
23−import Database.IndexedDB.IDBTransaction as IDBTransaction
24−import Effect (Effect)
25−import Effect.Aff (Aff, attempt, delay, forkAff, launchAff, launchAff_)
26−import Effect.Aff.AVar (AVar)
27−import Effect.Aff.AVar as AVar
28−import Effect.Class (liftEffect)
29−import Effect.Console (log)
30−import Effect.Exception (name)
31−import Effect.Now (now)
32−import Test.Spec (describe, it)
33−import Test.Spec.Assertions (shouldEqual, fail)
34−import Test.Spec.Reporter (consoleReporter)
35−import Test.Spec.Runner (runSpec)
5+import Control.Monad.Aff (Aff, launchAff, forkAff, delay, attempt)
6+import Control.Monad.Aff.AVar (AVAR, makeVar, makeVar', modifyVar, peekVar, putVar, takeVar)
7+import Control.Monad.Eff (Eff)
8+import Control.Monad.Eff.Class (liftEff)
9+import Control.Monad.Eff.Exception (EXCEPTION)
10+import Control.Monad.Eff.Now (NOW, now)
11+import Data.Date as Date
12+import Data.DateTime as DateTime
13+import Data.DateTime (DateTime(..), Time(..))
14+import Data.DateTime.Instant (toDateTime)
15+import Data.Either (Either(..))
16+import Data.Enum (toEnum)
17+import Data.Maybe (Maybe(..), isNothing, maybe)
18+import Data.Time.Duration (Milliseconds(..))
19+import Data.Traversable (traverse)
20+import Data.Tuple (Tuple(..), uncurry)
21+import Test.Spec (describe, describeOnly, it, itOnly)
22+import Test.Spec.Assertions (shouldEqual, fail)
23+import Test.Spec.Mocha (MOCHA, runMocha)
24+
25+import Database.IndexedDB.Core
26+import Database.IndexedDB.IDBKey
27+import Database.IndexedDB.IDBDatabase as IDBDatabase
28+import Database.IndexedDB.IDBFactory as IDBFactory
29+import Database.IndexedDB.IDBIndex as IDBIndex
30+import Database.IndexedDB.IDBKeyRange as IDBKeyRange
31+import Database.IndexedDB.IDBObjectStore as IDBObjectStore
32+import Database.IndexedDB.IDBTransaction as IDBTransaction
3633
37−infixr 7 Tuple as :+:
3834
39−launchAff' :: forall a. Aff a -> Effect Unit
40−launchAff' =
41− launchAff_ <<< void
35+infixr 7 Tuple as :+:
4236
43−modifyAVar :: forall a. (a -> a) -> AVar a -> Aff Unit
44−modifyAVar fn v = do
45− val <- AVar.take v
46− AVar.put (fn val) v
37+launchAff' :: forall a e. Aff e a -> Eff (exception :: EXCEPTION | e) Unit
38+launchAff' aff =
39+ pure unit <* (launchAff aff)
4740
48−main :: Effect Unit
49−main = do
50− launchAff_ $ runSpec [ consoleReporter ] $ do
51− describe "IDBFactory" do
52− let
41+main :: forall eff. Eff (now :: NOW, mocha :: MOCHA, idb :: IDB, exception :: EXCEPTION, avar :: AVAR | eff) Unit
42+main = runMocha do
43+ describe "IDBFactory" do
44+ let
5345 tearDown name version db = do
5446 IDBDatabase.close db
5547 version' <- IDBFactory.deleteDatabase name
56− liftEffect $ log $ show version'
5748 version' `shouldEqual` version
5849
59− it "open default" do
60− let
61− name = "db-default"
50+ it "open default" do
51+ let name = "db-default"
6252 version = 1
63− db <- IDBFactory.open name Nothing
64− { onUpgradeNeeded: Nothing
65− , onBlocked: Nothing
66− }
67− IDBDatabase.name db `shouldEqual` name
68− tearDown name version db
53+ db <- IDBFactory.open name Nothing
54+ { onUpgradeNeeded : Nothing
55+ , onBlocked : Nothing
56+ }
57+ IDBDatabase.name db `shouldEqual` name
58+ tearDown name version db
6959
70− it "open specific version" do
71− let
72− name = "db-specific"
73− version = 14
74− db <- IDBFactory.open name (Just version)
75− { onUpgradeNeeded: Nothing
76− , onBlocked: Nothing
77− }
78− IDBDatabase.name db `shouldEqual` name
79− tearDown name version db
8060
81− it "open specific version -> close -> open latest" do
82− let
83− name = "db-latest"
61+ it "open specific version" do
62+ let name = "db-specific"
8463 version = 14
85− db01 <- IDBFactory.open name (Just version)
86− { onUpgradeNeeded: Nothing
87− , onBlocked: Nothing
88− }
89− IDBDatabase.name db01 `shouldEqual` name
90− IDBDatabase.close db01
91− db02 <- IDBFactory.open name Nothing
92− { onUpgradeNeeded: Nothing
93− , onBlocked: Nothing
94− }
95− tearDown name version db02
64+ db <- IDBFactory.open name (Just version)
65+ { onUpgradeNeeded : Nothing
66+ , onBlocked : Nothing
67+ }
68+ IDBDatabase.name db `shouldEqual` name
69+ tearDown name version db
9670
97− it "open + onUpgradeNeed" do
98− let
99− name = "db-upgrade-needed"
71+
72+ it "open specific version -> close -> open latest" do
73+ let name = "db-latest"
74+ version = 14
75+ db <- IDBFactory.open name (Just version)
76+ { onUpgradeNeeded : Nothing
77+ , onBlocked : Nothing
78+ }
79+ IDBDatabase.name db `shouldEqual` name
80+ IDBDatabase.close db
81+ db <- IDBFactory.open name Nothing
82+ { onUpgradeNeeded : Nothing
83+ , onBlocked : Nothing
84+ }
85+ tearDown name version db
86+
87+
88+ it "open + onUpgradeNeed" do
89+ let name = "db-upgrade-needed"
10090 version = 1
101− callback (Tuple varName varVersion) db _ { oldVersion } = do
102− _ <- launchAff $ modifyAVar (const $ IDBDatabase.name db) varName
103− _ <- launchAff $ modifyAVar (const $ oldVersion) varVersion
91+ callback var db _ = do
92+ _ <- launchAff $ modifyVar (const $ IDBDatabase.name db) var
10493 pure unit
105− varName <- AVar.new "-"
106− varVersion <- AVar.new (-1)
107− db <- IDBFactory.open name Nothing
108− { onUpgradeNeeded: Just (callback (Tuple varName varVersion))
109− , onBlocked: Nothing
110− }
111− name' <- AVar.read varName
112− version' <- AVar.read varVersion
113− name' `shouldEqual` name
114− version' `shouldEqual` 0
115− tearDown name version db
116−
117− it "open + onBlocked" do
118− let
119− name = "db-blocked"
94+ var <- makeVar' "-"
95+ db <- IDBFactory.open name Nothing
96+ { onUpgradeNeeded : Just (callback var)
97+ , onBlocked : Nothing
98+ }
99+ name <- peekVar var
100+ name `shouldEqual` name
101+ tearDown name version db
102+
103+
104+ it "open + onBlocked" do
105+ let name = "db-blocked"
120106 version = 14
121107 callback var = do
122− _ <- launchAff $ modifyAVar (const $ "db-blocked") var
108+ _ <- launchAff $ modifyVar (const $ "db-blocked") var
123109 pure unit
124110
125− var <- AVar.new "-"
126− db01 <- IDBFactory.open name Nothing
127− { onUpgradeNeeded: Nothing
128− , onBlocked: Nothing
129− }
130− _ <- forkAff do
131− delay (Milliseconds 100.0)
132− IDBDatabase.close db01
111+ var <- makeVar' "-"
112+ db01 <- IDBFactory.open name Nothing
113+ { onUpgradeNeeded : Nothing
114+ , onBlocked : Nothing
115+ }
116+ _ <- forkAff do
117+ delay (Milliseconds 100.0)
118+ IDBDatabase.close db01
133119
134− db02 <- IDBFactory.open name (Just version)
135− { onUpgradeNeeded: Nothing
136− , onBlocked: Just (callback var)
137− }
138− name' <- AVar.read var
139− name' `shouldEqual` name
140− tearDown name version db02
141−
142− describe "IDBKeyRange" do
143− it "only(int)" do
144− let
145− key = 14
120+ db02 <- IDBFactory.open name (Just version)
121+ { onUpgradeNeeded : Nothing
122+ , onBlocked : Just (callback var)
123+ }
124+ name <- peekVar var
125+ name `shouldEqual` name
126+ tearDown name version db02
127+
128+ describe "IDBKeyRange" do
129+ it "only(int)" do
130+ let key = 14
146131 range = IDBKeyRange.only key
147− IDBKeyRange.includes range (toKey key) `shouldEqual` true
132+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
148133
149− it "only(string)" do
150− let
151− key = "patate"
134+ it "only(string)" do
135+ let key = "patate"
152136 range = IDBKeyRange.only key
153− IDBKeyRange.includes range (toKey key) `shouldEqual` true
137+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
154138
155− it "only(float)" do
156− let
157− key = 14.42
139+ it "only(float)" do
140+ let key = 14.42
158141 range = IDBKeyRange.only key
159− IDBKeyRange.includes range (toKey key) `shouldEqual` true
142+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
160143
161− it "only(date)" do
162− let
163− mkey = DateTime
144+ it "only(date)" do
145+ let mkey = DateTime
164146 <$> (Date.canonicalDate <$> toEnum 2017 <*> toEnum 6 <*> toEnum 23)
165147 <*> (Time <$> toEnum 17 <*> toEnum 59 <*> toEnum 34 <*> toEnum 42)
166148
167− case mkey of
168− Nothing ->
169− fail "unable to create datetime"
170− Just key -> do
171− let range = IDBKeyRange.only key
172− IDBKeyRange.includes range (toKey key) `shouldEqual` true
149+ case mkey of
150+ Nothing ->
151+ fail "unable to create datetime"
152+ Just key -> do
153+ let range = IDBKeyRange.only key
154+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
173155
174− it "only([int])" do
175− let
176− key = [ 14, 42 ]
156+ it "only([int])" do
157+ let key = [14, 42]
177158 range = IDBKeyRange.only key
178− IDBKeyRange.includes range (toKey key) `shouldEqual` true
159+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
179160
180− it "only([string])" do
181− let
182− key = [ "patate", "autruche" ]
161+ it "only([string])" do
162+ let key = ["patate", "autruche"]
183163 range = IDBKeyRange.only key
184− IDBKeyRange.includes range (toKey key) `shouldEqual` true
164+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
185165
186− it "lowerBound(14, open)" do
187− let
188− key = 14
189− open = true
166+ it "lowerBound(14, open)" do
167+ let key = 14
168+ open = true
190169 range = IDBKeyRange.lowerBound key open
191− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
192− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
193− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
194−
195− it "lowerBound(14, close)" do
196− let
197− key = 14
198− open = false
170+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
171+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
172+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
173+
174+ it "lowerBound(14, close)" do
175+ let key = 14
176+ open = false
199177 range = IDBKeyRange.lowerBound key open
200− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
201− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
202− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
203−
204− it "upperBound(14, open)" do
205− let
206− key = 14
207− open = true
178+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
179+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
180+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
181+
182+ it "upperBound(14, open)" do
183+ let key = 14
184+ open = true
208185 range = IDBKeyRange.upperBound key open
209− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
210− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
211− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
212−
213− it "upperBound(14, close)" do
214− let
215− key = 14
216− open = false
186+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
187+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
188+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
189+
190+ it "upperBound(14, close)" do
191+ let key = 14
192+ open = false
217193 range = IDBKeyRange.upperBound key open
218− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
219− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
220− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
221−
222− it "bound(42, 14, open, open) => Nothing" do
223− let
224− lower = 42
225− upper = 14
194+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
195+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
196+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
197+
198+ it "bound(42, 14, open, open) => Nothing" do
199+ let lower = 42
200+ upper = 14
226201 lowerOpen = true
227202 upperOpen = true
228− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
229− isNothing mrange `shouldEqual` true
203+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
204+ isNothing mrange `shouldEqual` true
230205
231− it "bound(14, 42, open, open)" do
232− let
233− lower = 14
234− upper = 42
206+ it "bound(14, 42, open, open)" do
207+ let lower = 14
208+ upper = 42
235209 lowerOpen = true
236210 upperOpen = true
237− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
238− case mrange of
239− Nothing ->
240− fail "invalid range provided"
241− Just range -> do
242− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
243− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
244− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
245− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
246− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
247− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
248−
249− it "bound(14, 42, open, close)" do
250− let
251− lower = 14
252− upper = 42
211+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
212+ case mrange of
213+ Nothing ->
214+ fail "invalid range provided"
215+ Just range -> do
216+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
217+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
218+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
219+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
220+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
221+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
222+
223+ it "bound(14, 42, open, close)" do
224+ let lower = 14
225+ upper = 42
253226 lowerOpen = true
254227 upperOpen = false
255− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
256− case mrange of
257− Nothing ->
258− fail "invalid range provided"
259− Just range -> do
260− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
261− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
262− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
263− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
264− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
265− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
266−
267− it "bound(14, 42, close, open)" do
268− let
269− lower = 14
270− upper = 42
228+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
229+ case mrange of
230+ Nothing ->
231+ fail "invalid range provided"
232+ Just range -> do
233+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
234+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
235+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
236+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
237+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
238+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
239+
240+ it "bound(14, 42, close, open)" do
241+ let lower = 14
242+ upper = 42
271243 lowerOpen = false
272244 upperOpen = true
273− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
274− case mrange of
275− Nothing ->
276− fail "invalid range provided"
277− Just range -> do
278− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
279− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
280− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
281− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
282− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
283− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
284−
285− it "bound(14, 42, close, close)" do
286− let
287− lower = 14
288− upper = 42
245+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
246+ case mrange of
247+ Nothing ->
248+ fail "invalid range provided"
249+ Just range -> do
250+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
251+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
252+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
253+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
254+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
255+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
256+
257+ it "bound(14, 42, close, close)" do
258+ let lower = 14
259+ upper = 42
289260 lowerOpen = false
290261 upperOpen = false
291− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
292− case mrange of
293− Nothing ->
294− fail "invalid range provided"
295− Just range -> do
296− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
297− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
298− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
299− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
300− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
301− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
302−
303− it "can access attributes of a range" do
304− let range = IDBKeyRange.lowerBound 14 false
305− IDBKeyRange.lower range `shouldEqual` (Just $ toKey 14)
306− IDBKeyRange.upper range `shouldEqual` none
307− IDBKeyRange.lowerOpen range `shouldEqual` false
308− IDBKeyRange.upperOpen range `shouldEqual` true
309−
310− describe "IDBDatabase" do
311− let
262+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
263+ case mrange of
264+ Nothing ->
265+ fail "invalid range provided"
266+ Just range -> do
267+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
268+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
269+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
270+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
271+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
272+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
273+
274+ it "can access attributes of a range" do
275+ let range = IDBKeyRange.lowerBound 14 false
276+ IDBKeyRange.lower range `shouldEqual` (Just $ toKey 14)
277+ IDBKeyRange.upper range `shouldEqual` (Nothing :: Maybe Key)
278+ IDBKeyRange.lowerOpen range `shouldEqual` false
279+ IDBKeyRange.upperOpen range `shouldEqual` true
280+
281+ describe "IDBDatabase" do
282+ let
312283 tearDown db = do
313284 IDBDatabase.close db
314285 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
315286 pure unit
316287
317288 setup storeParams = do
318− let
319− onUpgradeNeeded var db _ _ = launchAff' do
320− store <- IDBDatabase.createObjectStore db "store" storeParams
321− _ <- AVar.put { db, store } var
322− pure unit
323−
324− var <- AVar.empty
325− _ <- IDBFactory.open "db" Nothing
326− { onUpgradeNeeded: Just (onUpgradeNeeded var)
327− , onBlocked: Nothing
289+ let onUpgradeNeeded var db _ = launchAff' do
290+ store <- IDBDatabase.createObjectStore db "store" storeParams
291+ _ <- putVar var { db, store }
292+ pure unit
293+
294+ var <- makeVar
295+ db <- IDBFactory.open "db" Nothing
296+ { onUpgradeNeeded : Just (onUpgradeNeeded var)
297+ , onBlocked : Nothing
328298 }
329299
330− AVar.take var
331−
332− it "createObjectStore (keyPath: [], autoIncrement: true)" do
333− { db, store } <- setup { keyPath: [], autoIncrement: true }
334− IDBObjectStore.name store `shouldEqual` "store"
335− IDBObjectStore.keyPath store `shouldEqual` []
336− IDBObjectStore.autoIncrement store `shouldEqual` true
337− IDBObjectStore.indexNames store `shouldEqual` []
338− tearDown db
339−
340− it "createObjectStore (keyPath: [\"patate\"], autoIncrement: true)" do
341− { db, store } <- setup { keyPath: [ "patate" ], autoIncrement: true }
342− IDBObjectStore.name store `shouldEqual` "store"
343− IDBObjectStore.keyPath store `shouldEqual` [ "patate" ]
344− IDBObjectStore.autoIncrement store `shouldEqual` true
345− IDBObjectStore.indexNames store `shouldEqual` []
346− tearDown db
347−
348− it "createObjectStore (keyPath: [\"a\", \"b\"], autoIncrement: false)" do
349− { db, store } <- setup { keyPath: [ "patate", "autruche" ], autoIncrement: false }
350− IDBObjectStore.name store `shouldEqual` "store"
351− IDBObjectStore.keyPath store `shouldEqual` [ "patate", "autruche" ]
352− IDBObjectStore.autoIncrement store `shouldEqual` false
353− IDBObjectStore.indexNames store `shouldEqual` []
354− tearDown db
355−
356− it "deleteObjectStore" do
357− let
358− onUpgradeNeeded var db _ _ = launchAff' do
300+ takeVar var
301+
302+ it "createObjectStore (keyPath: [], autoIncrement: true)" do
303+ { db, store } <- setup { keyPath: [], autoIncrement: true }
304+ IDBObjectStore.name store `shouldEqual` "store"
305+ IDBObjectStore.keyPath store `shouldEqual` []
306+ IDBObjectStore.autoIncrement store `shouldEqual` true
307+ IDBObjectStore.indexNames store `shouldEqual` []
308+ tearDown db
309+
310+ it "createObjectStore (keyPath: [\"patate\"], autoIncrement: true)" do
311+ { db, store } <- setup { keyPath: ["patate"], autoIncrement: true }
312+ IDBObjectStore.name store `shouldEqual` "store"
313+ IDBObjectStore.keyPath store `shouldEqual` ["patate"]
314+ IDBObjectStore.autoIncrement store `shouldEqual` true
315+ IDBObjectStore.indexNames store `shouldEqual` []
316+ tearDown db
317+
318+ it "createObjectStore (keyPath: [\"a\", \"b\"], autoIncrement: false)" do
319+ { db, store } <- setup { keyPath: ["patate", "autruche"], autoIncrement: false }
320+ IDBObjectStore.name store `shouldEqual` "store"
321+ IDBObjectStore.keyPath store `shouldEqual` ["patate", "autruche"]
322+ IDBObjectStore.autoIncrement store `shouldEqual` false
323+ IDBObjectStore.indexNames store `shouldEqual` []
324+ tearDown db
325+
326+ it "deleteObjectStore" do
327+ let onUpgradeNeeded var db _ = launchAff' do
359328 _ <- IDBDatabase.deleteObjectStore db "store"
360− AVar.put true var
361−
362− var <- AVar.empty
363− { db } <- setup IDBDatabase.defaultParameters
364− IDBDatabase.close db
365− db' <- IDBFactory.open "db" (Just 999)
366− { onUpgradeNeeded: Just (onUpgradeNeeded var)
367− , onBlocked: Nothing
368− }
369− deleted <- AVar.take var
370− deleted `shouldEqual` true
371− tearDown db'
329+ putVar var true
372330
373− describe "IDBObjectStore" do
374− let
375− tearDown db = do
376− IDBDatabase.close db
377− _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
378− pure unit
379−
380− setup { storeParams, onUpgradeNeeded } = do
381− let
382− onUpgradeNeeded' var db _ _ = launchAff' do
383− store <- IDBDatabase.createObjectStore db "store" storeParams
384− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure store)
385− AVar.put { db, store } var
386−
387− var <- AVar.empty
388− _ <- IDBFactory.open "db" Nothing
389− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
390− , onBlocked: Nothing
391− }
392−
393− AVar.take var
394−
395− it "add()" do
396− date <- liftEffect $ toDateTime <$> now
397− { db } <- setup
398− { storeParams: { autoIncrement: true, keyPath: [] }
399− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
400− -- no key
401− key <- IDBObjectStore.add store "patate" none
402− (toKey 1) `shouldEqual` key
403−
404− -- int key
405− key' <- IDBObjectStore.add store "patate" (Just 14)
406− (toKey 14) `shouldEqual` key'
407−
408− -- number key
409− key'' <- IDBObjectStore.add store "patate" (Just 14.42)
410− (toKey 14.42) `shouldEqual` key''
331+ var <- makeVar
332+ { db, store } <- setup IDBObjectStore.defaultParameters
333+ IDBDatabase.close db
334+ db <- IDBFactory.open "db" (Just 999) { onUpgradeNeeded : Just (onUpgradeNeeded var)
335+ , onBlocked : Nothing
336+ }
337+ deleted <- takeVar var
338+ deleted `shouldEqual` true
339+ tearDown db
411340
412− -- string key
413− key''' <- IDBObjectStore.add store "patate" (Just "key")
414− (toKey "key") `shouldEqual` key'''
415−
416− -- date key
417− key'''' <- IDBObjectStore.add store "patate" (Just date)
418− (toKey date) `shouldEqual` key''''
419−
420− -- array key
421− key''''' <- IDBObjectStore.add store "patate" (Just $ toKey [ 14, 42 ])
422− (toKey [ 14, 42 ]) `shouldEqual` key'''''
423− }
424− tearDown db
425−
426− it "clear()" do
427− { db } <- setup
428− { storeParams: IDBDatabase.defaultParameters
429− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
430− key <- IDBObjectStore.add store "patate" (Just 14)
431− _ <- IDBObjectStore.clear store
432− val <- IDBObjectStore.get store (IDBKeyRange.only key)
433− val `shouldEqual` (Nothing :: Maybe String)
434− }
435− tearDown db
436−
437− it "count()" do
438− { db } <- setup
439− { storeParams: IDBDatabase.defaultParameters
440− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
441− _ <- IDBObjectStore.add store "patate" (Just 14)
442− _ <- IDBObjectStore.add store "autruche" (Just 42)
443− n <- IDBObjectStore.count store Nothing
444− n `shouldEqual` 2
445− }
446− tearDown db
447−
448− it "getKey()" do
449− { db } <- setup
450− { storeParams: IDBDatabase.defaultParameters
451− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
452− key <- IDBObjectStore.add store "patate" (Just 14)
453− mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 14)
454− mkey `shouldEqual` (Just key)
455−
456− mkey' <- IDBObjectStore.getKey store (IDBKeyRange.only 42)
457− mkey' `shouldEqual` none
458− }
459− tearDown db
460−
461− it "getAllKeys()" do
462− { db } <- setup
463− { storeParams: IDBDatabase.defaultParameters
464− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
465− key1 <- IDBObjectStore.add store "patate" (Just 14)
466− key2 <- IDBObjectStore.add store "autruche" (Just 42)
467− key3 <- IDBObjectStore.add store 14 (Just 1337)
468−
469− -- no bounds
470− keys <- IDBObjectStore.getAllKeys store Nothing Nothing
471− keys `shouldEqual` [ key1, key2, key3 ]
472−
473− -- lower bound
474− keys' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 14 true) Nothing
475− keys' `shouldEqual` [ key2, key3 ]
476−
477− -- upper bound
478− keys'' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.upperBound 42 false) Nothing
479− keys'' `shouldEqual` [ key1, key2 ]
480−
481− -- count
482− keys''' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 1 true) (Just 2)
483− keys''' `shouldEqual` [ key1, key2 ]
484− }
485− tearDown db
486−
487− it "openCursor()" do
488− let
489− cb =
490− { onSuccess: const $ pure unit
491− , onError: show >>> fail >>> launchAff'
492− , onComplete: pure unit
493− }
494− { db } <- setup
495− { storeParams: IDBDatabase.defaultParameters
496− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
497− _ <- IDBObjectStore.openCursor store Nothing Next cb
498− _ <- IDBObjectStore.openCursor store Nothing NextUnique cb
499− _ <- IDBObjectStore.openCursor store Nothing Prev cb
500− _ <- IDBObjectStore.openCursor store Nothing PrevUnique cb
501− _ <- IDBObjectStore.openCursor store (Just $ IDBKeyRange.upperBound 1 true) Next cb
502− pure unit
503− }
504− tearDown db
505−
506− it "openKeyCursor()" do
507− let
508− cb =
509− { onSuccess: const $ pure unit
510− , onError: show >>> fail >>> launchAff'
511− , onComplete: pure unit
512− }
513− { db } <- setup
514− { storeParams: IDBDatabase.defaultParameters
515− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
516− _ <- IDBObjectStore.openKeyCursor store Nothing Next cb
517− _ <- IDBObjectStore.openKeyCursor store Nothing NextUnique cb
518− _ <- IDBObjectStore.openKeyCursor store Nothing Prev cb
519− _ <- IDBObjectStore.openKeyCursor store Nothing PrevUnique cb
520− _ <- IDBObjectStore.openKeyCursor store (Just $ IDBKeyRange.lowerBound 1 true) Next cb
521− pure unit
522− }
523− tearDown db
524341
525− describe "IDBIndex" do
526− let
342+ describe "IDBObjectStore" do
343+ let
527344 tearDown db = do
528345 IDBDatabase.close db
529346 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
530347 pure unit
531348
532− setup
533− :: forall value
534− . { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
535− , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
536− , values :: Array (Tuple value (Maybe Key))
537− , keyPath :: Array String
538− , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Effect Unit)
539− }
540− -> Aff { db :: Database, index :: Index, store :: ObjectStore }
541− setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
542− let
543− onUpgradeNeeded' var db tx _ = launchAff' do
544− store <- IDBDatabase.createObjectStore db "store" storeParams
545− _ <- traverse (uncurry (IDBObjectStore.add store)) values
546− index <- IDBObjectStore.createIndex store "index" keyPath indexParams
547− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
548− AVar.put { db, index, store } var
549−
550− var <- AVar.empty
551− _ <- IDBFactory.open "db" Nothing
552− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
553− , onBlocked: Nothing
554− }
555− AVar.take var
556−
557− it "returns an IDBIndex and the properties are set correctly" do
558− { db, index } <- setup
559− { storeParams: IDBDatabase.defaultParameters
560− , indexParams: IDBObjectStore.defaultParameters
561− , onUpgradeNeeded: Nothing
562− , keyPath: []
563− , values: []
564− }
565− IDBIndex.name index `shouldEqual` "index"
566− IDBIndex.keyPath index `shouldEqual` []
567− IDBIndex.unique index `shouldEqual` IDBObjectStore.defaultParameters.unique
568− IDBIndex.multiEntry index `shouldEqual` IDBObjectStore.defaultParameters.multiEntry
569− tearDown db
570−
571− it "attempt to create an index that requires unique values on an object store already contains duplicates" do
572− let onAbort var = launchAff' (AVar.put true var)
573− txVar <- AVar.empty
574− dbVar <- AVar.empty
575− res <- attempt $ setup
576− { storeParams: IDBDatabase.defaultParameters
577− , indexParams:
578− { unique: true
579− , multiEntry: false
580− }
581− , keyPath: [ "indexedProperty" ]
582− , values:
583− [ { indexedProperty: "bar" } :+: (Just $ toKey 1)
584− , { indexedProperty: "bar" } :+: (Just $ toKey 2)
585− ]
586− , onUpgradeNeeded: Just $ \db tx _ -> launchAff' do
587− IDBTransaction.onAbort tx (onAbort txVar)
588− IDBDatabase.onAbort db (onAbort dbVar)
589− }
590− case res of
591− Right _ ->
592− fail "expected abort"
593− _ -> do
594− shouldEqual true =<< AVar.take txVar
595− shouldEqual true =<< AVar.take dbVar
596−
597− it "the index is usable right after being made" do
598− { db } <- setup
599− { storeParams:
600− { keyPath: [ "key" ]
601− , autoIncrement: false
602− }
603− , indexParams: IDBObjectStore.defaultParameters
604− , keyPath: [ "indexedProperty" ]
605− , values:
606− [ { key: "key1", indexedProperty: "indexed_1" } :+: Nothing
607− , { key: "key2", indexedProperty: "indexed_2" } :+: Nothing
608− , { key: "key3", indexedProperty: "indexed_3" } :+: Nothing
609− ]
610− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
611− val <- IDBIndex.get index (IDBKeyRange.only "indexed_2")
612− ((\r -> r.key) <$> val) `shouldEqual` (Just $ toKey "key2")
613− }
614− tearDown db
615−
616− it "empty keyPath" do
617− { db } <- setup
618− { storeParams: IDBDatabase.defaultParameters
619− , indexParams: IDBObjectStore.defaultParameters
620− , keyPath: []
621− , values:
622− [ "object_1" :+: (Just $ toKey 1)
623− , "object_2" :+: (Just $ toKey 2)
624− , "object_3" :+: (Just $ toKey 3)
625− ]
626− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
627− val <- IDBIndex.get index (IDBKeyRange.only "object_3")
628− val `shouldEqual` (Just "object_3")
629− }
630− tearDown db
631−
632− it "index can be valid keys [date]" do
633− date <- liftEffect $ toDateTime <$> now
634− { db } <- setup
635− { storeParams:
636− { keyPath: [ "key" ]
637− , autoIncrement: false
638− }
639− , indexParams: IDBObjectStore.defaultParameters
640− , keyPath: [ "i" ]
641− , values:
642− [ { key: "date", i: (toKey date) } :+: Nothing
643− ]
644− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
645− val <- IDBIndex.get index (IDBKeyRange.only date)
646− ((\r -> r.key) <$> val) `shouldEqual` (Just "date")
647− }
648− tearDown db
649−
650− it "index can be valid keys [num]" do
651− let num = 14
652− { db } <- setup
653− { storeParams:
654− { keyPath: [ "key" ]
655− , autoIncrement: false
656− }
657− , indexParams: IDBObjectStore.defaultParameters
658− , keyPath: [ "i" ]
659− , values:
660− [ { key: "num", i: (toKey num) } :+: Nothing
661− ]
662− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
663− val <- IDBIndex.get index (IDBKeyRange.only num)
664− ((\r -> r.key) <$> val) `shouldEqual` (Just "num")
665− }
666− tearDown db
667−
668− it "index can be valid keys [array]" do
669− let array = [ "patate", "autruche" ]
670− { db } <- setup
671− { storeParams:
672− { keyPath: [ "key" ]
673− , autoIncrement: false
674− }
675− , indexParams: IDBObjectStore.defaultParameters
676− , keyPath: [ "i" ]
677− , values:
678− [ { key: "array", i: (toKey array) } :+: Nothing
679− ]
680− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
681− val <- IDBIndex.get index (IDBKeyRange.only array)
682− ((\r -> r.key) <$> val) `shouldEqual` (Just "array")
683− }
684− tearDown db
685−
686− it "openKeyCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
687− res <- attempt $ setup
688− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
689− , indexParams: IDBObjectStore.defaultParameters
690− , keyPath: [ "indexedProperty" ]
691− , values:
692− [ { key: 14, indexedProperty: "patate" } :+: Nothing
693− ]
694− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
695− let
696− cb =
697− { onSuccess: const $ pure unit
698− , onError: show >>> fail >>> launchAff'
699− , onComplete: pure unit
700− }
701− IDBTransaction.onAbort tx (pure unit)
702− IDBDatabase.onAbort db (pure unit)
703− IDBTransaction.abort tx
704− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
705− case cursor of
706− Right _ -> fail "expected InvalidStateError"
707− Left err -> name err `shouldEqual` "InvalidStateError"
708− }
709− case res of
710− Right _ -> fail "expected InvalidStateError"
711− _ -> pure unit
712−
713− it "openKeyCursor() - throw TransactionInactiveError on aborted transaction" do
714− { db } <- setup
715− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
716− , indexParams: IDBObjectStore.defaultParameters
717− , keyPath: [ "indexedProperty" ]
718− , values:
719− [ { key: 14, indexedProperty: "patate" } :+: Nothing
720− ]
721− , onUpgradeNeeded: Nothing
722− }
723− let
724− cb =
725− { onSuccess: const $ pure unit
726− , onError: show >>> fail >>> launchAff'
727− , onComplete: pure unit
728− }
729− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
730− store <- IDBTransaction.objectStore tx "store"
731− index <- IDBObjectStore.index store "index"
732− IDBTransaction.onAbort tx (pure unit)
733− IDBTransaction.abort tx
734− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
735− case cursor of
736− Right _ -> fail "expected TransactionInactiveError"
737− Left err -> name err `shouldEqual` "TransactionInactiveError"
738−
739− tearDown db
740−
741− it "openKeyCursor() - throw InvalidStateError when the index is deleted" do
742− { db } <- setup
743− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
744− , indexParams: IDBObjectStore.defaultParameters
745− , keyPath: [ "indexedProperty" ]
746− , values:
747− [ { key: 14, indexedProperty: "patate" } :+: Nothing
748− ]
749− , onUpgradeNeeded: Just $ \_ tx index -> launchAff' do
750− let
751− cb =
752− { onSuccess: const $ pure unit
753− , onError: show >>> fail >>> launchAff'
754− , onComplete: pure unit
755− }
756− store <- IDBTransaction.objectStore tx "store"
757− IDBObjectStore.deleteIndex store "index"
758− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
759− case cursor of
760− Right _ -> fail "expected InvalidStateError"
761− Left err -> name err `shouldEqual` "InvalidStateError"
762− }
763−
764− tearDown db
765−
766− it "openCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
767− res <- attempt $ setup
768− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
769− , indexParams: IDBObjectStore.defaultParameters
770− , keyPath: [ "indexedProperty" ]
771− , values:
772− [ { key: 14, indexedProperty: "patate" } :+: Nothing
773− ]
774− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
775− let
776− cb =
777− { onSuccess: const $ pure unit
778− , onError: show >>> fail >>> launchAff'
779− , onComplete: pure unit
780− }
781− IDBTransaction.onAbort tx (pure unit)
782− IDBDatabase.onAbort db (pure unit)
783− IDBTransaction.abort tx
784− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
785− case cursor of
786− Right _ -> fail "expected InvalidStateError"
787− Left err -> name err `shouldEqual` "InvalidStateError"
788− }
789− case res of
790− Right _ -> fail "expected InvalidStateError"
791− _ -> pure unit
792−
793− it "openCursor() - throw TransactionInactiveError on aborted transaction" do
794− { db } <- setup
795− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
796− , indexParams: IDBObjectStore.defaultParameters
797− , keyPath: [ "indexedProperty" ]
798− , values:
799− [ { key: 14, indexedProperty: "patate" } :+: Nothing
800− ]
801− , onUpgradeNeeded: Nothing
802− }
803− let
804− cb =
805− { onSuccess: const $ pure unit
806− , onError: show >>> fail >>> launchAff'
807− , onComplete: pure unit
349+ setup { storeParams, onUpgradeNeeded } = do
350+ let onUpgradeNeeded' var db _ = launchAff' do
351+ store <- IDBDatabase.createObjectStore db "store" storeParams
352+ liftEff $ maybe (pure unit) id (onUpgradeNeeded <*> pure db <*> pure store)
353+ putVar var { db, store }
354+
355+ var <- makeVar
356+ db <- IDBFactory.open "db" Nothing
357+ { onUpgradeNeeded : Just (onUpgradeNeeded' var)
358+ , onBlocked : Nothing
808359 }
809− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
810− store <- IDBTransaction.objectStore tx "store"
811− index <- IDBObjectStore.index store "index"
812− IDBTransaction.onAbort tx (pure unit)
813− IDBTransaction.abort tx
814− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
815− case cursor of
816− Right _ -> fail "expected TransactionInactiveError"
817− Left err -> name err `shouldEqual` "TransactionInactiveError"
818−
819− tearDown db
820−
821− it "openCursor() - throw InvalidStateError when the index is deleted" do
822− { db } <- setup
823− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
824− , indexParams: IDBObjectStore.defaultParameters
825− , keyPath: [ "indexedProperty" ]
826− , values:
827− [ { key: 14, indexedProperty: "patate" } :+: Nothing
828− ]
829− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
830− let
831− cb =
832− { onSuccess: const $ pure unit
833− , onError: show >>> fail >>> launchAff'
834− , onComplete: pure unit
835− }
836− store <- IDBTransaction.objectStore tx "store"
837− IDBObjectStore.deleteIndex store "index"
838− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
839− case cursor of
840− Right _ -> fail "expected InvalidStateError"
841− Left err -> name err `shouldEqual` "InvalidStateError"
842− }
843360
844− tearDown db
845−
846− it "getKey() - multiEntry - adding keys" do
847− { db } <- setup
848− { storeParams: IDBDatabase.defaultParameters
849− , indexParams: { unique: false, multiEntry: true }
850− , keyPath: [ "name" ]
851− , values:
852− [ { name: [ "patate", "autruche" ] } :+: (Just $ toKey 1)
853− , { name: [ "bob" ] } :+: (Just $ toKey 2)
854− ]
855− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
856− key <- IDBIndex.getKey index (IDBKeyRange.only "patate")
857− key `shouldEqual` (Just $ toKey 1)
858−
859− key' <- IDBIndex.getKey index (IDBKeyRange.only "autruche")
860− key' `shouldEqual` (Just $ toKey 1)
861−
862− key'' <- IDBIndex.getKey index (IDBKeyRange.only "bob")
863− key'' `shouldEqual` (Just $ toKey 2)
864− }
865− tearDown db
866−
867− it "get() - returns the record with the first key in the range" do
868− { db } <- setup
869− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
870− , indexParams: IDBObjectStore.defaultParameters
871− , keyPath: [ "indexedProperty" ]
872− , values:
873− [ { key: 14, indexedProperty: "patate" } :+: Nothing
874− , { key: 42, indexedProperty: "autruche" } :+: Nothing
875− , { key: 1337, indexedProperty: "baguette" } :+: Nothing
876− ]
877− , onUpgradeNeeded: Nothing
878− }
879−
880− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
881− store <- IDBTransaction.objectStore tx "store"
882− index <- IDBObjectStore.index store "index"
883− val <- IDBIndex.get index (IDBKeyRange.lowerBound "autruche" false)
884− ((\r -> r.key) <$> val) `shouldEqual` (Just 42)
885−
886− tearDown db
361+ takeVar var
362+
363+ it "add()" do
364+ date <- liftEff $ toDateTime <$> now
365+ { db } <- setup
366+ { storeParams: { autoIncrement: true, keyPath: [] }
367+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
368+ -- no key
369+ key <- IDBObjectStore.add store "patate" (Nothing :: Maybe Key)
370+ (toKey 1) `shouldEqual` key
371+
372+ -- int key
373+ key <- IDBObjectStore.add store "patate" (Just 14)
374+ (toKey 14) `shouldEqual` key
375+
376+ -- number key
377+ key <- IDBObjectStore.add store "patate" (Just 14.42)
378+ (toKey 14.42) `shouldEqual` key
379+
380+ -- string key
381+ key <- IDBObjectStore.add store "patate" (Just "key")
382+ (toKey "key") `shouldEqual` key
383+
384+ -- date key
385+ key <- IDBObjectStore.add store "patate" (Just date)
386+ (toKey date) `shouldEqual` key
387+
388+ -- array key
389+ key <- IDBObjectStore.add store "patate" (Just $ toKey [14, 42])
390+ (toKey [14, 42]) `shouldEqual` key
391+ }
392+ tearDown db
393+
394+ it "clear()" do
395+ { db } <- setup
396+ { storeParams: IDBObjectStore.defaultParameters
397+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
398+ key <- IDBObjectStore.add store "patate" (Just 14)
399+ _ <- IDBObjectStore.clear store
400+ val <- IDBObjectStore.get store (IDBKeyRange.only key)
401+ val `shouldEqual` (Nothing :: Maybe String)
402+ }
403+ tearDown db
404+
405+ it "count()" do
406+ { db } <- setup
407+ { storeParams: IDBObjectStore.defaultParameters
408+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
409+ key <- IDBObjectStore.add store "patate" (Just 14)
410+ key <- IDBObjectStore.add store "autruche" (Just 42)
411+ n <- IDBObjectStore.count store Nothing
412+ n `shouldEqual` 2
413+ }
414+ tearDown db
415+
416+ it "getKey()" do
417+ { db } <- setup
418+ { storeParams: IDBObjectStore.defaultParameters
419+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
420+ key <- IDBObjectStore.add store "patate" (Just 14)
421+ mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 14)
422+ mkey `shouldEqual` (Just key)
423+
424+ mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 42)
425+ mkey `shouldEqual` (Nothing :: Maybe Key)
426+ }
427+ tearDown db
428+
429+ it "getAllKeys()" do
430+ { db } <- setup
431+ { storeParams: IDBObjectStore.defaultParameters
432+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
433+ key1 <- IDBObjectStore.add store "patate" (Just 14)
434+ key2 <- IDBObjectStore.add store "autruche" (Just 42)
435+ key3 <- IDBObjectStore.add store 14 (Just 1337)
436+
437+ -- no bounds
438+ keys <- IDBObjectStore.getAllKeys store Nothing Nothing
439+ keys `shouldEqual` [key1, key2, key3]
440+
441+ -- lower bound
442+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 14 true) Nothing
443+ keys `shouldEqual` [key2, key3]
444+
445+ -- upper bound
446+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.upperBound 42 false) Nothing
447+ keys `shouldEqual` [key1, key2]
448+
449+ -- count
450+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 1 true) (Just 2)
451+ keys `shouldEqual` [key1, key2]
452+ }
453+ tearDown db
454+
455+ it "openCursor()" do
456+ { db } <- setup
457+ { storeParams: IDBObjectStore.defaultParameters
458+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
459+ _ <- IDBObjectStore.openCursor store Nothing Next
460+ _ <- IDBObjectStore.openCursor store Nothing NextUnique
461+ _ <- IDBObjectStore.openCursor store Nothing Prev
462+ _ <- IDBObjectStore.openCursor store Nothing PrevUnique
463+ _ <- IDBObjectStore.openCursor store (Just $ IDBKeyRange.upperBound 1 true) Next
464+ pure unit
465+ }
466+ tearDown db
467+
468+ it "openKeyCursor()" do
469+ { db } <- setup
470+ { storeParams: IDBObjectStore.defaultParameters
471+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
472+ _ <- IDBObjectStore.openKeyCursor store Nothing Next
473+ _ <- IDBObjectStore.openKeyCursor store Nothing NextUnique
474+ _ <- IDBObjectStore.openKeyCursor store Nothing Prev
475+ _ <- IDBObjectStore.openKeyCursor store Nothing PrevUnique
476+ _ <- IDBObjectStore.openKeyCursor store (Just $ IDBKeyRange.lowerBound 1 true) Next
477+ pure unit
478+ }
479+ tearDown db
887480
888− describe "IDBCursor" do
889− let
481+ describe "IDBIndex" do
482+ let
890483 tearDown db = do
891484 IDBDatabase.close db
892485 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
893486 pure unit
894487
895− setup
896− :: forall value
897− . { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
898− , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
899− , values :: Array (Tuple value (Maybe Key))
900− , keyPath :: Array String
901− , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Effect Unit)
902− }
903− -> Aff { db :: Database, index :: Index, store :: ObjectStore }
488+ setup :: forall value e e'.
489+ { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
490+ , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
491+ , values :: Array (Tuple value (Maybe Key))
492+ , keyPath :: Array String
493+ , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Eff (idb :: IDB, avar :: AVAR, exception :: EXCEPTION | e') Unit)
494+ } -> Aff (idb :: IDB, avar :: AVAR | e) { db :: Database, index :: Index, store :: ObjectStore }
904495 setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
905− let
906− onUpgradeNeeded' var db tx _ = launchAff' do
907− store <- IDBDatabase.createObjectStore db "store" storeParams
908− _ <- traverse (uncurry (IDBObjectStore.add store)) values
909− index <- IDBObjectStore.createIndex store "index" keyPath indexParams
910− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
911− AVar.put { db, index, store } var
912−
913− var <- AVar.empty
914− db <- IDBFactory.open "db" Nothing
915− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
916− , onBlocked: Nothing
917− }
918− AVar.take var
919−
920− it "continue() - iterate to the next record" do
921− { db } <- setup
922− { storeParams: IDBDatabase.defaultParameters
923− , indexParams: IDBObjectStore.defaultParameters
924− , keyPath: []
925− , values:
926− [ "cupcake" :+: (Just $ toKey 4)
927− , "pancake" :+: (Just $ toKey 2)
928− , "pie" :+: (Just $ toKey 1)
929− , "pie" :+: (Just $ toKey 3)
930− ]
931− , onUpgradeNeeded: Nothing
932− }
933− let
934− cb vdone vvals =
935− { onComplete: launchAff' do
936− AVar.put unit vdone
937−
938− , onError: \error -> launchAff' do
939− fail $ "unexpected error: " <> show error
940−
941− , onSuccess: \cursor -> launchAff' do
942− vals <- AVar.take vvals
943− pure (IDBCursor.value cursor) >>= shouldEqual (maybe "" _.v $ head vals)
944− IDBCursor.primaryKey cursor >>= shouldEqual (maybe (toKey 0) _.k $ head vals)
945− AVar.put (drop 1 vals) vvals
946− IDBCursor.continue cursor none
947− }
948− vdone <- AVar.empty
949− vvals <- AVar.new
950− [ { v: "pie", k: toKey 1 }
951− , { v: "pancake", k: toKey 2 }
952− , { v: "pie", k: toKey 3 }
953− , { v: "cupcake", k: toKey 4 }
954− ]
955− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
956− store <- IDBTransaction.objectStore tx "store"
957− IDBObjectStore.openCursor store Nothing Next (cb vdone vvals)
958− AVar.take vdone
959− tearDown db
960−
961− it "continue() - attempt to iterate in the wrong direction" do
962− { db } <- setup
963− { storeParams: IDBDatabase.defaultParameters
964− , indexParams: IDBObjectStore.defaultParameters
965− , keyPath: []
966− , values:
967− [ "cupcake" :+: (Just $ toKey 4)
968− , "pancake" :+: (Just $ toKey 2)
969− , "pie" :+: (Just $ toKey 1)
970− , "pie" :+: (Just $ toKey 3)
971− ]
972− , onUpgradeNeeded: Nothing
973− }
974− let
975− cb vdone =
976− { onComplete: launchAff' do
977− fail $ "shouldn't complete"
978−
979− , onError: \error -> launchAff' do
980− fail $ "unexpected error: " <> show error
981−
982− , onSuccess: \cursor -> launchAff' do
983− res <- attempt $ IDBCursor.continue cursor (Just 1)
984− case res of
985− Left err -> do
986− name err `shouldEqual` "DataError"
987− AVar.put unit vdone
988− Right _ -> do
989− fail "expected continue to fail"
496+ let onUpgradeNeeded' var db tx = launchAff' do
497+ store <- IDBDatabase.createObjectStore db "store" storeParams
498+ _ <- traverse (uncurry (IDBObjectStore.add store)) values
499+ index <- IDBObjectStore.createIndex store "index" keyPath indexParams
500+ liftEff $ maybe (pure unit) id (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
501+ putVar var { db, index, store }
502+
503+ var <- makeVar
504+ db <- IDBFactory.open "db" Nothing
505+ { onUpgradeNeeded : Just (onUpgradeNeeded' var)
506+ , onBlocked : Nothing
990507 }
991− vdone <- AVar.empty
992− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
993− store <- IDBTransaction.objectStore tx "store"
994− IDBObjectStore.openCursor store Nothing Next (cb vdone)
995− AVar.take vdone
996− tearDown db
997−
998− it "advance() - iterate cursor number of times specified by count" do
999− { db } <- setup
1000− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1001− , indexParams: IDBObjectStore.defaultParameters
1002− , keyPath: []
1003− , values:
1004− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1005− , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
1006− , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
1007− , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
1008− ]
1009− , onUpgradeNeeded: Nothing
1010− }
1011− let
1012− cb vdone vjump =
1013− { onComplete: launchAff' do
1014− AVar.put unit vdone
1015−
1016− , onError: \error -> launchAff' do
1017− fail $ "unexpected error: " <> show error
1018−
1019− , onSuccess: \cursor -> launchAff' do
1020− jump <- AVar.take vjump
1021− if jump then do
1022− IDBCursor.advance cursor 3
1023− else do
1024− let value = IDBCursor.value cursor
1025− value.pKey `shouldEqual` "pkey_3"
1026− value.iKey `shouldEqual` "ikey_3"
1027− IDBCursor.continue cursor none
1028− AVar.put false vjump
1029− }
1030− vdone <- AVar.empty
1031− vjump <- AVar.new true
1032− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
1033− store <- IDBTransaction.objectStore tx "store"
1034− IDBObjectStore.openCursor store Nothing Next (cb vdone vjump)
1035− AVar.take vdone
1036− tearDown db
1037−
1038− it "delete() - remove a record from the object store" do
1039− { db } <- setup
1040− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1041− , indexParams: IDBObjectStore.defaultParameters
1042− , keyPath: []
1043− , values:
1044− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1045− , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
1046− , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
1047− , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
1048− ]
1049− , onUpgradeNeeded: Nothing
1050− }
1051− let
1052− cb vdone store =
1053− { onComplete: launchAff' do
1054− mval <- map _.pKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
1055− mval `shouldEqual` (Nothing :: Maybe String)
1056− AVar.put unit vdone
1057−
1058− , onError: \error -> launchAff' do
1059− fail $ "unexpected error: " <> show error
1060−
1061− , onSuccess: \cursor -> launchAff' do
1062− let value = IDBCursor.value cursor
1063− value.pKey `shouldEqual` "pkey_0"
1064− IDBCursor.delete cursor
1065− IDBCursor.advance cursor 4
1066− }
1067− vdone <- AVar.empty
1068− tx <- IDBDatabase.transaction db [ "store" ] ReadWrite
1069− store <- IDBTransaction.objectStore tx "store"
1070− IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1071− AVar.take vdone
1072− tearDown db
1073−
1074− it "update() - modify a record in the object store" do
1075− { db } <- setup
1076− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1077− , indexParams: IDBObjectStore.defaultParameters
1078− , keyPath: []
1079− , values:
1080− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1081− ]
1082− , onUpgradeNeeded: Nothing
1083− }
1084− let
1085− cb vdone store =
1086− { onComplete: launchAff' do
1087− mval <- map _.iKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
1088− mval `shouldEqual` (Just "patate")
1089− AVar.put unit vdone
1090−
1091− , onError: \error -> launchAff' do
1092− fail $ "unexpected error: " <> show error
1093−
1094− , onSuccess: \cursor -> launchAff' do
1095− let value = IDBCursor.value cursor
1096− value.pKey `shouldEqual` "pkey_0"
1097− key <- IDBCursor.update cursor { pKey: "pkey_0", iKey: "patate" }
1098− key `shouldEqual` toKey "pkey_0"
1099− IDBCursor.advance cursor 4
1100− }
1101− vdone <- AVar.empty
1102− tx <- IDBDatabase.transaction db [ "store" ] ReadWrite
1103− store <- IDBTransaction.objectStore tx "store"
1104− IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1105− AVar.take vdone
1106− tearDown db
1107−
1108− it "update() - throw ReadOnlyError after update on ReadOnly transaction" do
1109− { db } <- setup
1110− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1111− , indexParams: IDBObjectStore.defaultParameters
1112− , keyPath: []
1113− , values:
1114− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1115− ]
1116− , onUpgradeNeeded: Nothing
1117− }
1118− let
1119− cb vdone =
1120− { onComplete: launchAff' do
1121− fail $ "shouldn't complete"
1122−
1123− , onError: \error -> launchAff' do
1124− fail $ "unexpected error: " <> show error
1125−
1126− , onSuccess: \cursor -> launchAff' do
1127− res <- attempt $ IDBCursor.update cursor "patate"
1128− case res of
1129− Left err -> do
1130− name err `shouldEqual` "ReadOnlyError"
1131− AVar.put unit vdone
1132− Right _ ->
1133− fail $ "expected ReadOnlyError"
1134− }
1135− vdone <- AVar.empty
1136− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
1137− store <- IDBTransaction.objectStore tx "store"
1138− IDBObjectStore.openCursor store Nothing Next (cb vdone)
1139− AVar.take vdone
1140− tearDown db
1141−
508+ takeVar var
509+
510+
511+ it "returns an IDBIndex and the properties are set correctly" do
512+ { db, index } <- setup
513+ { storeParams : IDBObjectStore.defaultParameters
514+ , indexParams : IDBIndex.defaultParameters
515+ , onUpgradeNeeded : Nothing
516+ , keyPath : []
517+ , values : []
518+ }
519+ IDBIndex.name index `shouldEqual` "index"
520+ IDBIndex.keyPath index `shouldEqual` []
521+ IDBIndex.unique index `shouldEqual` IDBIndex.defaultParameters.unique
522+ IDBIndex.multiEntry index `shouldEqual` IDBIndex.defaultParameters.multiEntry
523+ tearDown db
524+
525+ it "attempt to create an index that requires unique values on an object store already contains duplicates" do
526+ let onAbort var = launchAff' (putVar var true)
527+ txVar <- makeVar
528+ dbVar <- makeVar
529+ res <- attempt $ setup
530+ { storeParams : IDBObjectStore.defaultParameters
531+ , indexParams : { unique : true
532+ , multiEntry : false
533+ }
534+ , keyPath : ["indexedProperty"]
535+ , values : [ { indexedProperty: "bar" } :+: (Just $ toKey 1)
536+ , { indexedProperty: "bar" } :+: (Just $ toKey 2)
537+ ]
538+ , onUpgradeNeeded : Just $ \db tx _ -> launchAff' do
539+ IDBTransaction.onAbort tx (onAbort txVar)
540+ IDBDatabase.onAbort db (onAbort dbVar)
541+ }
542+ case res of
543+ Right _ ->
544+ fail "expected abort"
545+ _ -> do
546+ shouldEqual true =<< takeVar txVar
547+ shouldEqual true =<< takeVar dbVar
548+
549+
550+ it "the index is usable right after being made" do
551+ { db } <- setup
552+ { storeParams : { keyPath : ["key"]
553+ , autoIncrement : false
554+ }
555+ , indexParams : IDBIndex.defaultParameters
556+ , keyPath : ["indexedProperty"]
557+ , values : [ { key: "key1", indexedProperty: "indexed_1" } :+: Nothing
558+ , { key: "key2", indexedProperty: "indexed_2" } :+: Nothing
559+ , { key: "key3", indexedProperty: "indexed_3" } :+: Nothing
560+ ]
561+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
562+ val <- IDBIndex.get index (IDBKeyRange.only "indexed_2")
563+ ((\r -> r.key) <$> val) `shouldEqual` (Just $ toKey "key2")
564+ }
565+ tearDown db
566+
567+ it "empty keyPath" do
568+ { db } <- setup
569+ { storeParams : IDBObjectStore.defaultParameters
570+ , indexParams : IDBIndex.defaultParameters
571+ , keyPath : []
572+ , values : [ "object_1" :+: (Just $ toKey 1)
573+ , "object_2" :+: (Just $ toKey 2)
574+ , "object_3" :+: (Just $ toKey 3)
575+ ]
576+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
577+ val <- IDBIndex.get index (IDBKeyRange.only "object_3")
578+ val `shouldEqual` (Just "object_3")
579+ }
580+ tearDown db
581+
582+ it "index can be valid keys [date]" do
583+ date <- liftEff $ toDateTime <$> now
584+ { db } <- setup
585+ { storeParams : { keyPath: ["key"]
586+ , autoIncrement: false
587+ }
588+ , indexParams : IDBIndex.defaultParameters
589+ , keyPath : ["i"]
590+ , values : [ { key: "date", i: (toKey date) } :+: Nothing
591+ ]
592+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
593+ val <- IDBIndex.get index (IDBKeyRange.only date)
594+ ((\r -> r.key) <$> val) `shouldEqual` (Just "date")
595+ }
596+ tearDown db
597+
598+ it "index can be valid keys [num]" do
599+ let num = 14
600+ { db } <- setup
601+ { storeParams : { keyPath: ["key"]
602+ , autoIncrement: false
603+ }
604+ , indexParams : IDBIndex.defaultParameters
605+ , keyPath : ["i"]
606+ , values : [ { key: "num", i: (toKey num) } :+: Nothing
607+ ]
608+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
609+ val <- IDBIndex.get index (IDBKeyRange.only num)
610+ ((\r -> r.key) <$> val) `shouldEqual` (Just "num")
611+ }
612+ tearDown db
613+
614+ it "index can be valid keys [array]" do
615+ let array = ["patate", "autruche"]
616+ { db } <- setup
617+ { storeParams : { keyPath: ["key"]
618+ , autoIncrement: false
619+ }
620+ , indexParams : IDBIndex.defaultParameters
621+ , keyPath : ["i"]
622+ , values : [ { key: "array", i: (toKey array) } :+: Nothing
623+ ]
624+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
625+ val <- IDBIndex.get index (IDBKeyRange.only array)
626+ ((\r -> r.key) <$> val) `shouldEqual` (Just "array")
627+ }
628+ tearDown db
629+
630+ it "multiEntry - adding keys" do
631+ { db } <- setup
632+ { storeParams : IDBObjectStore.defaultParameters
633+ , indexParams : { unique: false, multiEntry: true }
634+ , keyPath : ["name"]
635+ , values : [ { name: ["patate", "autruche"] } :+: (Just $ toKey 1)
636+ , { name: ["bob"] } :+: (Just $ toKey 2)
637+ ]
638+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
639+ key <- IDBIndex.getKey index (IDBKeyRange.only "patate")
640+ key `shouldEqual` (Just $ toKey 1)
641+
642+ key <- IDBIndex.getKey index (IDBKeyRange.only "autruche")
643+ key `shouldEqual` (Just $ toKey 1)
644+
645+ key <- IDBIndex.getKey index (IDBKeyRange.only "bob")
646+ key `shouldEqual` (Just $ toKey 2)
647+ }
648+ tearDown db