@@ -2,521 +2,1140 @@ module Test.Main where
22
33import Prelude
44
5−import Control.Monad.Aff (Aff, launchAff, forkAff, delay)
6−import Control.Monad.Aff.AVar (AVAR, makeVar', modifyVar, peekVar, killVar)
7−import Control.Monad.Eff (Eff)
8−import Control.Monad.Eff.Class (liftEff)
9−import Control.Monad.Eff.Exception (EXCEPTION)
10−import Data.Date as Date
11−import Data.DateTime as DateTime
12−import Data.DateTime (DateTime(..), Date(..), Time(..))
13−import Data.Enum (toEnum)
14−import Data.Maybe (Maybe(..), isNothing)
15−import Data.Time.Duration (Milliseconds(..))
16−import Test.Spec (describe, it)
17−import Test.Spec.Assertions (shouldEqual, fail)
18−import Test.Spec.Mocha (MOCHA, runMocha)
19−
20−import Database.IndexedDB.Core
21−import Database.IndexedDB.IDBKey
22−import Database.IndexedDB.IDBDatabase as IDBDatabase
23−import Database.IndexedDB.IDBFactory as IDBFactory
24−import Database.IndexedDB.IDBObjectStore as IDBObjectStore
25−import Database.IndexedDB.IDBKeyRange as IDBKeyRange
26−
27−
28−tearDown :: forall eff. String -> Int -> Database -> Aff (idb :: INDEXED_DB, exception :: EXCEPTION | eff) Unit
29−tearDown name version db = do
30− liftEff $ IDBDatabase.close db
31− version' <- IDBFactory.deleteDatabase name
32− version' `shouldEqual` version
33−
34−-- main :: forall eff. Eff (mocha :: MOCHA, idb :: INDEXED_DB, exception :: EXCEPTION, avar :: AVAR | eff) Unit
35−main = runMocha do
36− describe "IDBFactory" do
37− it "open default" do
38− let name = "db-default"
39− version = 1
40− db <- IDBFactory.open name Nothing
41− { onUpgradeNeeded : Nothing
42− , onBlocked : Nothing
43− }
44− IDBDatabase.name db `shouldEqual` name
45− tearDown name version db
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)
4636
37+infixr 7 Tuple as :+:
4738
48− it "open specific version" do
49− let name = "db-specific"
50− version = 14
51− db <- IDBFactory.open name (Just version)
52− { onUpgradeNeeded : Nothing
53− , onBlocked : Nothing
54− }
55− IDBDatabase.name db `shouldEqual` name
56− tearDown name version db
39+launchAff' :: forall a. Aff a -> Effect Unit
40+launchAff' =
41+ launchAff_ <<< void
42+
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
47+
48+main :: Effect Unit
49+main = do
50+ launchAff_ $ runSpec [ consoleReporter ] $ do
51+ describe "IDBFactory" do
52+ let
53+ tearDown name version db = do
54+ IDBDatabase.close db
55+ version' <- IDBFactory.deleteDatabase name
56+ liftEffect $ log $ show version'
57+ version' `shouldEqual` version
5758
59+ it "open default" do
60+ let
61+ name = "db-default"
62+ 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
69+
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
5880
59− it "open specific version -> close -> open latest" do
60− let name = "db-latest"
81+ it "open specific version -> close -> open latest" do
82+ let
83+ name = "db-latest"
6184 version = 14
62− db <- IDBFactory.open name (Just version)
63− { onUpgradeNeeded : Nothing
64− , onBlocked : Nothing
65− }
66− IDBDatabase.name db `shouldEqual` name
67− liftEff $ IDBDatabase.close db
68− db <- IDBFactory.open name Nothing
69− { onUpgradeNeeded : Nothing
70− , onBlocked : Nothing
71− }
72− tearDown name version db
73−
74−
75− it "open + onUpgradeNeed" do
76− let name = "db-upgrade-needed"
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
96+
97+ it "open + onUpgradeNeed" do
98+ let
99+ name = "db-upgrade-needed"
77100 version = 1
78− callback var db = do
79− _ <- launchAff $ modifyVar (const $ IDBDatabase.name db) var
101+ callback (Tuple varName varVersion) db _ { oldVersion } = do
102+ _ <- launchAff $ modifyAVar (const $ IDBDatabase.name db) varName
103+ _ <- launchAff $ modifyAVar (const $ oldVersion) varVersion
80104 pure unit
81− var <- makeVar' "-"
82− db <- IDBFactory.open name Nothing
83− { onUpgradeNeeded : Just (callback var)
84− , onBlocked : Nothing
85− }
86− name <- peekVar var
87− name `shouldEqual` name
88− tearDown name version db
89−
90−
91− it "open + onBlocked" do
92− let name = "db-blocked"
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"
93120 version = 14
94121 callback var = do
95− _ <- launchAff $ modifyVar (const $ "db-blocked") var
122+ _ <- launchAff $ modifyAVar (const $ "db-blocked") var
96123 pure unit
97124
98− var <- makeVar' "-"
99− db01 <- IDBFactory.open name Nothing
100− { onUpgradeNeeded : Nothing
101− , onBlocked : Nothing
102− }
103− _ <- forkAff do
104− delay (Milliseconds 100.0)
105− liftEff $ IDBDatabase.close db01
106−
107− db02 <- IDBFactory.open name (Just version)
108− { onUpgradeNeeded : Nothing
109− , onBlocked : Just (callback var)
110− }
111− name <- peekVar var
112− name `shouldEqual` name
113− tearDown name version db02
114−
115− describe "IDBKeyRange" do
116− it "only(int)" do
117− let key = 14
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
133+
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
118146 range = IDBKeyRange.only key
119− IDBKeyRange.includes range (toKey key) `shouldEqual` true
147+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
120148
121− it "only(string)" do
122− let key = "patate"
149+ it "only(string)" do
150+ let
151+ key = "patate"
123152 range = IDBKeyRange.only key
124− IDBKeyRange.includes range (toKey key) `shouldEqual` true
153+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
125154
126− it "only(float)" do
127− let key = 14.42
155+ it "only(float)" do
156+ let
157+ key = 14.42
128158 range = IDBKeyRange.only key
129− IDBKeyRange.includes range (toKey key) `shouldEqual` true
159+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
130160
131− it "only(date)" do
132− let mkey = DateTime
161+ it "only(date)" do
162+ let
163+ mkey = DateTime
133164 <$> (Date.canonicalDate <$> toEnum 2017 <*> toEnum 6 <*> toEnum 23)
134165 <*> (Time <$> toEnum 17 <*> toEnum 59 <*> toEnum 34 <*> toEnum 42)
135166
136− case mkey of
137− Nothing ->
138− fail "unable to create datetime"
139− Just key -> do
140− let range = IDBKeyRange.only key
141− IDBKeyRange.includes range (toKey key) `shouldEqual` true
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
142173
143− it "only([int])" do
144− let key = [14, 42]
174+ it "only([int])" do
175+ let
176+ key = [ 14, 42 ]
145177 range = IDBKeyRange.only key
146− IDBKeyRange.includes range (toKey key) `shouldEqual` true
178+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
147179
148− it "only([string])" do
149− let key = ["patate", "autruche"]
180+ it "only([string])" do
181+ let
182+ key = [ "patate", "autruche" ]
150183 range = IDBKeyRange.only key
151− IDBKeyRange.includes range (toKey key) `shouldEqual` true
184+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
152185
153− it "lowerBound(14, open)" do
154− let key = 14
155− open = true
186+ it "lowerBound(14, open)" do
187+ let
188+ key = 14
189+ open = true
156190 range = IDBKeyRange.lowerBound key open
157− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
158− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
159− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
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
160194
161− it "lowerBound(14, close)" do
162− let key = 14
163− open = false
195+ it "lowerBound(14, close)" do
196+ let
197+ key = 14
198+ open = false
164199 range = IDBKeyRange.lowerBound key open
165− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
166− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
167− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
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
168203
169− it "upperBound(14, open)" do
170− let key = 14
171− open = true
204+ it "upperBound(14, open)" do
205+ let
206+ key = 14
207+ open = true
172208 range = IDBKeyRange.upperBound key open
173− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
174− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
175− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
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
176212
177− it "upperBound(14, close)" do
178− let key = 14
179− open = false
213+ it "upperBound(14, close)" do
214+ let
215+ key = 14
216+ open = false
180217 range = IDBKeyRange.upperBound key open
181− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
182− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
183− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
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
184221
185− it "bound(42, 14, open, open) => Nothing" do
186− let lower = 42
187− upper = 14
222+ it "bound(42, 14, open, open) => Nothing" do
223+ let
224+ lower = 42
225+ upper = 14
188226 lowerOpen = true
189227 upperOpen = true
190− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
191− isNothing mrange `shouldEqual` true
228+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
229+ isNothing mrange `shouldEqual` true
192230
193− it "bound(14, 42, open, open)" do
194− let lower = 14
195− upper = 42
231+ it "bound(14, 42, open, open)" do
232+ let
233+ lower = 14
234+ upper = 42
196235 lowerOpen = true
197236 upperOpen = true
198− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
199− case mrange of
200− Nothing ->
201− fail "invalid range provided"
202− Just range -> do
203− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
204− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
205− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
206− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
207− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
208− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
209−
210− it "bound(14, 42, open, close)" do
211− let lower = 14
212− upper = 42
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
213253 lowerOpen = true
214254 upperOpen = false
215− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
216− case mrange of
217− Nothing ->
218− fail "invalid range provided"
219− Just range -> do
220− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
221− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
222− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
223− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
224− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
225− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
226−
227− it "bound(14, 42, close, open)" do
228− let lower = 14
229− upper = 42
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
230271 lowerOpen = false
231272 upperOpen = true
232− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
233− case mrange of
234− Nothing ->
235− fail "invalid range provided"
236− Just range -> do
237− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
238− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
239− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
240− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
241− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
242− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
243−
244− it "bound(14, 42, close, close)" do
245− let lower = 14
246− upper = 42
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
247289 lowerOpen = false
248290 upperOpen = false
249− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
250− case mrange of
251− Nothing ->
252− fail "invalid range provided"
253− Just range -> do
254− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
255− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
256− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
257− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
258− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
259− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
260−
261− it "can access attributes of a range" do
262− let range = IDBKeyRange.lowerBound 14 true
263− IDBKeyRange.lower range `shouldEqual` (Just $ toKey 14)
264− IDBKeyRange.upper range `shouldEqual` (Nothing :: Maybe Key)
265− IDBKeyRange.lowerOpen range `shouldEqual` true
266− -- NOTE Not true on Chrome 56.x => The default value for the flag is `true`
267− -- IDBKeyRange.upperOpen range `shouldEqual` false
268−
269− describe "IDBDatabase" do
270− it "createObjectStore (keyPath: [], autoIncrement: true)" do
271− let dbName = "db-create-store-01"
272− dbVersion = 1
273− storeName = "store"
274− keyPath = []
275− autoIncrement = true
276− callback var db = do
277− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
278− _ <- launchAff $ IDBObjectStore.name store `shouldEqual` storeName
279− _ <- launchAff $ IDBObjectStore.keyPath store `shouldEqual` keyPath
280− _ <- launchAff $ IDBObjectStore.autoIncrement store `shouldEqual` autoIncrement
281− _ <- launchAff $ IDBObjectStore.indexNames store `shouldEqual` []
282− _ <- launchAff $ modifyVar (const true) var
283− pure unit
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)
284302
285− var <- makeVar' false
286− db <- IDBFactory.open dbName Nothing
287− { onUpgradeNeeded : Just (callback var)
288− , onBlocked : Nothing
289− }
290− hasBeenCalled <- peekVar var
291− hasBeenCalled `shouldEqual` true
292− tearDown dbName dbVersion db
293−
294−
295− it "createObjectStore (keyPath: [\"field\"], autoIncrement: true)" do
296− let dbName = "db-create-store-02"
297− dbVersion = 1
298− storeName = "store"
299− keyPath = ["field"]
300− autoIncrement = true
301− callback var db = do
302− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
303− _ <- launchAff $ IDBObjectStore.name store `shouldEqual` storeName
304− _ <- launchAff $ IDBObjectStore.keyPath store `shouldEqual` keyPath
305− _ <- launchAff $ IDBObjectStore.autoIncrement store `shouldEqual` autoIncrement
306− _ <- launchAff $ IDBObjectStore.indexNames store `shouldEqual` []
307− _ <- launchAff $ modifyVar (const true) var
308− pure unit
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
309309
310− var <- makeVar' false
311− db <- IDBFactory.open dbName Nothing
312− { onUpgradeNeeded : Just (callback var)
313− , onBlocked : Nothing
314− }
315− hasBeenCalled <- peekVar var
316− hasBeenCalled `shouldEqual` true
317− tearDown dbName dbVersion db
318−
319−
320− it "createObjectStore (keyPath: [\"a\", \"b\"], autoIncrement: false)" do
321− let dbName = "db-create-store-03"
322− dbVersion = 1
323− storeName = "store"
324− keyPath = ["a", "b"]
325− autoIncrement = false
326− callback var db = do
327− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
328− _ <- launchAff $ IDBObjectStore.name store `shouldEqual` storeName
329− _ <- launchAff $ IDBObjectStore.keyPath store `shouldEqual` keyPath
330− _ <- launchAff $ IDBObjectStore.autoIncrement store `shouldEqual` autoIncrement
331− _ <- launchAff $ IDBObjectStore.indexNames store `shouldEqual` []
332− _ <- launchAff $ modifyVar (const true) var
333− pure unit
310+ describe "IDBDatabase" do
311+ let
312+ tearDown db = do
313+ IDBDatabase.close db
314+ _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
315+ pure unit
334316
335− var <- makeVar' false
336− db <- IDBFactory.open dbName Nothing
337− { onUpgradeNeeded : Just (callback var)
338− , onBlocked : Nothing
339− }
340− hasBeenCalled <- peekVar var
341− hasBeenCalled `shouldEqual` true
342− tearDown dbName dbVersion db
343−
344−
345− it "createObjectStore (keyPath: [\"field\"], autoIncrement: false)" do
346− let dbName = "db-create-store-04"
347− dbVersion = 1
348− storeName = "store"
349− keyPath = ["field"]
350− autoIncrement = false
351− callback var db = do
352− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
353− _ <- launchAff $ IDBObjectStore.name store `shouldEqual` storeName
354− _ <- launchAff $ IDBObjectStore.keyPath store `shouldEqual` keyPath
355− _ <- launchAff $ IDBObjectStore.autoIncrement store `shouldEqual` autoIncrement
356− _ <- launchAff $ IDBObjectStore.indexNames store `shouldEqual` []
357− _ <- launchAff $ modifyVar (const true) var
358− pure unit
317+ 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
359323
360− var <- makeVar' false
361− db <- IDBFactory.open dbName Nothing
362− { onUpgradeNeeded : Just (callback var)
363− , onBlocked : Nothing
364− }
365− hasBeenCalled <- peekVar var
366− hasBeenCalled `shouldEqual` true
367− tearDown dbName dbVersion db
368−
369−
370− it "deleteObjectStore" do
371− let dbName = "db-delete-store"
372− dbVersion = 2
373− storeName = "store"
374− keyPath = []
375− autoIncrement = true
376− callback db = do
377− _ <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
378− pure unit
379− callback2 var db = do
380− _ <- IDBDatabase.deleteObjectStore db storeName
381− _ <- launchAff $ modifyVar (const true) var
382− pure unit
324+ var <- AVar.empty
325+ _ <- IDBFactory.open "db" Nothing
326+ { onUpgradeNeeded: Just (onUpgradeNeeded var)
327+ , onBlocked: Nothing
328+ }
383329
384− var <- makeVar' false
385− db <- IDBFactory.open dbName Nothing
386− { onUpgradeNeeded : Just callback
387− , onBlocked : Nothing
388− }
389− liftEff $ IDBDatabase.close db
390− db <- IDBFactory.open dbName (Just dbVersion)
391− { onUpgradeNeeded : Just (callback2 var)
392− , onBlocked : Nothing
393− }
394− hasBeenCalled <- peekVar var
395− hasBeenCalled `shouldEqual` true
396− tearDown dbName dbVersion db
397−
398− describe "IDBObjectStore" do
399− it "add(\"patate\", Nothing )" do
400− let dbName = "db-add"
401− dbVersion = 1
402− storeName = "store"
403− keyPath = []
404− autoIncrement = true
405− key = 1
406− callback db = do
407− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
408− key <- launchAff $ ((unsafeFromKey >>> shouldEqual key)
409− <$> IDBObjectStore.add store "patate" Nothing)
410− pure unit
330+ AVar.take var
411331
412− db <- IDBFactory.open dbName Nothing
413− { onUpgradeNeeded : Just callback
414− , onBlocked : Nothing
415− }
416− tearDown dbName dbVersion db
417−
418− it "add(\"patate\", Just 14 )" do
419− let dbName = "db-add"
420− dbVersion = 1
421− storeName = "store"
422− keyPath = []
423− autoIncrement = true
424− key = 14
425− callback db = do
426− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
427− key <- launchAff $ ((unsafeFromKey >>> shouldEqual key)
428− <$> IDBObjectStore.add store "patate" (Just $ toKey key))
429− pure unit
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
430339
431− db <- IDBFactory.open dbName Nothing
432− { onUpgradeNeeded : Just callback
433− , onBlocked : Nothing
434− }
435− tearDown dbName dbVersion db
436−
437− it "add(\"patate\", Just \"key\" )" do
438− let dbName = "db-add"
439− dbVersion = 1
440− storeName = "store"
441− keyPath = []
442− autoIncrement = true
443− key = "key"
444− callback db = do
445− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
446− key <- launchAff $ ((unsafeFromKey >>> shouldEqual key)
447− <$> IDBObjectStore.add store "patate" (Just $ toKey key))
448− pure unit
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
449347
450− db <- IDBFactory.open dbName Nothing
451− { onUpgradeNeeded : Just callback
452− , onBlocked : Nothing
453− }
454− tearDown dbName dbVersion db
455−
456− it "add(\"patate\", Just <date> )" do
457− let dbName = "db-add"
458− dbVersion = 1
459− storeName = "store"
460− keyPath = []
461− autoIncrement = true
462− mkey = DateTime
463− <$> (Date.canonicalDate <$> toEnum 2017 <*> toEnum 6 <*> toEnum 23)
464− <*> (Time <$> toEnum 17 <*> toEnum 59 <*> toEnum 34 <*> toEnum 42)
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
359+ _ <- IDBDatabase.deleteObjectStore db "store"
360+ AVar.put true var
465361
466− case mkey of
467− Nothing ->
468− fail "unable to create datetime"
469− Just key -> do
470− let callback db = do
471− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
472− key <- launchAff $ ((unsafeFromKey >>> shouldEqual key)
473− <$> IDBObjectStore.add store "patate" (Just $ toKey key))
474− pure unit
475−
476− db <- IDBFactory.open dbName Nothing
477− { onUpgradeNeeded : Just callback
478− , onBlocked : Nothing
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'
372+
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
479391 }
480− tearDown dbName dbVersion db
481−
482− it "add(\"patate\", Just [14, 42] )" do
483− let dbName = "db-add"
484− dbVersion = 1
485− storeName = "store"
486− keyPath = []
487− autoIncrement = true
488− key = [14, 42]
489− callback db = do
490− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
491− key <- launchAff $ ((unsafeFromKey >>> shouldEqual key)
492− <$> IDBObjectStore.add store "patate" (Just $ toKey key))
493− pure unit
494392
495− db <- IDBFactory.open dbName Nothing
496− { onUpgradeNeeded : Just callback
497− , onBlocked : Nothing
498− }
499− tearDown dbName dbVersion db
500−
501− it "clear()" do
502− let dbName = "db-clear"
503− dbVersion = 1
504− storeName = "store"
505− keyPath = []
506− autoIncrement = true
507− callback db = do
508− store <- IDBDatabase.createObjectStore db storeName { keyPath, autoIncrement }
509− _ <- launchAff $ do
510− _ <- IDBObjectStore.add store "patate" (Just $ toKey 14)
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''
411+
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)
511431 _ <- IDBObjectStore.clear store
512− v <- IDBObjectStore.get store (IDBKeyRange.only 14)
513− v `shouldEqual` (Nothing :: Maybe Int)
432+ val <- IDBObjectStore.get store (IDBKeyRange.only key)
433+ val `shouldEqual` (Nothing :: Maybe String)
434+ }
435+ tearDown db
514436
515− pure unit
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
524+
525+ describe "IDBIndex" do
526+ let
527+ tearDown db = do
528+ IDBDatabase.close db
529+ _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
530+ pure unit
531+
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
808+ }
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+ }
843+
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
887+
888+ describe "IDBCursor" do
889+ let
890+ tearDown db = do
891+ IDBDatabase.close db
892+ _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
893+ pure unit
516894
517− db <- IDBFactory.open dbName Nothing
518− { onUpgradeNeeded : Just callback
519− , onBlocked : Nothing
520− }
521− tearDown dbName dbVersion db
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 }
904+ 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"
990+ }
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
5221141