Merge pull request #3696 from ethereum/wyatt/3689-unsubscribe

Update clearSubscriptions to have return value

Author: spacesailor24

.gitignore

@@ -10,6 +10,7 @@ npm-debug.log
 node_modules
 .idea/
 .npm/
+.history/
 .vscode/
 packages/web3/dist/
 lerna-debug.log

CHANGELOG.md

@@ -282,3 +282,4 @@ Released with 1.0.0-beta.37 code base.
 ### Fixed
 
 - Fix parsing of non-`eth_subscription` provider events (#3660)
+- Fix return value for `clearSubscriptions` (#3689)

packages/web3-core-requestmanager/src/index.js

@@ -257,21 +257,29 @@ RequestManager.prototype.removeSubscription = function (id, callback) {
  * Should be called to reset the subscriptions
  *
  * @method reset
+ * 
+ * @returns {boolean}
  */
 RequestManager.prototype.clearSubscriptions = function (keepIsSyncing) {
-    var _this = this;
+    try {
+        var _this = this;
+
+        // uninstall all subscriptions
+        if (this.subscriptions.size > 0) {
+            this.subscriptions.forEach(function (value, id) {
+                if (!keepIsSyncing || value.name !== 'syncing')
+                    _this.removeSubscription(id);
+            });
+        }
 
-    // uninstall all subscriptions
-    if (this.subscriptions.size > 0) {
-        this.subscriptions.forEach(function (value, id) {
-            if (!keepIsSyncing || value.name !== 'syncing')
-                _this.removeSubscription(id);
-        });
-    }
+        //  reset notification callbacks etc.
+        if(this.provider.reset)
+            this.provider.reset();
 
-    //  reset notification callbacks etc.
-    if(this.provider.reset)
-        this.provider.reset();
+        return true
+    } catch (e) {
+        throw new Error(`Error while clearing subscriptions: ${e}`)
+    }
 };
 
 /**

test/eth.subscribe.ganache.js

@@ -59,7 +59,7 @@ describe('subscription connect/reconnect', function () {
         await waitSeconds(1); // Sub need a little time to set up
 
         assert.equal(1, web3.eth._requestManager.subscriptions.size);
-        web3.eth.clearSubscriptions();
+        assert.ok(web3.eth.clearSubscriptions())
         assert.equal(0, web3.eth._requestManager.subscriptions.size);
     });