refactor(db): tests for stateChanges and auditTrail

Author: davideast

src/database/index.spec.ts

@@ -4,3 +4,5 @@ import './observable/fromRef.spec';
 import './list/changes.spec';
 import './list/loaded.spec';
 import './list/snapshot-changes.spec';
+import './list/state-changes.spec';
+import './list/audit-trail.spec';

src/database/list/audit-trail.spec.ts

@@ -0,0 +1,66 @@
+import * as firebase from 'firebase/app';
+import { FirebaseApp, FirebaseAppConfig, AngularFireModule } from 'angularfire2';
+import { AngularFireDatabase, AngularFireDatabaseModule, auditTrail, 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('stateChanges', () => {
+  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 prepareAuditTrail(opts: { events?: ChildEvent[], skip: number } = { skip: 0 }) {
+    const { events, skip } = opts;
+    const aref = createRef(rando());
+    aref.set(batch);
+    const changes = auditTrail(aref, events);
+    return {
+      changes: changes.skip(skip),
+      ref: aref 
+    };
+  }
+
+  it('should listen to all events by default', (done) => {
+
+    const { changes } = prepareAuditTrail();
+    changes.subscribe(actions => {
+      const data = actions.map(a => a.payload!.val());
+      expect(data).toEqual(items);
+      done();
+    });
+
+  });
+
+});

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

@@ -0,0 +1,66 @@
+import * as firebase from 'firebase/app';
+import { FirebaseApp, FirebaseAppConfig, AngularFireModule } from 'angularfire2';
+import { AngularFireDatabase, AngularFireDatabaseModule, stateChanges, 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('stateChanges', () => {
+  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 prepareStateChanges(opts: { events?: ChildEvent[], skip: number } = { skip: 0 }) {
+    const { events, skip } = opts;
+    const aref = createRef(rando());
+    aref.set(batch);
+    const changes = stateChanges(aref, events);
+    return {
+      changes: changes.skip(skip),
+      ref: aref 
+    };
+  }
+
+  it('should listen to all events by default', (done) => {
+
+    const { changes } = prepareStateChanges({ skip: 2 });
+    changes.subscribe(action => {
+      expect(action.key).toEqual('2');
+      expect(action.payload!.val()).toEqual(items[items.length - 1]);
+      done();
+    });
+
+  });
+
+});

src/database/public_api.ts

@@ -2,6 +2,8 @@ export * from './database';
 export * from './list/changes';
 export * from './list/create-reference';
 export * from './list/snapshot-changes';
+export * from './list/state-changes';
+export * from './list/audit-trail';
 export * from './list/loaded';
 export * from './observable/fromRef';
 export * from './database.module'

src/root.spec.js

@@ -7,6 +7,8 @@ export * from './packages-dist/database/observable/fromRef.spec';
 export * from './packages-dist/database/list/changes.spec';
 export * from './packages-dist/database/list/loaded.spec';
 export * from './packages-dist/database/list/snapshot-changes.spec';
+export * from './packages-dist/database/list/state-changes.spec';
+export * from './packages-dist/database/list/audit-trail.spec';
 
 // export * from './packages-dist/database-deprecated/firebase_list_factory.spec';
 // export * from './packages-dist/database-deprecated/firebase_object_factory.spec';