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
201 return if @quotaExceeded201 return if @quotaExceeded
202 @quotaExceeded = true202 @quotaExceeded = true
203 new app.views.Notif 'QuotaExceeded', autoHide: null203 new app.views.Notif 'QuotaExceeded', autoHide: null
204 Raven.captureMessage 'QuotaExceededError', level: 'warning'
205 return204 return
206 205
207 onCookieBlocked: (key, value, actual) ->206 onCookieBlocked: (key, value, actual) ->
assets/javascripts/app/db.coffee+55−27
@@ -1,9 +1,9 @@
1class app.DB1class app.DB
2 NAME = 'docs'2 NAME = 'docs'
3 VERSION = 15
3 4
4 constructor: ->5 constructor: ->
5 @useIndexedDB = @useIndexedDB()6 @useIndexedDB = @useIndexedDB()
6 @appVersion = @appVersion()
7 @callbacks = []7 @callbacks = []
8 8
9 db: (fn) ->9 db: (fn) ->
@@ -13,7 +13,7 @@ class app.DB · 3 unmodified lines
13 13
14 try14 try
15 @open = true15 @open = true
16 req = indexedDB.open(NAME, @schemaVersion())16 req = indexedDB.open(NAME, VERSION * 1e9 + @userVersion())
17 req.onsuccess = @onOpenSuccess17 req.onsuccess = @onOpenSuccess
18 req.onerror = @onOpenError18 req.onerror = @onOpenError
19 req.onupgradeneeded = @onUpgradeNeeded19 req.onupgradeneeded = @onUpgradeNeeded
@@ -26,21 +26,16 @@ class app.DB · 6 unmodified lines
26 26
27 if db.objectStoreNames.length is 027 if db.objectStoreNames.length is 0
28 try db.close()28 try db.close()
29 @open = false
29 @fail 'empty'30 @fail 'empty'
30 return31 else if error = @buggyIDB(db)
31 32 try db.close()
32 unless @checkedBuggyIDB33 @open = false
33 @checkedBuggyIDB = true34 @fail 'buggy', error
34 try35 else
35 @idbTransaction(db, stores: $.makeArray(db.objectStoreNames)[0..1], mode: 'readwrite').abort() # https://bugs.webkit.org/show_bug.cgi?id=13693736 @runCallbacks(db)
36 catch error37 @open = false
37 try db.close()38 db.close()
38 @fail 'buggy', error
39 return
40
41 @runCallbacks(db)
42 @open = false
43 db.close()
44 return39 return
45 40
46 onOpenError: (event) =>41 onOpenError: (event) =>
@@ -48,15 +43,17 @@ class app.DB · 1 unmodified line
48 @open = false43 @open = false
49 error = event.target.error44 error = event.target.error
50 45
51 if error.name is 'QuotaExceededError'46 switch error.name
52 @reset()47 when 'QuotaExceededError'
53 @db()48 @onQuotaExceededError()
54 app.onQuotaExceeded()49 when 'VersionError'
55 else50 @onVersionError()
56 @fail 'cant_open', error51 else
52 @fail 'cant_open', error
57 return53 return
58 54
59 fail: (reason, error) ->55 fail: (reason, error) ->
56 @cachedDocs = null
60 @useIndexedDB = false57 @useIndexedDB = false
61 @reason or= reason58 @reason or= reason
62 @error or= error59 @error or= error
@@ -65,6 +62,39 @@ class app.DB · 2 unmodified lines
65 Raven.captureException error, level: 'warning' if error62 Raven.captureException error, level: 'warning' if error
66 return63 return
67 64
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
68 runCallbacks: (db) ->98 runCallbacks: (db) ->
69 fn(db) while fn = @callbacks.shift()99 fn(db) while fn = @callbacks.shift()
70 return100 return
@@ -340,11 +370,9 @@ class app.DB · 269 unmodified lines
340 app.settings.set('schema', @userVersion() + 1)370 app.settings.set('schema', @userVersion() + 1)
341 return371 return
342 372
343 schemaVersion: ->373 setUserVersion: (version) ->
344 @appVersion * 10 + @userVersion()374 app.settings.set('schema', version)
375 return
345 376
346 userVersion: ->377 userVersion: ->
347 app.settings.get('schema')378 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
40 """ An error occured when trying to open the IndexedDB database:<br>40 """ An error occured when trying to open the IndexedDB database:<br>
41 <code class="_label">#{exception.name}: #{exception.message}</code><br>41 <code class="_label">#{exception.name}: #{exception.message}</code><br>
42 This could be because you're browsing in private mode or have disallowed offline storage on the domain. """42 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. """
43 when 'empty'46 when 'empty'
44 """ The IndexedDB database appears to be corrupted. Try <a href="#" data-behavior="reset">resetting the app</a>. """47 """ The IndexedDB database appears to be corrupted. Try <a href="#" data-behavior="reset">resetting the app</a>. """
45 48

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