fix: unsubscribe from inner geohashes

Author: codediodeio

README.md

@@ -48,18 +48,13 @@ const geo = require('geofirex').init(admin);
 With Typescript:
 
 ```ts
-// Init Firebase
-import * as firebase from 'firebase/app'; 
-firebase.initializeApp(yourConfig);
-
-// Init GeoFireX
 import * as geofirex from 'geofirex'; 
 const geo = geofirex.init(firebase);
 ```
 
 ### Write Geo Data
 
-Next, add some geolocation data in your database. A `collection` creates a reference to Firestore (just like the SDK), but with some extra geolocation tools. The `point` method returns a class that helps you create geolocation data.
+Next, add some geolocation data in your database. A `collection` creates a reference to Firestore (just like the SDK), but with some extra geolocation tools. The `point` method returns a class 
 
 ```ts
 const cities = geo.collection('cities');
@@ -142,7 +137,9 @@ Returns a GeoFirePoint allowing you to create geohashes, format data, and calcul
 
 Example: `const point = geo.point(38, -119)`
 
-#### Getters
+#### Get Data
+
+A point can return data in a variety of formats. 
 
 - `point.hash()` Returns a geohash string at precision 9
 - `point.geoPoint()` Returns a Firestore GeoPoint
@@ -159,6 +156,11 @@ Example: `const point = geo.point(38, -119)`
 
 The goal of this package is to facilitate rapid feature development with tools like MapBox, Google Maps, and D3.js. If you have an idea for a useful feature, open an issue.
 
+### Logging
+
+
+![Logging GeoQueries](https://firebasestorage.googleapis.com/v0/b/geo-test-c92e4.appspot.com/o/geofirex-logging.PNG?alt=media&token=9b8b487d-18b2-4e5f-bb04-564fa6f2996d)
+
 ### `toGeoJSON` Operator
 
 A custom RxJS operator that transforms a collection into a [GeoJSON FeatureCollection](https://macwright.org/2015/03/23/geojson-second-bite.html#featurecollection). Very useful for tools like [MapBox](https://blog.mapbox.com/real-time-maps-for-live-events-fad0b334e4e) that can use GeoJSON to update a realtime data source.

example/src/app/basic-geoquery/basic-geoquery.component.ts

@@ -1,6 +1,6 @@
 import { Component, OnInit } from '@angular/core';
-import { Observable, BehaviorSubject } from 'rxjs';
-import { switchMap } from 'rxjs/operators';
+import { Observable, BehaviorSubject, interval } from 'rxjs';
+import { switchMap, share, shareReplay, tap } from 'rxjs/operators';
 import * as firebaseApp from 'firebase/app';
 import * as geofirex from 'geofirex';
 
@@ -19,12 +19,19 @@ export class BasicGeoqueryComponent implements OnInit {
 
   ngOnInit() {
     const center = this.geo.point(40.5, -80.0);
-    const radius = 0.5;
     const field = 'pos';
 
-    const collection = this.geo.collection('users', ref =>
-      ref.where('status', '==', 'single').where('online', '==', true)
+    this.points = this.radius.pipe(
+      switchMap(r => {
+        console.log('new rad');
+        return this.geo.collection('bearings').within(center, r, field, { log: true });
+      }),
+      shareReplay(1)
     );
+
+    // this.radius.pipe(
+    //   switchMap(v => interval(500).pipe(tap(console.log)) )
+    // ).subscribe()
   }
 
   update(v) {

integration/functions/firebase-debug.log

@@ -383,3 +383,52 @@
 [info] >  [object Object]
 [debug] [2019-11-06T20:11:52.027Z] [runtime-status] Ephemeral server survived. {}
 [info] i  functions: Finished "testFun" in ~1s
+[info] Shutting down...
+[debug] [2019-11-07T04:01:12.571Z] ----------------------------------------------------------------------
+[debug] [2019-11-07T04:01:12.573Z] Command:       C:\Program Files\nodejs\node.exe C:\Program Files\nodejs\node_modules\firebase-tools\lib\bin\firebase.js serve --only functions
+[debug] [2019-11-07T04:01:12.573Z] CLI Version:   7.5.0
+[debug] [2019-11-07T04:01:12.573Z] Platform:      win32
+[debug] [2019-11-07T04:01:12.573Z] Node Version:  v10.16.0
+[debug] [2019-11-07T04:01:12.574Z] Time:          Wed Nov 06 2019 21:01:12 GMT-0700 (Mountain Standard Time)
+[debug] [2019-11-07T04:01:12.574Z] ----------------------------------------------------------------------
+[debug] 
+[debug] [2019-11-07T04:01:12.600Z] > command requires scopes: ["email","openid","https://www.googleapis.com/auth/cloudplatformprojects.readonly","https://www.googleapis.com/auth/firebase","https://www.googleapis.com/auth/cloud-platform"]
+[debug] [2019-11-07T04:01:12.600Z] > authorizing via signed-in user
+[debug] [2019-11-07T04:01:12.600Z] [iam] checking project geo-test-c92e4 for permissions ["firebase.projects.get"]
+[debug] [2019-11-07T04:01:12.601Z] > refreshing access token with scopes: ["email","https://www.googleapis.com/auth/cloud-platform","https://www.googleapis.com/auth/cloudplatformprojects.readonly","https://www.googleapis.com/auth/firebase","openid"]
+[debug] [2019-11-07T04:01:12.602Z] >>> HTTP REQUEST POST https://www.googleapis.com/oauth2/v3/token  
+ <request body omitted>
+[debug] [2019-11-07T04:01:12.847Z] <<< HTTP RESPONSE 200
+[debug] [2019-11-07T04:01:12.856Z] >>> HTTP REQUEST POST https://cloudresourcemanager.googleapis.com/v1/projects/geo-test-c92e4:testIamPermissions  
+
+[debug] [2019-11-07T04:01:13.276Z] <<< HTTP RESPONSE 200
+[debug] [2019-11-07T04:01:13.279Z] >>> HTTP REQUEST GET https://firebase.googleapis.com/v1beta1/projects/geo-test-c92e4  
+ 
+[debug] [2019-11-07T04:01:13.580Z] <<< HTTP RESPONSE 200
+[warn] !  Your functions directory does not specify a Node version.
+   - Learn more at https://firebase.google.com/docs/functions/manage-functions#set_runtime_options
+[info] +  functions: Emulator started at http://localhost:5000
+[info] i  functions: Watching "C:\Users\jeffd23\apps\geofirex\integration\functions" for Cloud Functions...
+[debug] [2019-11-07T04:01:16.402Z] [runtime-status] Functions runtime initialized. {"cwd":"C:\\Users\\jeffd23\\apps\\geofirex\\integration\\functions","node_version":"10.16.0"}
+[debug] [2019-11-07T04:01:16.403Z] [runtime-status] Disabled runtime features: {"functions_config_helper":true,"network_filtering":true,"timeout":true,"memory_limiting":true,"admin_stubs":true} {}
+[debug] [2019-11-07T04:01:16.408Z] [runtime-status] Resolved module firebase-admin {"declared":true,"installed":true,"version":"8.7.0","resolution":"C:\\Users\\jeffd23\\apps\\geofirex\\integration\\functions\\node_modules\\firebase-admin\\lib\\index.js"}
+[debug] [2019-11-07T04:01:16.414Z] [runtime-status] Resolved module firebase-functions {"declared":true,"installed":true,"version":"3.3.0","resolution":"C:\\Users\\jeffd23\\apps\\geofirex\\integration\\functions\\node_modules\\firebase-functions\\lib\\index.js"}
+[debug] [2019-11-07T04:01:16.415Z] [runtime-status] Resolved module firebase-functions {"declared":true,"installed":true,"version":"3.3.0","resolution":"C:\\Users\\jeffd23\\apps\\geofirex\\integration\\functions\\node_modules\\firebase-functions\\lib\\index.js"}
+[info] >  GeoFireClient {
+[info] >    app:
+[info] >     FirebaseNamespace {
+[info] >       __esModule: true,
+[info] >       credential:
+[info] >        { cert: [Function: cert],
+[info] >          refreshToken: [Function: refreshToken],
+[info] >          applicationDefault: [Function: applicationDefault] },
+[info] >       SDK_VERSION: '8.7.0',
+[info] >       Promise: [Function: Promise],
+[info] >       INTERNAL:
+[info] >        FirebaseNamespaceInternals {
+[info] >          firebase_: [Circular],
+[info] >          serviceFactories: {},
+[info] >          apps_: [Object],
+[info] >          appHooks_: {} },
+[info] >       default: [Circular] } }
+[info] +  functions[testFun]: http function initialized (http://localhost:5000/geo-test-c92e4/us-central1/testFun).

integration/src/app/app.module.ts

@@ -35,7 +35,7 @@ export const config = {
     }),
     AgmSnazzyInfoWindowModule,
     AngularFireModule.initializeApp(config),
-    AngularFirestoreModule
+    AngularFirestoreModule.enablePersistence()
   ],
   providers: [],
   bootstrap: [AppComponent]

spec/main.spec.ts

@@ -251,8 +251,9 @@ describe('RxGeofire', () => {
     test('should be ordered by distance', async done => {
       const first = data[0].queryMetadata.distance;
       const last = data[data.length - 1].queryMetadata.distance;
+      console.log(111111, data.length,last)
       expect(first).toBeCloseTo(0.2);
-      expect(last).toBeCloseTo(5);
+      expect(last).toBeGreaterThan(1);
       expect(first).toBeLessThan(last);
       done();
     });

src/collection.ts

@@ -1,7 +1,7 @@
 // import { firestore } from './interfaces';
 
-import { Observable, combineLatest } from 'rxjs';
-import { shareReplay, map, first } from 'rxjs/operators';
+import { Observable, combineLatest, Subject } from 'rxjs';
+import { shareReplay, map, first, tap, finalize, takeUntil } from 'rxjs/operators';
 import { GeoFirePoint } from './point';
 import { setPrecsion } from './util';
 import { FeatureCollection, Geometry } from 'geojson';
@@ -13,9 +13,10 @@ import { FirebaseSDK } from './interfaces';
 export type QueryFn = (ref: fb.firestore.CollectionReference) => fb.firestore.Query;
 
 export interface GeoQueryOptions {
-  units: 'km'
+  units?: 'km',
+  log?: boolean
 }
-const defaultOpts: GeoQueryOptions = { units: 'km' };
+const defaultOpts: GeoQueryOptions = { units: 'km', log: false };
 
 export interface QueryMetadata {
   bearing: number;
@@ -124,41 +125,70 @@ export class GeoFireCollectionRef<T = any> {
     center: GeoFirePoint,
     radius: number,
     field: string,
-    opts = defaultOpts
+    opts?: GeoQueryOptions
   ): Observable<(GeoQueryDocument & T)[]> {
+    opts = { ...defaultOpts, ...opts }
     const precision = setPrecsion(radius);
     const radiusBuffer = radius * 1.02; // buffer for edge distances
     const centerHash = center.hash().substr(0, precision);
     const area = neighbors(centerHash).concat(centerHash);
 
+    // Used to cancel the individual geohash subscriptions
+    const complete = new Subject();
+
+    // Map geohash neighbors to individual queries
     const queries = area.map(hash => {
       const query = this.queryPoint(hash, field);
-      return createStream(query).pipe(snapToData());
+      return createStream(query).pipe(
+        snapToData(),
+        takeUntil(complete),
+      );
     });
 
+    const tick = Date.now();
+
+
+
     const combo = combineLatest(...queries).pipe(
       map(arr => {
         const reduced = arr.reduce((acc, cur) => acc.concat(cur));
-        return reduced
+        
+        const filtered = reduced
           .filter(val => {
-            const lat = val[field].geopoint.latitude;
-            const lng = val[field].geopoint.longitude;
-            return center.distance(lat, lng) <= radiusBuffer;
+
+            const { latitude, longitude } = val[field].geopoint;
+            return center.distance(latitude, longitude) <= radiusBuffer;
           })
 
-          .map(val => {
-            const lat = val[field].geopoint.latitude;
-            const lng = val[field].geopoint.longitude;
+          if (opts.log) { 
+            console.group('GeoFireX Query');
+            console.log('💡 Logs update on every change to the query');
+            console.log(`🌐 Center ${center.coords()}. Radius ${radius}`)
+            // const cached = reduced.reduce((a, c) => a + (c.fromCache ? 1 : 0), 0);
+            console.log(`📍 Hits: ${reduced.length}.`) //Cached ${cached}
+            console.log(`⌚ Elapsed time: ${Date.now() - tick}ms`);
+            console.log(`🟢 Within Radius: ${filtered.length}`);
+            console.groupEnd();
+          }
+
+          return filtered.map(val => {
+
+            const { latitude, longitude } = val[field].geopoint;
+            
             const queryMetadata = {
-              distance: center.distance(lat, lng),
-              bearing: center.bearing(lat, lng)
+              distance: center.distance(latitude, longitude),
+              bearing: center.bearing(latitude, longitude),
             };
             return { ...val, queryMetadata } as (GeoQueryDocument & T);
           })
 
           .sort((a, b) => a.queryMetadata.distance - b.queryMetadata.distance);
       }),
-      shareReplay(1)
+      shareReplay(1),
+      finalize(() => { 
+        opts.log && console.log('✋ Query complete');
+        complete.next(true)
+      })
     );
 
     return combo;
@@ -184,14 +214,16 @@ export class GeoFireCollectionRef<T = any> {
   // findFirst() {
   //   return 'not implemented';
   // }
+
 }
 
+
 function snapToData(id = 'id') {
   return map((querySnapshot: fb.firestore.QuerySnapshot) =>
     querySnapshot.docs.map(v => {
       return {
         ...(id ? { [id]: v.id } : null),
-        ...v.data()
+        ...v.data(),
       };
     })
   );
@@ -202,9 +234,13 @@ internal, do not use
  */
 function createStream(input): Observable<any> {
   return new Observable(observer => {
-    const unsubscribe = input.onSnapshot((val) => observer.next(val), err => observer.error(err));
+    const unsubscribe = input.onSnapshot(
+       (val) => observer.next(val), 
+       err => observer.error(err),
+      );
     return { unsubscribe };
   });
+  // return bindCallback(input.onSnapshot.bind(input.onSnapshot))();
 }
 /**
  * RxJS operator that converts a collection to a GeoJSON FeatureCollection