- push is now sync with no value OR async with a value

- added key property to refs
- added parent property to refs
- added root property to refs
- added toString method to refs

Author: Salakar

lib/modules/database/reference.js

@@ -2,11 +2,12 @@
  * @flow
  */
 import { NativeModules } from 'react-native';
-import { promisify } from './../../utils';
-import { ReferenceBase } from './../base';
-import Snapshot from './snapshot.js';
-import Disconnect from './disconnect.js';
+
 import Query from './query.js';
+import Snapshot from './snapshot';
+import Disconnect from './disconnect';
+import { ReferenceBase } from './../base';
+import { promisify, isFunction, isObject, tryJSONParse, tryJSONStringify, generatePushID } from './../../utils';
 
 const FirestackDatabase = NativeModules.FirestackDatabase;
 
@@ -26,29 +27,12 @@ export default class Reference extends ReferenceBase {
     super(db.firestack, path);
 
     this.db = db;
-    this.query = new Query(this, path, existingModifiers);
-    this.uid = uid++; // uuid.v4();
+    this.uid = uid += 1;
     this.listeners = {};
-
-    // Aliases
-    this.get = this.getAt;
-    this.set = this.setAt;
-    this.update = this.updateAt;
-    this.remove = this.removeAt;
-
+    this.query = new Query(this, path, existingModifiers);
     this.log.debug('Created new Reference', this.dbPath(), this.uid);
   }
 
-  // Parent roots
-  parent() {
-    const parentPaths = this.path.slice(0, -1);
-    return new Reference(this.db, parentPaths);
-  }
-
-  root() {
-    return new Reference(this.db, []);
-  }
-
   child(...paths: Array<string>) {
     return new Reference(this.db, this.path.concat(paths));
   }
@@ -59,38 +43,53 @@ export default class Reference extends ReferenceBase {
   }
 
   // Get the value of a ref either with a key
