From 41864d46c314942a6e1fb82b82f69636a29fa763 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Thu, 1 Jun 2017 13:04:04 +0100
Subject: [PATCH] Load Olm from the global rather than requiring it.

This means that we can avoid confusing everybody in the world about how to
webpack js-sdk apps.
---
 README.md               | 18 ++++++++++++++++++
 package.json            |  9 +--------
 src/client.js           |  3 +--
 src/crypto/OlmDevice.js |  6 ++----
 4 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index c51ca5b2d..5c549062b 100644
--- a/README.md
+++ b/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
diff --git a/package.json b/package.json
index 1da4594c7..5f22c3843 100644
--- a/package.json
+++ b/package.json
@@ -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"
   }
 }
diff --git a/src/client.js b/src/client.js
index 064e19e79..f7beb7b0c 100644
--- a/src/client.js
+++ b/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);
 }
 
 /**
diff --git a/src/crypto/OlmDevice.js b/src/crypto/OlmDevice.js
index cbeace6e8..760d3ccb8 100644
--- a/src/crypto/OlmDevice.js
+++ b/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");