WIP: patch database code in nodeJS

Author: jshcrowthe

src/database.ts

@@ -23,10 +23,11 @@ import { enableLogging } from "./database/core/util/util";
 import { RepoManager } from "./database/core/RepoManager";
 import * as INTERNAL from './database/api/internal';
 import * as TEST_ACCESS from './database/api/test_access';
+import { isNodeSdk } from "./utils/environment";
 
 export function registerDatabase(instance) {
   // Register the Database Service with the 'firebase' namespace.
-  instance.INTERNAL.registerService(
+  const namespace = instance.INTERNAL.registerService(
     'database',
     app => RepoManager.getInstance().databaseFromApp(app),
     // firebase.database namespace properties
@@ -40,6 +41,10 @@ export function registerDatabase(instance) {
       TEST_ACCESS
     }
   );
+
+  if (isNodeSdk()) {
+    module.exports = namespace;
+  }
 }
 
 /**
@@ -57,4 +62,4 @@ declare module './app/firebase_app' {
   }
 }
 
-registerDatabase(firebase);
+registerDatabase(firebase);

src/database/core/PersistentConnection.ts

@@ -11,8 +11,9 @@ import { Connection } from "../realtime/Connection";
 import { CONSTANTS } from "../../utils/constants";
 import { 
   isMobileCordova,
-  isReactNative
-} from "../login/util/environment";
+  isReactNative,
+  isNodeSdk
+} from "../../utils/environment";
 
 var RECONNECT_MIN_DELAY = 1000;
 var RECONNECT_MAX_DELAY_DEFAULT = 60 * 5 * 1000;   // 5 minutes in milliseconds (Case: 1858)
@@ -120,7 +121,7 @@ export class PersistentConnection {
     this.authTokenProvider_ = authTokenProvider;
     this.forceTokenRefresh_ = false;
     this.invalidAuthTokenCount_ = 0;
-    if (authOverride) {
+    if (authOverride && !isNodeSdk()) {
       throw new Error('Auth override specified in options, but not supported on non Node.js platforms');
     }
     /** private {Object|null|undefined} */

src/database/core/util/OnlineMonitor.ts

@@ -1,6 +1,6 @@
 import { assert } from "../../../utils/assert";
 import { EventEmitter } from "./EventEmitter";
-import { isMobileCordova } from "../../login/util/environment";
+import { isMobileCordova } from "../../../utils/environment";
 
 /**
  * Monitors online state (as reported by window.online/offline events).

src/database/core/util/util.ts

@@ -12,7 +12,7 @@ import { stringToByteArray } from "../../../utils/utf8";
 import { stringify } from "../../../utils/json";
 import { SessionStorage } from "../storage/storage";
 import { RepoInfo } from "../RepoInfo";
-import { isNodeSdk } from "../../login/util/environment";
+import { isNodeSdk } from "../../../utils/environment";
 
 /**
  * Returns a locally-unique ID (generated by just incrementing up from 0 each time its called).

src/database/realtime/BrowserPollConnection.ts

@@ -13,6 +13,7 @@ import { StatsManager } from "../core/stats/StatsManager";
 import { PacketReceiver } from "./polling/PacketReceiver";
 import { CONSTANTS } from "./Constants";
 import { stringify } from "../../utils/json";
+import { isNodeSdk } from "../../utils/environment";
 
 // URL query parameters associated with longpolling
 // TODO: move more of these out of the global namespace
@@ -175,7 +176,8 @@ export class BrowserPollConnection {
       if (self.lastSessionId) {
         urlParams[CONSTANTS.LAST_SESSION_PARAM] = self.lastSessionId;
       }
-      if (typeof location !== 'undefined' &&
+      if (!isNodeSdk() && 
+        typeof location !== 'undefined' &&
         location.href &&
         location.href.indexOf(CONSTANTS.FORGE_DOMAIN) !== -1) {
         urlParams[CONSTANTS.REFERER_PARAM] = CONSTANTS.FORGE_REF;
@@ -220,7 +222,8 @@ export class BrowserPollConnection {
         !BrowserPollConnection.forceDisallow_ &&
         typeof document !== 'undefined' && document.createElement != null &&
         !isChromeExtensionContentScript() &&
-        !isWindowsStoreApp()
+        !isWindowsStoreApp() &&
+        !isNodeSdk()
       );
   };
 
@@ -313,6 +316,7 @@ export class BrowserPollConnection {
    * @param {!string} pw
    */
   addDisconnectPingFrame(id, pw) {
+    if (isNodeSdk()) return;
     this.myDisconnFrame = document.createElement('iframe');
     var urlParams = {};
     urlParams[FIREBASE_LONGPOLL_DISCONN_FRAME_REQUEST_PARAM] = 't';
@@ -370,36 +374,42 @@ function FirebaseIFrameScriptHolder(commandCB, onMessageCB, onDisconnectCB, urlF
   // incoming data from the server that we're waiting for).
   this.sendNewPolls = true;
 
-  //Each script holder registers a couple of uniquely named callbacks with the window. These are called from the
-  //iframes where we put the long-polling script tags. We have two callbacks:
-  //   1) Command Callback - Triggered for control issues, like starting a connection.
-  //   2) Message Callback - Triggered when new data arrives.
-  this.uniqueCallbackIdentifier = LUIDGenerator();
-  window[FIREBASE_LONGPOLL_COMMAND_CB_NAME + this.uniqueCallbackIdentifier] = commandCB;
-  window[FIREBASE_LONGPOLL_DATA_CB_NAME + this.uniqueCallbackIdentifier] = onMessageCB;
-
-  //Create an iframe for us to add script tags to.
-  this.myIFrame = this.createIFrame_();
-
-  // Set the iframe's contents.
-  var script = '';
-  // if we set a javascript url, it's IE and we need to set the document domain. The javascript url is sufficient
-  // for ie9, but ie8 needs to do it again in the document itself.
-  if (this.myIFrame.src && this.myIFrame.src.substr(0, 'javascript:'.length) === 'javascript:') {
-    var currentDomain = document.domain;
-    script = '<script>document.domain="' + currentDomain + '";</script>';
-  }
-  var iframeContents = '<html><body>' + script + '</body></html>';
-  try {
-    this.myIFrame.doc.open();
-    this.myIFrame.doc.write(iframeContents);
-    this.myIFrame.doc.close();
-  } catch (e) {
-    log('frame writing exception');
-    if (e.stack) {
-      log(e.stack);
+
+  if (!isNodeSdk()) {
+    //Each script holder registers a couple of uniquely named callbacks with the window. These are called from the
+    //iframes where we put the long-polling script tags. We have two callbacks:
+    //   1) Command Callback - Triggered for control issues, like starting a connection.
+    //   2) Message Callback - Triggered when new data arrives.
+    this.uniqueCallbackIdentifier = LUIDGenerator();
+    window[FIREBASE_LONGPOLL_COMMAND_CB_NAME + this.uniqueCallbackIdentifier] = commandCB;
+    window[FIREBASE_LONGPOLL_DATA_CB_NAME + this.uniqueCallbackIdentifier] = onMessageCB;
+
+    //Create an iframe for us to add script tags to.
+    this.myIFrame = this.createIFrame_();
+
+    // Set the iframe's contents.
+    var script = '';
+    // if we set a javascript url, it's IE and we need to set the document domain. The javascript url is sufficient
+    // for ie9, but ie8 needs to do it again in the document itself.
+    if (this.myIFrame.src && this.myIFrame.src.substr(0, 'javascript:'.length) === 'javascript:') {
+      var currentDomain = document.domain;
+      script = '<script>document.domain="' + currentDomain + '";</script>';
+    }
+    var iframeContents = '<html><body>' + script + '</body></html>';
+    try {
+      this.myIFrame.doc.open();
+      this.myIFrame.doc.write(iframeContents);
+      this.myIFrame.doc.close();
+    } catch (e) {
+      log('frame writing exception');
+      if (e.stack) {
+        log(e.stack);
+      }
+      log(e);
     }
-    log(e);
+  } else {
+    this.commandCB = commandCB;
+    this.onMessageCB = onMessageCB;
   }
 }
 
@@ -468,6 +478,15 @@ FirebaseIFrameScriptHolder.prototype.close = function() {
     }, Math.floor(0));
   }
 
+  if (isNodeSdk() && this.myID) {
+    var urlParams = {};
+    urlParams[FIREBASE_LONGPOLL_DISCONN_FRAME_PARAM] = 't';
+    urlParams[FIREBASE_LONGPOLL_ID_PARAM] = this.myID;
+    urlParams[FIREBASE_LONGPOLL_PW_PARAM] = this.myPW;
+    var theURL = this.urlFn(urlParams);
+    FirebaseIFrameScriptHolder.nodeRestRequest(theURL);
+  }
+
   // Protect from being called recursively.
   var onDisconnect = this.onDisconnect;
   if (onDisconnect) {
@@ -590,33 +609,87 @@ FirebaseIFrameScriptHolder.prototype.addLongPollTag_ = function(url, serial) {
  * @param {!function()} loadCB - A callback to be triggered once the script has loaded.
  */
 FirebaseIFrameScriptHolder.prototype.addTag = function(url, loadCB) {
-  var self = this;
-  setTimeout(function() {
-    try {
-      // if we're already closed, don't add this poll
-      if (!self.sendNewPolls) return;
-      var newScript = self.myIFrame.doc.createElement('script');
-      newScript.type = 'text/javascript';
-      newScript.async = true;
-      newScript.src = url;
-      newScript.onload = newScript.onreadystatechange = function() {
-        var rstate = newScript.readyState;
-        if (!rstate || rstate === 'loaded' || rstate === 'complete') {
-          newScript.onload = newScript.onreadystatechange = null;
-          if (newScript.parentNode) {
-            newScript.parentNode.removeChild(newScript);
+  if (isNodeSdk()) {
+    this.doNodeLongPoll(url, loadCB);
+  } else {
+    var self = this;
+    setTimeout(function() {
+      try {
+        // if we're already closed, don't add this poll
+        if (!self.sendNewPolls) return;
+        var newScript = self.myIFrame.doc.createElement('script');
+        newScript.type = 'text/javascript';
+        newScript.async = true;
+        newScript.src = url;
+        newScript.onload = newScript.onreadystatechange = function() {
+          var rstate = newScript.readyState;
+          if (!rstate || rstate === 'loaded' || rstate === 'complete') {
+            newScript.onload = newScript.onreadystatechange = null;
+            if (newScript.parentNode) {
+              newScript.parentNode.removeChild(newScript);
+            }
+            loadCB();
           }
-          loadCB();
-        }
-      };
-      newScript.onerror = function() {
-        log('Long-poll script failed to load: ' + url);
-        self.sendNewPolls = false;
-        self.close();
-      };
-      self.myIFrame.doc.body.appendChild(newScript);
-    } catch (e) {
-      // TODO: we should make this error visible somehow
-    }
-  }, Math.floor(1));
-};
+        };
+        newScript.onerror = function() {
+          log('Long-poll script failed to load: ' + url);
+          self.sendNewPolls = false;
+          self.close();
+        };
+        self.myIFrame.doc.body.appendChild(newScript);
+      } catch (e) {
+        // TODO: we should make this error visible somehow
+      }
+    }, Math.floor(1));
+  }
+};
+
+if (isNodeSdk()) {
+  /**
+   * @type {?function({url: string, forever: boolean}, function(Error, number, string))}
+   */
+  (FirebaseIFrameScriptHolder as any).request = null;
+
+  /**
+   * @param {{url: string, forever: boolean}} req
+   * @param {function(string)=} onComplete
+   */
+  (FirebaseIFrameScriptHolder as any).nodeRestRequest = function(req, onComplete) {
+    if (!(FirebaseIFrameScriptHolder as any).request)
+      (FirebaseIFrameScriptHolder as any).request =
+        /** @type {function({url: string, forever: boolean}, function(Error, number, string))} */ (require('request'));
+
+    (FirebaseIFrameScriptHolder as any).request(req, function(error, response, body) {
+      if (error)
+        throw 'Rest request for ' + req.url + ' failed.';
+
+      if (onComplete)
+        onComplete(body);
+    });
+  };
+
+  /**
+   * @param {!string} url
+   * @param {function()} loadCB
+   */
+  FirebaseIFrameScriptHolder.prototype.doNodeLongPoll = function(url, loadCB) {
+    var self = this;
+    (FirebaseIFrameScriptHolder as any).nodeRestRequest({ url: url, forever: true }, function(body) {
+      self.evalBody(body);
+      loadCB();
+    });
+  };
+
+  /**
+   * Evaluates the string contents of a jsonp response.
+   * @param {!string} body
+   */
+  FirebaseIFrameScriptHolder.prototype.evalBody = function(body) {
+    var jsonpCB;
+    //jsonpCB is externed in firebase-extern.js
+    eval('jsonpCB = function(' + FIREBASE_LONGPOLL_COMMAND_CB_NAME + ', ' + FIREBASE_LONGPOLL_DATA_CB_NAME + ') {' +
+          body +
+        '}');
+    jsonpCB(this.commandCB, this.onMessageCB);
+  };
+}

src/database/realtime/WebSocketConnection.ts

@@ -8,12 +8,15 @@ import { CONSTANTS } from "./Constants";
 import { CONSTANTS as ENV_CONSTANTS } from "../../utils/constants";
 import { PersistentStorage } from "../core/storage/storage";
 import { jsonEval, stringify } from "../../utils/json";
+import { isNodeSdk } from "../../utils/environment";
 
 const WEBSOCKET_MAX_FRAME_SIZE = 16384;
 const WEBSOCKET_KEEPALIVE_INTERVAL = 45000;
 
 let WebSocketImpl = null;
-if (typeof MozWebSocket !== 'undefined') {
+if (isNodeSdk()) {
+  WebSocketImpl = require('faye-websocket')['Client'];
+} else if (typeof MozWebSocket !== 'undefined') {
   WebSocketImpl = MozWebSocket;
 } else if (typeof WebSocket !== 'undefined') {
   WebSocketImpl = WebSocket;
@@ -69,7 +72,8 @@ export class WebSocketConnection {
     var urlParams = {};
     urlParams[CONSTANTS.VERSION_PARAM] = CONSTANTS.PROTOCOL_VERSION;
 
-    if (typeof location !== 'undefined' &&
+    if (!isNodeSdk() &&
+        typeof location !== 'undefined' &&
         location.href &&
         location.href.indexOf(CONSTANTS.FORGE_DOMAIN) !== -1) {
       urlParams[CONSTANTS.REFERER_PARAM] = CONSTANTS.FORGE_REF;
@@ -99,6 +103,29 @@ export class WebSocketConnection {
     PersistentStorage.set('previous_websocket_failure', true);
 
     try {
+      if (isNodeSdk()) {
+        var device = ENV_CONSTANTS.NODE_ADMIN ? 'AdminNode' : 'Node';
+        // UA Format: Firebase/<wire_protocol>/<sdk_version>/<platform>/<device>
+        var options = {
+          'headers': {
+            'User-Agent': 'Firebase/' + CONSTANTS.PROTOCOL_VERSION + '/' + firebase.SDK_VERSION + '/' + process.platform + '/' + device
+        }};
+
+        // Plumb appropriate http_proxy environment variable into faye-websocket if it exists.
+        var env = process['env'];
+        var proxy = (this.connURL.indexOf("wss://") == 0)
+            ? (env['HTTPS_PROXY'] || env['https_proxy'])
+            : (env['HTTP_PROXY']  || env['http_proxy']);
+
+        if (proxy) {
+          options['proxy'] = { origin: proxy };
+        }
+
+        this.mySock = new WebSocketImpl(this.connURL, [], options);
+      }
+      else {
+        this.mySock = new WebSocketImpl(this.connURL);
+      }
       this.mySock = new WebSocketImpl(this.connURL);
     } catch (e) {
       this.log_('Error instantiating WebSocket.');

src/database/login/util/environment.ts renamed to src/utils/environment.ts

@@ -1,4 +1,4 @@
-import { CONSTANTS } from "../../../utils/constants";
+import { CONSTANTS } from "./constants";
 
 /**
  * Returns navigator.userAgent string or '' if it's not defined.