-  getAt() {
+  // todo - where is this on the FB JS api - seems just like another random function
+  get() {
     const path = this.dbPath();
     const modifiers = this.query.getModifiers();
     const modifiersString = this.query.getModifiersString();
     return promisify('onOnce', FirestackDatabase)(path, modifiersString, modifiers, 'value');
   }
 
-  setAt(val: any) {
+  set(value: any) {
     const path = this.dbPath();
-    const value = this._serializeValue(val);
-    return promisify('set', FirestackDatabase)(path, value);
+    const _value = this._serializeAnyType(value);
+    return promisify('set', FirestackDatabase)(path, _value);
   }
 
-  updateAt(val: any) {
+  update(val: Object) {
     const path = this.dbPath();
-    const value = this._serializeValue(val);
+    const value = this._serializeObject(val);
     return promisify('update', FirestackDatabase)(path, value);
   }
 
-  // TODO - what is key even for here?
-  removeAt(key: string) {
-    const path = this.dbPath();
-    return promisify('remove', FirestackDatabase)(path);
+  remove() {
+    return promisify('remove', FirestackDatabase)(this.dbPath());
   }
 
-  push(val: any = {}) {
+  /**
+   *
+   * @param value
+   * @param onComplete
+   * @returns {*}
+   */
+  push(value: any, onComplete: Function) {
+    if (value === null || value === undefined) {
+      // todo add server timestamp to push id call.
+      const _paths = this.path.concat([generatePushID()]);
+      return new Reference(this.db, _paths);
+    }
+
     const path = this.dbPath();
-    const value = this._serializeValue(val);
-    return promisify('push', FirestackDatabase)(path, value)
+    const _value = this._serializeAnyType(value);
+    return promisify('push', FirestackDatabase)(path, _value)
       .then(({ ref }) => {
-        const separator = '/';
-        return new Reference(this.db, ref.split(separator));
+        const newRef = new Reference(this.db, ref.split('/'));
+        if (isFunction(onComplete)) return onComplete(null, newRef);
+        return newRef;
+      }).catch((e) => {
+        if (isFunction(onComplete)) return onComplete(e, null);
+        return e;
       });
   }
 
@@ -100,7 +99,7 @@ export default class Reference extends ReferenceBase {
     const modifiersString = this.query.getModifiersString();
     this.log.debug('adding reference.on', path, modifiersString, evt);
     return this.db.storeRef(this.uid, this).then(() => {
-      return this.db.on(this.uid, path, modifiersString, modifiers, evt, cb).then(subscriptions => {
+      return this.db.on(this.uid, path, modifiersString, modifiers, evt, cb).then((subscriptions) => {
         this.listeners[evt] = subscriptions;
       });
     });
@@ -111,12 +110,11 @@ export default class Reference extends ReferenceBase {
     const modifiers = this.query.getModifiers();
     const modifiersString = this.query.getModifiersString();
     return this.db.storeRef(this.uid, this).then(() => {
+      // todo use event emitter - not callbacks
       return promisify('onOnce', FirestackDatabase)(path, modifiersString, modifiers, evt)
         .then(({ snapshot }) => new Snapshot(this, snapshot))
-        .then(snapshot => {
-          if (cb && typeof cb === 'function') {
-            cb(snapshot);
-          }
+        .then((snapshot) => {
+          if (isFunction(cb)) cb(snapshot);
           return snapshot;
         });
     });
@@ -128,49 +126,50 @@ export default class Reference extends ReferenceBase {
     const modifiersString = this.query.getModifiersString();
     this.log.debug('ref.off(): ', path, modifiers, evt);
     return this.db.unstoreRef(this.uid).then(() => {
-      return this.db.off(this.uid, path, modifiersString, modifiers, evt, origCB).then(subscriptions => {
+      return this.db.off(this.uid, path, modifiersString, modifiers, evt, origCB).then(() => {
+        // todo urm - whats this?
         // delete this.listeners[eventName];
         // this.listeners[evt] = subscriptions;
       });
     });
   }
 
   cleanup() {
-    let promises = Object.keys(this.listeners)
-      .map(key => this.off(key));
-    return Promise.all(promises);
-  }
-
-  // Sanitize value
-  // As Firebase cannot store date objects.
-  _serializeValue(obj: Object = {}) {
-    if (!obj) {
-      return obj;
-    }
-    return Object.keys(obj).reduce((sum, key) => {
-      let val = obj[key];
-      if (val instanceof Date) {
-        val = val.toISOString();
-      }
+    return Promise.all(Object.keys(this.listeners).map(key => this.off(key)));
+  }
+
+  /**
+   *
+   * @param obj
+   * @returns {Object}
+   * @private
+   */
+  _serializeObject(obj: Object) {
+    if (!isObject(obj)) return obj;
+
+    // json stringify then parse it calls toString on Objects / Classes
+    // that support it i.e new Date() becomes a ISO string.
+    return tryJSONParse(tryJSONStringify(obj));
+  }
+
+  /**
+   *
+   * @param value
+   * @returns {*}
+   * @private
+   */
+  _serializeAnyType(value: any) {
+    if (isObject(value)) {
       return {
-        ...sum,
-        [key]: val,
+        type: 'object',
+        value: this._serializeObject(value),
       };
-    }, {});
-  }
+    }
 
-  // TODO this function isn't used anywhere - why is it here?
-  _deserializeValue(obj: Object = {}) {
-    return Object.keys(obj).reduce((sum, key) => {
-      let val = obj[key];
-      if (val instanceof Date) {
-        val = val.getTime();
-      }
-      return {
-        ...sum,
-        [key]: val,
-      };
-    }, {});
+    return {
+      type: typeof value,
+      value,
+    };
   }
 
   // Modifiers
@@ -242,24 +241,36 @@ export default class Reference extends ReferenceBase {
   }
 
   // attributes
-  get fullPath(): string {
+  toString(): string {
     return this.dbPath();
   }
 
-  get name(): string {
-    return this.path.splice(-1);
-  }
+  dbPath(paths?: Array<string>): string {
+    const path = paths || this.path;
+    const pathStr = (path.length > 0 ? path.join('/') : '/');
 
-  dbPath(): string {
-    let path = this.path;
-    let pathStr = (path.length > 0 ? path.join('/') : '/');
     if (pathStr[0] !== '/') {
-      pathStr = `/${pathStr}`;
+      return `/${pathStr}`;
     }
+
     return pathStr;
   }
 
   get namespace(): string {
     return 'firestack:dbRef';
   }
+
+  get key(): string|null {
+    if (!this.path.length) return null;
+    return this.path.slice(this.path.length - 1, this.path.length)[0];
+  }
+
+  get parent(): Reference|null {
+    if (!this.path.length || this.path.length === 1) return null;
+    return new Reference(this.db, this.path.slice(0, -1));
+  }
+
+  get root(): Reference {
+    return new Reference(this.db, []);
+  }
 }