refactor(db): snapshot changes tests

Author: davideast

src/database/database.spec.ts

@@ -7,7 +7,7 @@ import { COMMON_CONFIG } from './test-config';
 // generate random string to test fidelity of naming
 const FIREBASE_APP_NAME = (Math.random() + 1).toString(36).substring(7);
 
-describe('AngularFireDatabase', () => {
+fdescribe('AngularFireDatabase', () => {
   let app: FirebaseApp;
   let db: AngularFireDatabase;
 
@@ -45,6 +45,7 @@ describe('AngularFireDatabase', () => {
 
     it('should have an initialized Firebase database instance member', () => {
       expect(db.database.app.name).toEqual(FIREBASE_APP_NAME);
+      debugger;
     });    
 
   });

src/database/database.ts

@@ -31,3 +31,15 @@ export class AngularFireDatabase {
 
 }
 
+export { 
+  PathReference, 
+  DatabaseQuery, 
+  DatabaseReference, 
+  DatabaseSnapshot, 
+  ChildEvent, 
+  ListenEvent,
+  SnapshotChange, 
+  QueryFn, 
+  ListReference, 
+  ObjectReference 
+} from './interfaces';

src/database/index.spec.ts

@@ -2,3 +2,4 @@ import './database.spec';
 import './utils.spec';
 import './observable/fromRef.spec';
 import './list/changes.spec';
+import './list/snapshot-changes.spec';

src/database/list/changes.spec.ts

@@ -9,7 +9,7 @@ import 'rxjs/add/operator/skip';
 const rando = () => (Math.random() + 1).toString(36).substring(7);
 const FIREBASE_APP_NAME = rando();
 
-fdescribe('listChanges', () => {
+describe('listChanges', () => {
   let app: FirebaseApp;
   let db: AngularFireDatabase;
   let ref: (path: string) => firebase.database.Reference;

src/database/list/snapshot-changes.spec.ts

@@ -0,0 +1,92 @@
+import * as firebase from 'firebase/app';
+import { FirebaseApp, FirebaseAppConfig, AngularFireModule } from 'angularfire2';
+import { AngularFireDatabase, AngularFireDatabaseModule, createListSnapshotChanges, ChildEvent } from 'angularfire2/database';
+import { TestBed, inject } from '@angular/core/testing';
+import { COMMON_CONFIG } from '../test-config';
+import 'rxjs/add/operator/skip';
+
+// generate random string to test fidelity of naming
+const rando = () => (Math.random() + 1).toString(36).substring(7);
+const FIREBASE_APP_NAME = rando();
+
+describe('snapshotChanges', () => {
+  let app: FirebaseApp;
+  let db: AngularFireDatabase;
+  let createRef: (path: string) => firebase.database.Reference;
+  let batch = {};
+  const items = [{ name: 'zero' }, { name: 'one' }, { name: 'two' }].map((item, i) => ( { key: i.toString(), ...item } ));
+  Object.keys(items).forEach(function (key, i) {
+    const itemValue = items[key];
+    batch[i] = itemValue;
+  });
+  // make batch immutable to preserve integrity
+  batch = Object.freeze(batch);
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      imports: [
+        AngularFireModule.initializeApp(COMMON_CONFIG, FIREBASE_APP_NAME),
+        AngularFireDatabaseModule
+      ]
+    });
+    inject([FirebaseApp, AngularFireDatabase], (app_: FirebaseApp, _db: AngularFireDatabase) => {
+      app = app_;
+      db = _db;
+      app.database().goOffline();
+      createRef = (path: string) => { app.database().goOffline(); return app.database().ref(path); };
+    })();
+  });
+
+  afterEach(done => {
+    app.delete().then(done, done.fail);
+  });
+
+  function prepareSnapshotChanges(opts: { events?: ChildEvent[], skip: number } = { skip: 0 }) {
+    const { events, skip } = opts;
+    const aref = createRef(rando());
+    aref.set(batch);
+    const snapshotChanges = createListSnapshotChanges(aref);
+    return {
+      snapshotChanges: snapshotChanges(events).skip(skip),
+      ref: aref 
+    };
+  }
+
+  it('should listen to all events by default', (done) => {
+    const { snapshotChanges } = prepareSnapshotChanges({ skip: 2 });
+    const sub = snapshotChanges.subscribe(snaps => {
+      const data = snaps.map(snap => snap.val())
+      expect(data).toEqual(items);
+      done();
+      sub.unsubscribe();
+    });
+  });
+
+  it('should listen to only child_added events', (done) => {
+    const { snapshotChanges } = prepareSnapshotChanges({ events: ['child_added'], skip: 2 });
+    const sub = snapshotChanges.subscribe(snaps => {
+      const data = snaps.map(snap => snap.val())
+      expect(data).toEqual(items);
+      done();
+      sub.unsubscribe();
+    });
+  });
+
+  it('should listen to only child_added, child_changed events', (done) => {
+    const {snapshotChanges, ref } = prepareSnapshotChanges({ 
+      events: ['child_added', 'child_changed'], 
+      skip: 3 
+    });
+    const name = 'ligatures';
+    const sub = snapshotChanges.subscribe(snaps => {
+      const data = snaps.map(snap => snap.val());
+      const copy = [...items];
+      copy[0].name = name;
+      expect(data).toEqual(copy);
+      done();
+      sub.unsubscribe();
+    });
+    ref.child(items[0].key).update({ name });
+  });  
+
+});

src/database/list/utils.ts

@@ -2,7 +2,7 @@ import { isNil } from '../utils';
 
 export function validateEventsArray(events?: any[]) {
   if(isNil(events) || events!.length === 0) {
-    events = ['added', 'removed', 'changed', 'moved'];
+    events = ['child_added', 'child_removed', 'child_changed', 'child_moved'];
   }
   return events;
 }

src/root.spec.js

@@ -10,3 +10,4 @@ export * from './packages-dist/database/database.spec';
 export * from './packages-dist/database/utils.spec';
 export * from './packages-dist/database/observable/fromRef.spec';
 export * from './packages-dist/database/list/changes.spec';
+export * from './packages-dist/database/list/snapshot-changes.spec';