v0.7.10

indexeddb-crypto-store: fix db deletion

CHANGELOG.md

@@ -1,3 +1,17 @@
+Changes in [0.7.10](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.10) (2017-06-02)
+==================================================================================================
+[Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.9...v0.7.10)
+
+ * BREAKING CHANGE: The SDK no longer ``require``s ``olm`` - instead it expects
+   libolm to be provided as an ``Olm`` global. This will only affect
+   applications which use end-to-end encryption. See the
+   [README](README.md#end-to-end-encryption-support) for details.
+
+ * indexeddb-crypto-store: fix db deletion
+   [\#447](https://github.com/matrix-org/matrix-js-sdk/pull/447)
+ * Load Olm from the global rather than requiring it.
+   [\#446](https://github.com/matrix-org/matrix-js-sdk/pull/446)
+
 Changes in [0.7.9](https://github.com/matrix-org/matrix-js-sdk/releases/tag/v0.7.9) (2017-06-01)
 ================================================================================================
 [Full Changelog](https://github.com/matrix-org/matrix-js-sdk/compare/v0.7.8...v0.7.9)

README.md

@@ -236,6 +236,24 @@ host the API reference from the source files like this:
 
 Then visit ``http://localhost:8005`` to see the API docs.
 
+End-to-end encryption support
+=============================
+
+The SDK supports end-to-end encryption via the Olm and Megolm protocols, using
+[libolm](http://matrix.org/git/olm). It is left up to the application to make
+libolm available, via the ``Olm`` global.
+
+To enable support in a browser application:
+
+ * download the transpiled libolm (either via ``npm install olm``, or from
+   https://matrix.org/packages/npm/olm/).
+ * load ``olm.js`` as a ``<script>`` *before* ``browser-matrix.js``.
+ 
+To enable support in a node.js application:
+
+ * ``npm install olm``
+ * ``require('olm');`` *before* ``matrix-js-sdk``.
+
 Contributing
 ============
 *This section is for people who want to modify the SDK. If you just

package.json

@@ -1,6 +1,6 @@
 {
   "name": "matrix-js-sdk",
-  "version": "0.7.9",
+  "version": "0.7.10",
   "description": "Matrix Client-Server SDK for Javascript",
   "main": "index.js",
   "scripts": {
@@ -73,16 +73,9 @@
     "uglify-js": "^2.8.26",
     "watchify": "^3.2.1"
   },
-  "optionalDependencies": {
-    "olm": "https://matrix.org/packages/npm/olm/olm-2.2.1.tgz"
-  },
   "browserify": {
     "transform": [
-      "sourceify",
-      "browserify-shim"
+      "sourceify"
     ]
-  },
-  "browserify-shim": {
-    "olm": "global:Olm"
   }
 }

release.sh

@@ -206,7 +206,9 @@ if [ -n "$signing_id" ]; then
 
     tarfile="$tag.tar.gz"
     gh_project_url=$(git remote get-url origin |
-                            sed -e 's#^git@github.com:#https://github.com/#' -e 's/\.git$//')
+                            sed -e 's#^git@github\.com:#https://github.com/#' \
+                                -e 's#^git\+ssh://git@github\.com/#https://github.com/#' \
+                                -e 's/\.git$//')
     project_name="${gh_project_url##*/}"
     curl -L "${gh_project_url}/archive/${tarfile}" -o "${tarfile}"
 

spec/integ/matrix-client-methods.spec.js

@@ -299,6 +299,10 @@ describe("MatrixClient", function() {
 
 
     describe("downloadKeys", function() {
+        if (!sdk.CRYPTO_ENABLED) {
+            return;
+        }
+
         it("should do an HTTP request and then store the keys", function(done) {
             const ed25519key = "7wG2lzAqbjcyEkOP7O4gU7ItYcn+chKzh5sT/5r2l78";
             // ed25519key = client.getDeviceEd25519Key();

src/client.js

@@ -47,8 +47,7 @@ try {
     var Crypto = require("./crypto");
     CRYPTO_ENABLED = true;
 } catch (e) {
-    console.error("olm load error", e);
-    // Olm not installed.
+    console.warn("Unable to load crypto module: crypto will be disabled: " + e);
 }
 
 /**

src/crypto/OlmDevice.js

@@ -20,11 +20,9 @@ limitations under the License.
  *
  * @module crypto/OlmDevice
  */
-const Olm = require("olm");
+const Olm = global.Olm;
 if (!Olm) {
-    // this happens if we were loaded via browserify and the Olm module was not
-    // loaded.
-    throw new Error("Olm is not defined");
+    throw new Error("global.Olm is not defined");
 }
 const utils = require("../utils");
 

src/crypto/store/indexeddb-crypto-store.js

@@ -55,6 +55,7 @@ export default class IndexedDBCryptoStore {
         }
 
         this._dbPromise = new q.Promise((resolve, reject) => {
+            console.log(`connecting to indexeddb ${this._dbName}`);
             const req = this._indexedDB.open(this._dbName, VERSION);
 
             req.onupgradeneeded = (ev) => {
@@ -83,7 +84,16 @@ export default class IndexedDBCryptoStore {
             };
 
             req.onsuccess = (r) => {
-                resolve(r.target.result);
+                const db = r.target.result;
+
+                // make sure we close the db on `onversionchange` - otherwise
+                // attempts to delete the database will block (and subsequent
+                // attempts to re-create it will also block).
+                db.onversionchange = (ev) => {
+                    db.close();
+                };
+
+                resolve(db);
             };
         });
         return this._dbPromise;
@@ -98,6 +108,13 @@ export default class IndexedDBCryptoStore {
         return new q.Promise((resolve, reject) => {
             console.log(`Removing indexeddb instance: ${this._dbName}`);
             const req = this._indexedDB.deleteDatabase(this._dbName);
+
+            req.onblocked = () => {
+                reject(new Error(
+                    "unable to delete indexeddb because it is open elsewhere",
+                ));
+            };
+
             req.onerror = (ev) => {
                 reject(new Error(
                     "unable to delete indexeddb: " + ev.target.error,

src/webrtc/call.js

@@ -1219,6 +1219,8 @@ const _getScreenSharingConstraints = function(call) {
 };
 
 const _getUserMediaVideoContraints = function(callType) {
+    const isWebkit = !!global.window.navigator.webkitGetUserMedia;
+
     switch (callType) {
         case 'voice':
             return {
@@ -1232,12 +1234,11 @@ const _getUserMediaVideoContraints = function(callType) {
                     deviceId: audioInput ? {exact: audioInput} : undefined,
                 }, video: {
                     deviceId: videoInput ? {exact: videoInput} : undefined,
-                    mandatory: {
-                        minWidth: 640,
-                        maxWidth: 640,
-                        minHeight: 360,
-                        maxHeight: 360,
-                    },
+                    /* We want 640x360.  Chrome will give it only if we ask exactly,
+                       FF refuses entirely if we ask exactly, so have to ask for ideal
+                       instead */
+                    width: isWebkit ? { exact: 640 } : { ideal: 640 },
+                    height: isWebkit ? { exact: 360 } : { ideal: 360 },
                 },
             };
     }