RxFire Realtime Database (#997)

* initial database code

* test setup

* database tests

* auditTrail and database tests

* [AUTOMATED]: Prettier Code Styling

* [AUTOMATED]: License Headers

* Josh's comments. Database docs

* [AUTOMATED]: Prettier Code Styling

* Firestore docs

* auth docs

* declaration fixes

* switch to peerDeps

* [AUTOMATED]: Prettier Code Styling

* test config

Author: davideast

packages/rxfire/auth/index.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { auth, User } from 'firebase/app';
+import { auth, User } from 'firebase';
 import { Observable, from, of } from 'rxjs';
 import { switchMap } from 'rxjs/operators';
 
@@ -47,7 +47,7 @@ export function user(auth: auth.Auth): Observable<User> {
  * sign-out, and token refresh events
  * @param auth firebase.auth.Auth
  */
-export function idToken(auth: auth.Auth) {
+export function idToken(auth: auth.Auth): Observable<string | null> {
   return user(auth).pipe(
     switchMap(user => (user ? from(user.getIdToken()) : of(null)))
   );

packages/rxfire/auth/package.json

@@ -1,5 +1,6 @@
 {
   "name": "rxfire/auth",
   "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js"
+  "module": "dist/index.esm.js",
+  "typings": "dist/auth/index.d.ts"
 }

packages/rxfire/database/fromRef.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { database } from 'firebase';
+import { Observable } from 'rxjs';
+import { ListenEvent, QueryChange } from './interfaces';
+/**
+ * Create an observable from a Database Reference or Database Query.
+ * @param ref Database Reference
+ * @param event Listen event type ('value', 'added', 'changed', 'removed', 'moved')
+ */
+export declare function fromRef(
+  ref: database.Query,
+  event: ListenEvent
+): Observable<QueryChange>;

packages/rxfire/database/fromRef.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { database } from 'firebase';
+import { Observable } from 'rxjs';
+import { map, delay, share } from 'rxjs/operators';
+import { ListenEvent, QueryChange } from './interfaces';
+
+/**
+ * Create an observable from a Database Reference or Database Query.
+ * @param ref Database Reference
+ * @param event Listen event type ('value', 'added', 'changed', 'removed', 'moved')
+ */
+export function fromRef(
+  ref: database.Query,
+  event: ListenEvent
+): Observable<QueryChange> {
+  return new Observable<QueryChange>(subscriber => {
+    const fn = ref.on(
+      event,
+      (snapshot, prevKey) => {
+        subscriber.next({ snapshot, prevKey, event });
+      },
+      subscriber.error.bind(subscriber)
+    );
+    return {
+      unsubscribe() {
+        ref.off(event, fn);
+      }
+    };
+  }).pipe(
+    // Ensures subscribe on observable is async. This handles
+    // a quirk in the SDK where on/once callbacks can happen
+    // synchronously.
+    delay(0)
+  );
+}

packages/rxfire/database/index.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './fromRef';
+export * from './interfaces';
+export * from './list';
+export * from './object';

packages/rxfire/database/interfaces.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { database } from 'firebase';
+export declare enum ListenEvent {
+  added = 'child_added',
+  removed = 'child_removed',
+  changed = 'child_changed',
+  moved = 'child_moved',
+  value = 'value'
+}
+export interface QueryChange {
+  snapshot: database.DataSnapshot;
+  prevKey: string | null | undefined;
+  event: ListenEvent;
+}

packages/rxfire/database/interfaces.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { database } from 'firebase';
+
+export enum ListenEvent {
+  added = 'child_added',
+  removed = 'child_removed',
+  changed = 'child_changed',
+  moved = 'child_moved',
+  value = 'value'
+}
+
+export interface QueryChange {
+  snapshot: database.DataSnapshot;
+  prevKey: string | null | undefined;
+  event: ListenEvent;
+}

packages/rxfire/database/list/audit-trail.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { database } from 'firebase';
+import { Observable } from 'rxjs';
+import { QueryChange, ListenEvent } from '../interfaces';
+export declare function auditTrail(
+  query: database.Query,
+  events?: ListenEvent[]
+): Observable<QueryChange[]>;

packages/rxfire/database/list/audit-trail.ts

@@ -0,0 +1,82 @@
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { database } from 'firebase';
+import { Observable } from 'rxjs';
+import { QueryChange, ListenEvent } from '../interfaces';
+import { fromRef } from '../fromRef';
+import { map, withLatestFrom, scan, skipWhile } from 'rxjs/operators';
+import { stateChanges } from './index';
+
+interface LoadedMetadata {
+  data: QueryChange;
+  lastKeyToLoad: any;
+}
+
+export function auditTrail(
+  query: database.Query,
+  events?: ListenEvent[]
+): Observable<QueryChange[]> {
+  const auditTrail$ = stateChanges(query, events).pipe(
+    scan<QueryChange>((current, changes) => [...current, changes], [])
+  );
+  return waitForLoaded(query, auditTrail$);
+}
+
+function loadedData(query: database.Query): Observable<LoadedMetadata> {
+  // Create an observable of loaded values to retrieve the
+  // known dataset. This will allow us to know what key to
+  // emit the "whole" array at when listening for child events.
+  return fromRef(query, ListenEvent.value).pipe(
+    map(data => {
+      // Store the last key in the data set
+      let lastKeyToLoad;
+      // Loop through loaded dataset to find the last key
+      data.snapshot.forEach(child => {
+        lastKeyToLoad = child.key;
+        return false;
+      });
+      // return data set and the current last key loaded
+      return { data, lastKeyToLoad };
+    })
+  );
+}
+
+function waitForLoaded(
+  query: database.Query,
+  snap$: Observable<QueryChange[]>
+) {
+  const loaded$ = loadedData(query);
+  return loaded$.pipe(
+    withLatestFrom(snap$),
+    // Get the latest values from the "loaded" and "child" datasets
+    // We can use both datasets to form an array of the latest values.
+    map(([loaded, changes]) => {
+      // Store the last key in the data set
+      let lastKeyToLoad = loaded.lastKeyToLoad;
+      // Store all child keys loaded at this point
+      const loadedKeys = changes.map(change => change.snapshot.key);
+      return { changes, lastKeyToLoad, loadedKeys };
+    }),
+    // This is the magical part, only emit when the last load key
+    // in the dataset has been loaded by a child event. At this point
+    // we can assume the dataset is "whole".
+    skipWhile(meta => meta.loadedKeys.indexOf(meta.lastKeyToLoad) === -1),
+    // Pluck off the meta data because the user only cares
+    // to iterate through the snapshots
+    map(meta => meta.changes)
+  );
+}