Merge pull request #8 from debris/autoprovider

Autoprovider
ethereum · Nov 11, 2014 · d85cef5 · d85cef5
2 parents dea68f0 + 838ca2f
commit d85cef5
Show file tree

Hide file tree

Showing 11 changed files with 629 additions and 489 deletions.
diff --git a/dist/ethereum.js b/dist/ethereum.js
diff --git a/dist/ethereum.js.map b/dist/ethereum.js.map
diff --git a/dist/ethereum.min.js b/dist/ethereum.min.js
diff --git a/example/index.html b/example/index.html
@@ -3,7 +3,7 @@
 
 <head>
 <script type="text/javascript" src="js/es6-promise/promise.min.js"></script>
-<script type="text/javascript" src="../dist/ethereum.min.js"></script>
+<script type="text/javascript" src="../dist/ethereum.js"></script>
 
 <script type="text/javascript">
 if (window.Promise === undefined) {
@@ -13,8 +13,9 @@
 var web3 = require('web3');
 
 //web3.setProvider(new web3.providers.QtProvider());
-web3.setProvider(new web3.providers.HttpRpcProvider("http://localhost:8080"));
+//web3.setProvider(new web3.providers.HttpRpcProvider("http://localhost:8080"));
 // web3.setProvider(new web3.providers.WebSocketProvider("ws://localhost:40404/eth"));
+web3.setProvider(new web3.providers.AutoProvider());
 
 function testSnippet() {
     web3.eth.watch({altered: web3.eth.coinbase}).changed(function() {

diff --git a/gulpfile.js b/gulpfile.js
@@ -25,8 +25,8 @@ var build = function(src, dst) {
       detectGlobals: false,
       bundleExternal: false
     })
-    .add('./')
     .require('./' + src + '.js', {expose: 'web3'})
+    .add('./' + src + '.js')
     .transform('envify', {
       NODE_ENV: 'build'
     })
@@ -50,6 +50,25 @@ var build = function(src, dst) {
     .pipe(gulp.dest( DEST ));
 };
 
+var buildDev = function(src, dst) {
+  return browserify({
+      debug: true,
+      insert_global_vars: false,
+      detectGlobals: false,
+      bundleExternal: false
+    })
+    .require('./' + src + '.js', {expose: 'web3'})
+    .add('./' + src + '.js')
+    .transform('envify', {
+      NODE_ENV: 'build'
+    })
+    .transform('unreachable-branch-transform')
+    .bundle()
+    .pipe(exorcist(path.join( DEST, dst + '.js.map')))
+    .pipe(source(dst + '.js'))
+    .pipe(gulp.dest( DEST ));
+};
+
 var uglifyFile = function(file) {
   return gulp.src( DEST + file + '.js')
     .pipe(uglify())
@@ -79,15 +98,19 @@ gulp.task('build', ['clean'], function () {
 });
 
 gulp.task('buildQt', ['clean'], function () {
-    return build('index_qt', 'ethereum_qt');
+    return build('index_qt', 'ethereum');
+});
+
+gulp.task('buildDev', ['clean'], function () {
+    return buildDev('index', 'ethereum');
 });
 
 gulp.task('uglify', ['build'], function(){
     return uglifyFile('ethereum');
 });
 
 gulp.task('uglifyQt', ['buildQt'], function () {
-    return uglifyFile('ethereum_qt');
+    return uglifyFile('ethereum');
 });
 
 gulp.task('watch', function() {
@@ -96,3 +119,5 @@ gulp.task('watch', function() {
 
 gulp.task('default', ['bower', 'lint', 'build', 'uglify']);
 gulp.task('qt', ['bower', 'lint', 'buildQt', 'uglifyQt']);
+gulp.task('dev', ['bower', 'lint', 'buildDev']);
+
diff --git a/index.js b/index.js
@@ -2,5 +2,6 @@ var web3 = require('./lib/main');
 web3.providers.WebSocketProvider = require('./lib/websocket');
 web3.providers.HttpRpcProvider = require('./lib/httprpc');
 web3.providers.QtProvider = require('./lib/qt');
+web3.providers.AutoProvider = require('./lib/autoprovider');
 
-module.exports = web3;
+module.exports = web3;
diff --git a/lib/autoprovider.js b/lib/autoprovider.js
@@ -0,0 +1,103 @@
+/*
+    This file is part of ethereum.js.
+
+    ethereum.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    ethereum.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with ethereum.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/** @file websocket.js
+ * @authors:
+ *   Marek Kotewicz <[email protected]>
+ *   Marian Oancea <[email protected]>
+ * @date 2014
+ */
+
+/*
+ * @brief if qt object is available, uses QtProvider,
+ * if not tries to connect over websockets
+ * if it fails, it uses HttpRpcProvider
+ */
+if (process.env.NODE_ENV !== 'build') {
+    var WebSocket = require('ws'); // jshint ignore:line
+}
+
+if (process.env.NODE_ENV !== 'build') {
+    var web3 = require('./web3'); // jshint ignore:line
+}
+
+var AutoProvider = function (userOptions) {
+    if (web3.haveProvider()) {
+        return;
+    }
+
+    // before we determine what provider we are, we have to cache request
+    this.sendQueue = [];
+    this.onmessageQueue = [];
+
+    if (navigator.qt) {
+        this.provider = new web3.providers.QtProvider();
+        return;
+    }
+
+    userOptions = userOptions || {};
+    var options = {
+        httprpc: userOptions.httprpc || 'http://localhost:8080',
+        websockets: userOptions.websockets || 'ws://localhost:40404/eth'
+    };
+
+    var self = this;
+    var closeWithSuccess = function (success) {
+        ws.close();
+        if (success) {
+            self.provider = new web3.providers.WebSocketProvider(options.websockets);
+            return;
+        }
+        self.provider = new web3.providers.HttpRpcProvider(options.httprpc);
+        self.poll = self.provider.poll.bind(self.provider);
+        self.sendQueue.forEach(function (payload) {
+            self.provider(payload);
+        });
+        self.onmessageQueue.forEach(function (handler) {
+            self.provider.onmessage = handler;
+        });
+    };
+
+    var ws = new WebSocket(options.websockets);
+
+    ws.onopen = function() {
+        closeWithSuccess(true);    
+    };
+
+    ws.onerror = function() {
+        closeWithSuccess(false);
+    };
+};
+
+AutoProvider.prototype.send = function (payload) {
+    if (this.provider) {
+        this.provider.send(payload);
+        return;
+    }
+    this.sendQueue.push(payload);
+};
+
+Object.defineProperty(AutoProvider.prototype, 'onmessage', {
+    set: function (handler) {
+        if (this.provider) {
+            this.provider.onmessage = handler;
+            return;
+        }
+        this.onmessageQueue.push(handler);
+    }
+});
+
+module.exports = AutoProvider;
diff --git a/lib/httprpc.js b/lib/httprpc.js
@@ -21,74 +21,73 @@
  * @date 2014
  */
 
-if(process.env.NODE_ENV !== "build") {
+if (process.env.NODE_ENV !== "build") {
     var XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest; // jshint ignore:line
 }
 
+var HttpRpcProvider = function (host) {
+    this.handlers = [];
+    this.host = host;
+};
 
-    var HttpRpcProvider = function (host) {
-        this.handlers = [];
-        this.host = host;
+function formatJsonRpcObject(object) {
+    return {
+        jsonrpc: '2.0',
+        method: object.call,
+        params: object.args,
+        id: object._id
     };
+}
 
-    function formatJsonRpcObject(object) {
-        return {
-            jsonrpc: '2.0',
-            method: object.call,
-            params: object.args,
-            id: object._id
-        };
-    }
-
-    function formatJsonRpcMessage(message) {
-        var object = JSON.parse(message);
-
-        return {
-            _id: object.id,
-            data: object.result,
-            error: object.error
-        };
-    }
-
-    HttpRpcProvider.prototype.sendRequest = function (payload, cb) {
-        var data = formatJsonRpcObject(payload);
+function formatJsonRpcMessage(message) {
+    var object = JSON.parse(message);
 
-        var request = new XMLHttpRequest();
-        request.open("POST", this.host, true);
-        request.send(JSON.stringify(data));
-        request.onreadystatechange = function () {
-            if (request.readyState === 4 && cb) {
-                cb(request);
-            }
-        };
+    return {
+        _id: object.id,
+        data: object.result,
+        error: object.error
     };
+}
 
-    HttpRpcProvider.prototype.send = function (payload) {
-        var self = this;
-        this.sendRequest(payload, function (request) {
-            self.handlers.forEach(function (handler) {
-                handler.call(self, formatJsonRpcMessage(request.responseText));
-            });
-        });
+HttpRpcProvider.prototype.sendRequest = function (payload, cb) {
+    var data = formatJsonRpcObject(payload);
+
+    var request = new XMLHttpRequest();
+    request.open("POST", this.host, true);
+    request.send(JSON.stringify(data));
+    request.onreadystatechange = function () {
+        if (request.readyState === 4 && cb) {
+            cb(request);
+        }
     };
+};
 
-    HttpRpcProvider.prototype.poll = function (payload, id) {
-        var self = this;
-        this.sendRequest(payload, function (request) {
-            var parsed = JSON.parse(request.responseText);
-            if (parsed.error || (parsed.result instanceof Array ? parsed.result.length === 0 : !parsed.result)) {
-                return;
-            }
-            self.handlers.forEach(function (handler) {
-                handler.call(self, {_event: payload.call, _id: id, data: parsed.result});
-            });
+HttpRpcProvider.prototype.send = function (payload) {
+    var self = this;
+    this.sendRequest(payload, function (request) {
+        self.handlers.forEach(function (handler) {
+            handler.call(self, formatJsonRpcMessage(request.responseText));
         });
-    };
+    });
+};
 
-    Object.defineProperty(HttpRpcProvider.prototype, "onmessage", {
-        set: function (handler) {
-            this.handlers.push(handler);
+HttpRpcProvider.prototype.poll = function (payload, id) {
+    var self = this;
+    this.sendRequest(payload, function (request) {
+        var parsed = JSON.parse(request.responseText);
+        if (parsed.error || (parsed.result instanceof Array ? parsed.result.length === 0 : !parsed.result)) {
+            return;
         }
+        self.handlers.forEach(function (handler) {
+            handler.call(self, {_event: payload.call, _id: id, data: parsed.result});
+        });
     });
+};
+
+Object.defineProperty(HttpRpcProvider.prototype, "onmessage", {
+    set: function (handler) {
+        this.handlers.push(handler);
+    }
+});
 
 module.exports = HttpRpcProvider;