History

Improve IndexedDB versioning and recover from version mismatch

Thibaut Courouble committed 9 years ago

Commit 684355c1 parent d63aadb3 files · +58 −28Browse files

Unified · Split

3 files
  1. assets/javascripts/app/app.coffee +0 −1
  2. assets/javascripts/app/db.coffee +55 −27
  3. assets/javascripts/templates/error_tmpl.coffee +3 −0
assets/javascripts/app/app.coffee+0−1
@@ -201,7 +201,6 @@ · 200 unmodified lines
201201 return if @quotaExceeded
202202 @quotaExceeded = true
203203 new app.views.Notif 'QuotaExceeded', autoHide: null
204− Raven.captureMessage 'QuotaExceededError', level: 'warning'
205204 return
206205
207206 onCookieBlocked: (key, value, actual) ->
assets/javascripts/app/db.coffee+55−27
@@ -1,9 +1,9 @@
11 class app.DB
22 NAME = 'docs'
3+ VERSION = 15
34
45 constructor: ->
56 @useIndexedDB = @useIndexedDB()
6− @appVersion = @appVersion()
77 @callbacks = []
88
99 db: (fn) ->
@@ -13,7 +13,7 @@ class app.DB · 3 unmodified lines
1313
1414 try
1515 @open = true
16− req = indexedDB.open(NAME, @schemaVersion())
16+ req = indexedDB.open(NAME, VERSION * 1e9 + @userVersion())
1717 req.onsuccess = @onOpenSuccess
1818 req.onerror = @onOpenError
1919 req.onupgradeneeded = @onUpgradeNeeded
@@ -26,21 +26,16 @@ class app.DB · 6 unmodified lines
2626
2727 if db.objectStoreNames.length is 0
2828 try db.close()
29+ @open = false
2930 @fail 'empty'
30− return
31−
32− unless @checkedBuggyIDB
33− @checkedBuggyIDB = true
34− try
35− @idbTransaction(db, stores: $.makeArray(db.objectStoreNames)[0..1], mode: 'readwrite').abort() # https://bugs.webkit.org/show_bug.cgi?id=136937
36− catch error
37− try db.close()
38− @fail 'buggy', error
39− return
40−
41− @runCallbacks(db)
42− @open = false
43− db.close()
31+ else if error = @buggyIDB(db)
32+ try db.close()
33+ @open = false
34+ @fail 'buggy', error
35+ else
36+ @runCallbacks(db)
37+ @open = false
38+ db.close()
4439 return
4540
4641 onOpenError: (event) =>
@@ -48,15 +43,17 @@ class app.DB · 1 unmodified line
4843 @open = false
4944 error = event.target.error
5045
51− if error.name is 'QuotaExceededError'
52− @reset()
53− @db()
54− app.onQuotaExceeded()
55− else
56− @fail 'cant_open', error
46+ switch error.name
47+ when 'QuotaExceededError'
48+ @onQuotaExceededError()
49+ when 'VersionError'
50+ @onVersionError()
51+ else
52+ @fail 'cant_open', error
5753 return
5854
5955 fail: (reason, error) ->
56+ @cachedDocs = null
6057 @useIndexedDB = false
6158 @reason or= reason
6259 @error or= error
@@ -65,6 +62,39 @@ class app.DB · 2 unmodified lines
6562 Raven.captureException error, level: 'warning' if error
6663 return
6764
65+ onQuotaExceededError: ->
66+ @reset()
67+ @db()
68+ app.onQuotaExceeded()
69+ Raven.captureMessage 'QuotaExceededError', level: 'warning'
70+ return
71+
72+ onVersionError: ->
73+ req = indexedDB.open(NAME)
74+ req.onsuccess = (event) =>
75+ @handleVersionMismatch event.target.result.version
76+ req.onerror = (event) ->
77+ event.preventDefault()
78+ @fail 'cant_open', error
79+ return
80+
81+ handleVersionMismatch: (actualVersion) ->
82+ if Math.floor(actualVersion / 1e9) isnt VERSION
83+ @fail 'version'
84+ else
85+ @setUserVersion actualVersion - VERSION * 1e9
86+ @db()
87+ return
88+
89+ buggyIDB: (db) ->
90+ return if @checkedBuggyIDB
91+ @checkedBuggyIDB = true
92+ try
93+ @idbTransaction(db, stores: $.makeArray(db.objectStoreNames)[0..1], mode: 'readwrite').abort() # https://bugs.webkit.org/show_bug.cgi?id=136937
94+ return
95+ catch error
96+ return error
97+
6898 runCallbacks: (db) ->
6999 fn(db) while fn = @callbacks.shift()
70100 return
@@ -340,11 +370,9 @@ class app.DB · 269 unmodified lines
340370 app.settings.set('schema', @userVersion() + 1)
341371 return
342372
343− schemaVersion: ->
344− @appVersion * 10 + @userVersion()
373+ setUserVersion: (version) ->
374+ app.settings.set('schema', version)
375+ return
345376
346377 userVersion: ->
347378 app.settings.get('schema')
348−
349− appVersion: ->
350− if app.config.env is 'production' then app.config.version else Math.floor(Date.now() / 1000)
assets/javascripts/templates/error_tmpl.coffee+3−0
@@ -40,6 +40,9 @@ app.templates.offlineError = (reason, exception) -> · 39 unmodified lines
4040 """ An error occured when trying to open the IndexedDB database:<br>
4141 <code class="_label">#{exception.name}: #{exception.message}</code><br>
4242 This could be because you're browsing in private mode or have disallowed offline storage on the domain. """
43+ when 'version'
44+ """ The IndexedDB database was modified with a newer version of the app.<br>
45+ <a href="#" data-behavior="reload">Reload the page</a> to use offline mode. """
4346 when 'empty'
4447 """ The IndexedDB database appears to be corrupted. Try <a href="#" data-behavior="reset">resetting the app</a>. """
4548

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t