-
-
Notifications
You must be signed in to change notification settings - Fork 191
/
IDBTransaction.js
569 lines (527 loc) · 21.4 KB
/
IDBTransaction.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
import {createEvent} from './Event';
import {logError, findError, webSQLErrback, createDOMException} from './DOMException';
import {IDBRequest} from './IDBRequest';
import * as util from './util';
import IDBObjectStore from './IDBObjectStore';
import CFG from './CFG';
import {EventTargetFactory} from 'eventtarget';
import SyncPromise from 'sync-promise';
let uniqueID = 0;
const listeners = ['onabort', 'oncomplete', 'onerror'];
const readonlyProperties = ['objectStoreNames', 'mode', 'db', 'error'];
/**
* The IndexedDB Transaction
* http://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBTransaction
* @param {IDBDatabase} db
* @param {string[]} storeNames
* @param {string} mode
* @constructor
*/
function IDBTransaction () {
throw new TypeError('Illegal constructor');
}
const IDBTransactionAlias = IDBTransaction;
IDBTransaction.__createInstance = function (db, storeNames, mode) {
function IDBTransaction () {
const me = this;
me[Symbol.toStringTag] = 'IDBTransaction';
util.defineReadonlyProperties(me, readonlyProperties);
me.__id = ++uniqueID; // for debugging simultaneous transactions
me.__active = true;
me.__running = false;
me.__errored = false;
me.__requests = [];
me.__objectStoreNames = storeNames;
me.__mode = mode;
me.__db = db;
me.__error = null;
me.__setOptions({
legacyOutputDidListenersThrowFlag: true // Event hook for IndexedB
});
readonlyProperties.forEach((readonlyProp) => {
Object.defineProperty(this, readonlyProp, {
configurable: true
});
});
listeners.forEach((listener) => {
Object.defineProperty(this, listener, {
enumerable: true,
configurable: true,
get: function () {
return this['__' + listener];
},
set: function (val) {
this['__' + listener] = val;
}
});
});
listeners.forEach((l) => {
this[l] = null;
});
me.__storeHandles = {};
// Kick off the transaction as soon as all synchronous code is done
setTimeout(() => { me.__executeRequests(); }, 0);
}
IDBTransaction.prototype = IDBTransactionAlias.prototype;
return new IDBTransaction();
};
IDBTransaction.prototype = EventTargetFactory.createInstance({defaultSync: true, extraProperties: ['complete']}); // Ensure EventTarget preserves our properties
IDBTransaction.prototype.__transFinishedCb = function (err, cb) {
if (err) {
cb(true); // eslint-disable-line standard/no-callback-literal
return;
}
cb();
};
IDBTransaction.prototype.__executeRequests = function () {
const me = this;
if (me.__running) {
CFG.DEBUG && console.log('Looks like the request set is already running', me.mode);
return;
}
me.__running = true;
me.db.__db[me.mode === 'readonly' ? 'readTransaction' : 'transaction']( // `readTransaction` is optimized, at least in `node-websql`
function executeRequests (tx) {
me.__tx = tx;
let q = null, i = -1;
function success (result, req) {
if (me.__errored || me.__requestsFinished) {
// We've already called "onerror", "onabort", or thrown within the transaction, so don't do it again.
return;
}
if (req) {
q.req = req; // Need to do this in case of cursors
}
if (q.req.__readyState === 'done') { // Avoid continuing with aborted requests
return;
}
q.req.__readyState = 'done';
q.req.__result = result;
q.req.__error = null;
me.__active = true;
const e = createEvent('success');
q.req.dispatchEvent(e);
// Do not set __active flag to false yet: https://github.com/w3c/IndexedDB/issues/87
if (e.__legacyOutputDidListenersThrowError) {
logError('Error', 'An error occurred in a success handler attached to request chain', e.__legacyOutputDidListenersThrowError); // We do nothing else with this error as per spec
me.__abortTransaction(createDOMException('AbortError', 'A request was aborted (in user handler after success).'));
return;
}
executeNextRequest();
}
function error (...args /* tx, err */) {
if (me.__errored || me.__requestsFinished) {
// We've already called "onerror", "onabort", or thrown within the transaction, so don't do it again.
return;
}
if (q.req && q.req.__readyState === 'done') { // Avoid continuing with aborted requests
return;
}
const err = findError(args);
if (!q.req) {
me.__abortTransaction(err);
return;
}
// Fire an error event for the current IDBRequest
q.req.__readyState = 'done';
q.req.__error = err;
q.req.__result = undefined; // Must be undefined if an error per `result` getter
q.req.addLateEventListener('error', function (e) {
if (e.cancelable && e.defaultPrevented && !e.__legacyOutputDidListenersThrowError) {
executeNextRequest();
}
});
q.req.addDefaultEventListener('error', function () {
me.__abortTransaction(q.req.__error);
});
me.__active = true;
const e = createEvent('error', err, {bubbles: true, cancelable: true});
q.req.dispatchEvent(e);
// Do not set __active flag to false yet: https://github.com/w3c/IndexedDB/issues/87
if (e.__legacyOutputDidListenersThrowError) {
logError('Error', 'An error occurred in an error handler attached to request chain', e.__legacyOutputDidListenersThrowError); // We do nothing else with this error as per spec
e.preventDefault(); // Prevent 'error' default as steps indicate we should abort with `AbortError` even without cancellation
me.__abortTransaction(createDOMException('AbortError', 'A request was aborted (in user handler after error).'));
}
}
function executeNextRequest () {
if (me.__errored || me.__requestsFinished) {
// We've already called "onerror", "onabort", or thrown within the transaction, so don't do it again.
return;
}
i++;
if (i >= me.__requests.length) {
// All requests in the transaction are done
me.__requests = [];
if (me.__active) {
requestsFinished();
}
} else {
try {
q = me.__requests[i];
if (!q.req) {
q.op(tx, q.args, executeNextRequest, error);
return;
}
if (q.req.__readyState === 'done') { // Avoid continuing with aborted requests
return;
}
q.op(tx, q.args, success, error, executeNextRequest);
} catch (e) {
error(e);
}
}
}
executeNextRequest();
},
function webSQLError (webSQLErr) {
if (webSQLErr === true) { // Not a genuine SQL error
return;
}
const err = webSQLErrback(webSQLErr);
me.__abortTransaction(err);
},
function () {
// For Node, we don't need to try running here as we can keep
// the transaction running long enough to rollback (in the
// next (non-standard) callback for this transaction call)
if (me.__transFinishedCb !== IDBTransaction.prototype.__transFinishedCb) { // Node
return;
}
if (!me.__transactionEndCallback && !me.__requestsFinished) {
me.__transactionFinished = true;
return;
}
if (me.__transactionEndCallback && !me.__completed) {
me.__transFinishedCb(me.__errored, me.__transactionEndCallback);
}
},
function (currentTask, err, done, rollback, commit) {
if (currentTask.readOnly || err) {
return true;
}
me.__transFinishedCb = function (err, cb) {
if (err) {
rollback(err, cb);
} else {
commit(cb);
}
};
if (me.__transactionEndCallback && !me.__completed) {
me.__transFinishedCb(me.__errored, me.__transactionEndCallback);
}
return false;
}
);
function requestsFinished () {
me.__active = false;
me.__requestsFinished = true;
function complete () {
me.__completed = true;
CFG.DEBUG && console.log('Transaction completed');
const evt = createEvent('complete');
try {
me.__internal = true;
me.dispatchEvent(evt);
me.__internal = false;
me.dispatchEvent(createEvent('__complete'));
} catch (e) {
me.__internal = false;
// An error occurred in the "oncomplete" handler.
// It's too late to call "onerror" or "onabort". Throw a global error instead.
// (this may seem odd/bad, but it's how all native IndexedDB implementations work)
me.__errored = true;
throw e;
} finally {
me.__storeHandles = {};
}
}
if (me.mode === 'readwrite') {
if (me.__transactionFinished) {
complete();
return;
}
me.__transactionEndCallback = complete;
return;
}
if (me.mode === 'readonly') {
complete();
return;
}
const ev = createEvent('__beforecomplete');
ev.complete = complete;
me.dispatchEvent(ev);
}
};
/**
* Creates a new IDBRequest for the transaction.
* NOTE: The transaction is not queued until you call {@link IDBTransaction#__pushToQueue}
* @returns {IDBRequest}
* @protected
*/
IDBTransaction.prototype.__createRequest = function (source) {
const me = this;
const request = IDBRequest.__createInstance();
request.__source = source !== undefined ? source : me.db;
request.__transaction = me;
return request;
};
/**
* Adds a callback function to the transaction queue
* @param {function} callback
* @param {*} args
* @returns {IDBRequest}
* @protected
*/
IDBTransaction.prototype.__addToTransactionQueue = function (callback, args, source) {
const request = this.__createRequest(source);
this.__pushToQueue(request, callback, args);
return request;
};
/**
* Adds a callback function to the transaction queue without generating a request
* @param {function} callback
* @param {*} args
* @returns {IDBRequest}
* @protected
*/
IDBTransaction.prototype.__addNonRequestToTransactionQueue = function (callback, args, source) {
this.__pushToQueue(null, callback, args);
};
/**
* Adds an IDBRequest to the transaction queue
* @param {IDBRequest} request
* @param {function} callback
* @param {*} args
* @protected
*/
IDBTransaction.prototype.__pushToQueue = function (request, callback, args) {
this.__assertActive();
this.__requests.push({
'op': callback,
'args': args,
'req': request
});
};
IDBTransaction.prototype.__assertActive = function () {
if (!this.__active) {
throw createDOMException('TransactionInactiveError', 'A request was placed against a transaction which is currently not active, or which is finished');
}
};
IDBTransaction.prototype.__assertWritable = function () {
if (this.mode === 'readonly') {
throw createDOMException('ReadOnlyError', 'The transaction is read only');
}
};
IDBTransaction.prototype.__assertVersionChange = function () {
IDBTransaction.__assertVersionChange(this);
};
/**
* Returns the specified object store.
* @param {string} objectStoreName
* @returns {IDBObjectStore}
*/
IDBTransaction.prototype.objectStore = function (objectStoreName) {
const me = this;
if (!(me instanceof IDBTransaction)) {
throw new TypeError('Illegal invocation');
}
if (arguments.length === 0) {
throw new TypeError('No object store name was specified');
}
IDBTransaction.__assertNotFinished(me);
if (me.__objectStoreNames.indexOf(objectStoreName) === -1) {
throw createDOMException('NotFoundError', objectStoreName + ' is not participating in this transaction');
}
const store = me.db.__objectStores[objectStoreName];
if (!store) {
throw createDOMException('NotFoundError', objectStoreName + ' does not exist in ' + me.db.name);
}
if (!me.__storeHandles[objectStoreName] ||
// These latter conditions are to allow store
// recreation to create new clone object
me.__storeHandles[objectStoreName].__pendingDelete ||
me.__storeHandles[objectStoreName].__deleted) {
me.__storeHandles[objectStoreName] = IDBObjectStore.__clone(store, me);
}
return me.__storeHandles[objectStoreName];
};
IDBTransaction.prototype.__abortTransaction = function (err) {
const me = this;
logError('Error', 'An error occurred in a transaction', err);
if (me.__errored) {
// We've already called "onerror", "onabort", or thrown, so don't do it again.
return;
}
me.__errored = true;
if (me.mode === 'versionchange') { // Steps for aborting an upgrade transaction
me.db.__version = me.db.__oldVersion;
me.db.__objectStoreNames = me.db.__oldObjectStoreNames;
me.__objectStoreNames = me.db.__oldObjectStoreNames;
Object.values(me.db.__objectStores).concat(Object.values(me.__storeHandles)).forEach(function (store) {
if ('__pendingName' in store && me.db.__oldObjectStoreNames.indexOf(store.__pendingName) > -1) { // Store was already created so we restore to name before the rename
store.__name = store.__originalName;
}
store.__indexNames = store.__oldIndexNames;
delete store.__pendingDelete;
Object.values(store.__indexes).concat(Object.values(store.__indexHandles)).forEach(function (index) {
if ('__pendingName' in index && store.__oldIndexNames.indexOf(index.__pendingName) > -1) { // Index was already created so we restore to name before the rename
index.__name = index.__originalName;
}
delete index.__pendingDelete;
});
});
}
me.__active = false; // Setting here and in requestsFinished for https://github.com/w3c/IndexedDB/issues/87
if (err !== null) {
me.__error = err;
}
if (me.__requestsFinished) {
// The transaction has already completed, so we can't call "onerror" or "onabort".
// So throw the error instead.
setTimeout(() => {
throw err;
}, 0);
}
function abort (tx, errOrResult) {
if (!tx) {
CFG.DEBUG && console.log('Rollback not possible due to missing transaction', me);
} else if (errOrResult && typeof errOrResult.code === 'number') {
CFG.DEBUG && console.log('Rollback erred; feature is probably not supported as per WebSQL', me);
} else {
CFG.DEBUG && console.log('Rollback succeeded', me);
}
me.dispatchEvent(createEvent('__preabort'));
me.__requests.filter(function (q, i, arr) {
return q.req && q.req.__readyState !== 'done' && [i, -1].includes(
arr.map((q) => q.req).lastIndexOf(q.req)
);
}).reduce(function (promises, q) {
// We reduce to a chain of promises to be queued in order, so we cannot use `Promise.all`,
// and I'm unsure whether `setTimeout` currently behaves first-in-first-out with the same timeout
// so we could just use a `forEach`.
return promises.then(function () {
q.req.__readyState = 'done';
q.req.__result = undefined;
q.req.__error = createDOMException('AbortError', 'A request was aborted (an unfinished request).');
const reqEvt = createEvent('error', q.req.__error, {bubbles: true, cancelable: true});
return new SyncPromise(function (resolve) {
setTimeout(() => {
q.req.dispatchEvent(reqEvt); // No need to catch errors
resolve();
});
});
});
}, SyncPromise.resolve()).then(function () { // Also works when there are no pending requests
const evt = createEvent('abort', err, {bubbles: true, cancelable: false});
setTimeout(() => {
me.__abortFinished = true;
me.dispatchEvent(evt);
me.__storeHandles = {};
me.dispatchEvent(createEvent('__abort'));
});
});
}
me.__transFinishedCb(true, function (rollback) {
if (rollback && me.__tx) { // Not supported in standard SQL (and WebSQL errors should
// rollback automatically), but for Node.js, etc., we give chance for
// manual aborts which would otherwise not work.
if (me.mode === 'readwrite') {
if (me.__transactionFinished) {
abort();
return;
}
me.__transactionEndCallback = abort;
return;
}
try {
me.__tx.executeSql('ROLLBACK', [], abort, abort); // Not working in some circumstances, even in Node
} catch (err) {
// Browser errs when transaction has ended and since it most likely already erred here,
// we call to abort
abort();
}
} else {
abort(null, {code: 0});
}
});
};
IDBTransaction.prototype.abort = function () {
const me = this;
if (!(me instanceof IDBTransaction)) {
throw new TypeError('Illegal invocation');
}
CFG.DEBUG && console.log('The transaction was aborted', me);
IDBTransaction.__assertNotFinished(me);
me.__abortTransaction(null);
};
IDBTransaction.prototype[Symbol.toStringTag] = 'IDBTransactionPrototype';
IDBTransaction.__assertVersionChange = function (tx) {
if (!tx || tx.mode !== 'versionchange') {
throw createDOMException('InvalidStateError', 'Not a version transaction');
}
};
IDBTransaction.__assertNotVersionChange = function (tx) {
if (tx && tx.mode === 'versionchange') {
throw createDOMException('InvalidStateError', 'Cannot be called during a version transaction');
}
};
IDBTransaction.__assertNotFinished = function (tx) {
if (!tx || tx.__completed || tx.__abortFinished || tx.__errored) {
throw createDOMException('InvalidStateError', 'Transaction finished by commit or abort');
}
};
// object store methods behave differently: see https://github.com/w3c/IndexedDB/issues/192
IDBTransaction.__assertNotFinishedObjectStoreMethod = function (tx) {
try {
IDBTransaction.__assertNotFinished(tx);
} catch (err) {
if (tx && !tx.__completed && !tx.__abortFinished) {
throw createDOMException('TransactionInactiveError', 'A request was placed against a transaction which is currently not active, or which is finished');
}
throw err;
}
};
IDBTransaction.__assertActive = function (tx) {
if (!tx || !tx.__active) {
throw createDOMException('TransactionInactiveError', 'A request was placed against a transaction which is currently not active, or which is finished');
}
};
/**
* Used by our EventTarget.prototype library to implement bubbling/capturing
*/
IDBTransaction.prototype.__getParent = function () {
return this.db;
};
listeners.forEach((listener) => {
Object.defineProperty(IDBTransaction.prototype, listener, {
enumerable: true,
configurable: true,
get: function () {
throw new TypeError('Illegal invocation');
},
set: function (val) {
throw new TypeError('Illegal invocation');
}
});
});
// Illegal invocations
readonlyProperties.forEach((prop) => {
Object.defineProperty(IDBTransaction.prototype, prop, {
enumerable: true,
configurable: true,
get: function () {
throw new TypeError('Illegal invocation');
}
});
});
Object.defineProperty(IDBTransaction.prototype, 'constructor', {
enumerable: false,
writable: true,
configurable: true,
value: IDBTransaction
});
Object.defineProperty(IDBTransaction, 'prototype', {
writable: false
});
export default IDBTransaction;