From cfff30c314001c9f2c6ba02b885a896af4a05dbe Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:10:57 +0100 Subject: [PATCH 01/11] Use once to clean up listener --- spec/test-utils.js | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/spec/test-utils.js b/spec/test-utils.js index ab47a85e7..88168130d 100644 --- a/spec/test-utils.js +++ b/spec/test-utils.js @@ -13,9 +13,14 @@ const MatrixEvent = sdk.MatrixEvent; */ module.exports.syncPromise = function(client) { const def = q.defer(); - client.on('sync', (state) => { - if (state == 'SYNCING') def.resolve(); - }); + const cb = (state) => { + if (state == 'SYNCING') { + def.resolve(); + } else { + client.once('sync', cb); + } + }; + client.once('sync', cb); return def.promise; }; From 0715682a8bca58204ea0894b22f1992c14ecc1cb Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:22:07 +0100 Subject: [PATCH 02/11] Name IndexedDBStoreWorker consistently --- src/matrix.js | 4 ++-- ...indexeddb-remote-worker.js => indexeddb-store-worker.js} | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) rename src/store/{indexeddb-remote-worker.js => indexeddb-store-worker.js} (96%) diff --git a/src/matrix.js b/src/matrix.js index 7ad894351..f81fa9918 100644 --- a/src/matrix.js +++ b/src/matrix.js @@ -61,8 +61,8 @@ module.exports.Filter = require("./filter"); module.exports.TimelineWindow = require("./timeline-window").TimelineWindow; /** The {@link module:interactive-auth} class. */ module.exports.InteractiveAuth = require("./interactive-auth"); -/** The {@link module:indexeddb-remote-worker} class. */ -module.exports.IndexedDbStoreWorker = require("./store/indexeddb-remote-worker.js"); +/** The {@link module:indexeddb-store-worker~IndexedDBStoreWorker} class. */ +module.exports.IndexedDBStoreWorker = require("./store/indexeddb-store-worker.js"); /** diff --git a/src/store/indexeddb-remote-worker.js b/src/store/indexeddb-store-worker.js similarity index 96% rename from src/store/indexeddb-remote-worker.js rename to src/store/indexeddb-store-worker.js index d822ba7c9..7f03d5523 100644 --- a/src/store/indexeddb-remote-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -18,10 +18,10 @@ import q from "q"; import LocalIndexedDBStoreBackend from "./indexeddb-local-backend.js"; /** - * This class lives in the webworker and drives a LocalIndexedDbStoreBackend + * This class lives in the webworker and drives a LocalIndexedDBStoreBackend * controlled by messages from the main process. */ -class IndexedDbStoreWorker { +class IndexedDBStoreWorker { constructor(postMessage) { this.backend = null; this.postMessage = postMessage; @@ -101,4 +101,4 @@ class IndexedDbStoreWorker { } } -module.exports = IndexedDbStoreWorker; +module.exports = IndexedDBStoreWorker; From 6e25a17afbfdf7ec856b2d6319f0c7e55daf4176 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:26:52 +0100 Subject: [PATCH 03/11] Typos --- src/store/indexeddb-local-backend.js | 2 +- src/store/indexeddb.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/store/indexeddb-local-backend.js b/src/store/indexeddb-local-backend.js index 5017a4c92..82d081b06 100644 --- a/src/store/indexeddb-local-backend.js +++ b/src/store/indexeddb-local-backend.js @@ -225,7 +225,7 @@ LocalIndexedDBStoreBackend.prototype = { /** * Persist a list of [user id, presence event] they are for. * Users with the same 'userId' will be replaced. - * Prfesence events should be the event in its raw form (not the Event + * Presence events should be the event in its raw form (not the Event * object) * @param {Object[]} tuples An array of [userid, event] tuples * @return {Promise} Resolves if the users were persisted. diff --git a/src/store/indexeddb.js b/src/store/indexeddb.js index 34dcdf719..df8d04e1d 100644 --- a/src/store/indexeddb.js +++ b/src/store/indexeddb.js @@ -67,7 +67,7 @@ const WRITE_DELAY_MS = 1000 * 60 * 5; // once every 5 minutes * window.indexedDB * @param {string=} opts.dbName Optional database name. The same name must be used * to open the same database. - * @param {string=} opts.workerScript Optional URL to a script to invooke a web + * @param {string=} opts.workerScript Optional URL to a script to invoke a web * worker with to run IndexedDB queries on the web worker. The IndexedDbStoreWorker * class is provided for this purpose and requires the application to provide a * trivial wrapper script around it. From 2d7576f29b5eea0cc38a1c223dae6bc1978a320e Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:37:31 +0100 Subject: [PATCH 04/11] Doc usage of the webworker class --- src/store/indexeddb-store-worker.js | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/store/indexeddb-store-worker.js b/src/store/indexeddb-store-worker.js index 7f03d5523..bce4a5676 100644 --- a/src/store/indexeddb-store-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -20,8 +20,23 @@ import LocalIndexedDBStoreBackend from "./indexeddb-local-backend.js"; /** * This class lives in the webworker and drives a LocalIndexedDBStoreBackend * controlled by messages from the main process. + * + * It should be instantiated by a web worker script provided by the application + * in a script, for example: + * + * import IndexedDBStoreWorker from 'matrix-js-sdk/lib/store/indexeddb-store-worker'; + * const remoteWorker = new IndexedDBStoreWorker(postMessage); + * onmessage = remoteWorker.onMessage; + * + * Note that it is advisable to import this class by referencing the file directly to + * avoid a dependency on the whole js-sdk. + * */ class IndexedDBStoreWorker { + /** + * @param {function} postMessage The web worker postMessage function that + * should be used to communicate back to the main script. + */ constructor(postMessage) { this.backend = null; this.postMessage = postMessage; @@ -29,6 +44,10 @@ class IndexedDBStoreWorker { this.onMessage = this.onMessage.bind(this); } + /** + * Passes a message event from the main script into the class. This method + * can be directly assigned to the web worker `onmessage` variable. + */ onMessage(ev) { const msg = ev.data; let prom; From 3ceeee72989c9fd5d11995e5e99162ca33b6318e Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:40:21 +0100 Subject: [PATCH 05/11] Typos --- src/store/indexeddb-store-worker.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/store/indexeddb-store-worker.js b/src/store/indexeddb-store-worker.js index bce4a5676..ee52b57d9 100644 --- a/src/store/indexeddb-store-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -67,7 +67,7 @@ class IndexedDBStoreWorker { case 'clearDatabase': prom = this.backend.clearDatabase().then((result) => { // This returns special classes which can't be cloned - // accross to the main script, so don't try. + // across to the main script, so don't try. return {}; }); break; @@ -98,7 +98,7 @@ class IndexedDBStoreWorker { postMessage({ command: 'cmd_fail', seq: msg.seq, - // Canb't be an Error because they're not structured cloneable + // Can't be an Error because they're not structured cloneable error: "Unrecognised command", }); return; From ab2a67a01282d8e6441d45762513c38d0430ba2b Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:42:18 +0100 Subject: [PATCH 06/11] Don't try to send Error objects --- src/store/indexeddb-store-worker.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/store/indexeddb-store-worker.js b/src/store/indexeddb-store-worker.js index ee52b57d9..0f78ddf62 100644 --- a/src/store/indexeddb-store-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -111,10 +111,13 @@ class IndexedDBStoreWorker { result: ret, }); }, (err) => { + console.error("Error running command: "+msg.command); + console.error(err); this.postMessage.call(null, { command: 'cmd_fail', seq: msg.seq, - error: err, + // Just send a string because Error objects aren't cloneable + error: "Error running command", }); }); } From 62be08f0634624ca02395c666cb8e139b2600dca Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:55:13 +0100 Subject: [PATCH 07/11] Make sure worker setup doesn't race --- src/store/indexeddb-remote-backend.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/store/indexeddb-remote-backend.js b/src/store/indexeddb-remote-backend.js index 89510062f..f5d0f88c7 100644 --- a/src/store/indexeddb-remote-backend.js +++ b/src/store/indexeddb-remote-backend.js @@ -30,6 +30,7 @@ import q from "q"; const RemoteIndexedDBStoreBackend = function RemoteIndexedDBStoreBackend( workerScript, dbName, ) { + this._dbName = dbName; this._worker = new Worker(workerScript); this._nextSeq = 0; // The currently in-flight requests to the actual backend @@ -38,10 +39,6 @@ const RemoteIndexedDBStoreBackend = function RemoteIndexedDBStoreBackend( }; this._worker.onmessage = this._onWorkerMessage.bind(this); - - this._doCmd('_setupWorker', [dbName]).done(() => { - console.log("IndexedDB worker is ready"); - }); }; @@ -52,7 +49,10 @@ RemoteIndexedDBStoreBackend.prototype = { * @return {Promise} Resolves if successfully connected. */ connect: function() { - return this._doCmd('connect'); + return this._doCmd('_setupWorker', [dbName]).then(() => { + console.log("IndexedDB worker is ready"); + return this._doCmd('connect'); + }); }, /** From 2668177210deed105b571d3e3654c93123409e10 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 11:58:16 +0100 Subject: [PATCH 08/11] Oops, moved the variable --- src/store/indexeddb-remote-backend.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/store/indexeddb-remote-backend.js b/src/store/indexeddb-remote-backend.js index f5d0f88c7..f2f211449 100644 --- a/src/store/indexeddb-remote-backend.js +++ b/src/store/indexeddb-remote-backend.js @@ -49,7 +49,7 @@ RemoteIndexedDBStoreBackend.prototype = { * @return {Promise} Resolves if successfully connected. */ connect: function() { - return this._doCmd('_setupWorker', [dbName]).then(() => { + return this._doCmd('_setupWorker', [this._dbName]).then(() => { console.log("IndexedDB worker is ready"); return this._doCmd('connect'); }); From 4c200cdd49cf86119a4a8d5c75f8510a789b0a65 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 14:26:43 +0100 Subject: [PATCH 09/11] lint --- src/store/indexeddb-store-worker.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/store/indexeddb-store-worker.js b/src/store/indexeddb-store-worker.js index 0f78ddf62..333eea0b4 100644 --- a/src/store/indexeddb-store-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -47,6 +47,8 @@ class IndexedDBStoreWorker { /** * Passes a message event from the main script into the class. This method * can be directly assigned to the web worker `onmessage` variable. + * + * @param {Object} ev The message event */ onMessage(ev) { const msg = ev.data; From cf1731792cf6dddc7a9df994ae10ac535eee04c0 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 14:41:12 +0100 Subject: [PATCH 10/11] Add separate import file for indxexeddb worker And removing it from the main one --- src/indexeddb-worker.js | 24 ++++++++++++++++++++++++ src/matrix.js | 2 -- 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 src/indexeddb-worker.js diff --git a/src/indexeddb-worker.js b/src/indexeddb-worker.js new file mode 100644 index 000000000..aa6312e2f --- /dev/null +++ b/src/indexeddb-worker.js @@ -0,0 +1,24 @@ +/* +Copyright 2017 Vector Creations Ltd + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +/** + * Separate exports file for the indexeddb web worker, which is designed + * to be used separately + */ + +/** The {@link module:indexeddb-store-worker~IndexedDBStoreWorker} class. */ +module.exports.IndexedDBStoreWorker = require("./store/indexeddb-store-worker.js"); + diff --git a/src/matrix.js b/src/matrix.js index f81fa9918..ea885b932 100644 --- a/src/matrix.js +++ b/src/matrix.js @@ -61,8 +61,6 @@ module.exports.Filter = require("./filter"); module.exports.TimelineWindow = require("./timeline-window").TimelineWindow; /** The {@link module:interactive-auth} class. */ module.exports.InteractiveAuth = require("./interactive-auth"); -/** The {@link module:indexeddb-store-worker~IndexedDBStoreWorker} class. */ -module.exports.IndexedDBStoreWorker = require("./store/indexeddb-store-worker.js"); /** From 8985dc2f7e5acd576f63bcf3a1f1b9b5b9785c1d Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 7 Apr 2017 14:42:26 +0100 Subject: [PATCH 11/11] Update import in example --- src/store/indexeddb-store-worker.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/store/indexeddb-store-worker.js b/src/store/indexeddb-store-worker.js index 333eea0b4..8cf2ae73c 100644 --- a/src/store/indexeddb-store-worker.js +++ b/src/store/indexeddb-store-worker.js @@ -24,7 +24,7 @@ import LocalIndexedDBStoreBackend from "./indexeddb-local-backend.js"; * It should be instantiated by a web worker script provided by the application * in a script, for example: * - * import IndexedDBStoreWorker from 'matrix-js-sdk/lib/store/indexeddb-store-worker'; + * import {IndexedDBStoreWorker} from 'matrix-js-sdk/lib/indexeddb-worker.js'; * const remoteWorker = new IndexedDBStoreWorker(postMessage); * onmessage = remoteWorker.onMessage; *