Add custom request and watch

Author: igorkamyshev

packages/web-api/src/geolocation.test.ts

@@ -0,0 +1,106 @@
+/*
+ * This file contains tests only for custom geolocation providers.
+ * e2e-tests for built-in browser navigator.geolocation in apps/web-api-demo/test/geolocation.spec.ts
+ */
+
+import { allSettled, createStore, fork } from 'effector';
+import { trackGeolocation } from 'geolocation';
+import { describe, expect, test } from 'vitest';
+
+describe('trackGeolocation', () => {
+  test('request', async () => {
+    let lat = 41.890221;
+    let lon = 12.492348;
+    const myCustomProvider = () => ({
+      async getCurrentPosition() {
+        return {
+          coords: { latitude: lat, longitude: lon },
+          timestamp: Date.now(),
+        };
+      },
+      watchPosition(success: any, error: any) {
+        return () => {};
+      },
+    });
+
+    const geo = trackGeolocation({ providers: [myCustomProvider] });
+
+    const scope = fork();
+
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`null`);
+
+    await allSettled(geo.request, { scope });
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`
+      {
+        "latitude": 41.890221,
+        "longitude": 12.492348,
+      }
+    `);
+
+    lat = 42.890221;
+    lon = 13.492348;
+
+    await allSettled(geo.request, { scope });
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`
+      {
+        "latitude": 42.890221,
+        "longitude": 13.492348,
+      }
+    `);
+  });
+
+  test('watching', async () => {
+    const $externalLocation: any = createStore({
+      latitude: 41.890221,
+      longitude: 12.492348,
+    });
+
+    const myCustomProvider = () => ({
+      async getCurrentPosition() {
+        return {
+          coords: $externalLocation.getState(),
+          timestamp: Date.now(),
+        };
+      },
+      watchPosition(success: any, error: any) {
+        return $externalLocation.watch((location: any) =>
+          success({
+            coords: location,
+            timestamp: Date.now(),
+          })
+        );
+      },
+    });
+
+    const geo = trackGeolocation({ providers: [myCustomProvider] });
+
+    const scope = fork();
+
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`null`);
+
+    await allSettled(geo.watching.start, { scope });
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`
+      {
+        "latitude": 41.890221,
+        "longitude": 12.492348,
+      }
+    `);
+
+    $externalLocation.setState({ latitude: 42.890221, longitude: 13.492348 });
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`
+      {
+        "latitude": 42.890221,
+        "longitude": 13.492348,
+      }
+    `);
+
+    await allSettled(geo.watching.stop, { scope });
+    $externalLocation.setState({ latitude: 43.890221, longitude: 14.492348 });
+    expect(scope.getState(geo.$location)).toMatchInlineSnapshot(`
+      {
+        "latitude": 42.890221,
+        "longitude": 13.492348,
+      }
+    `);
+  });
+});

packages/web-api/src/geolocation.ts

@@ -7,7 +7,6 @@ import {
   createStore,
   createEffect,
   sample,
-  restore,
   attach,
   scopeBind,
 } from 'effector';
@@ -53,7 +52,7 @@ type Unsubscribe = () => void;
 
 type CustomProvider = (params: GeolocationParams) => {
   getCurrentPosition: () => Promise<CustomGeolocationPosition>;
-  watchPosition?: (
+  watchPosition: (
     successCallback: (position: CustomGeolocationPosition) => void,
     errorCallback: (error: CustomGeolocationError) => void
   ) => Unsubscribe;
@@ -139,14 +138,19 @@ export function trackGeolocation(
     CustomGeolocationPosition | globalThis.GeolocationPosition,
     CustomGeolocationError | globalThis.GeolocationPositionError
   >(async () => {
-    let geolocation: GeolocationPosition | null = null;
+    let geolocation:
+      | globalThis.GeolocationPosition
+      | CustomGeolocationPosition
+      | null = null;
 
     for (const provider of providres) {
       if (isDefaultProvider(provider)) {
         geolocation = await new Promise<GeolocationPosition>(
           (resolve, rejest) =>
             provider.getCurrentPosition(resolve, rejest, params)
         );
+      } else {
+        geolocation = await provider(params).getCurrentPosition();
       }
     }
 
@@ -175,7 +179,8 @@ export function trackGeolocation(
     const boundNewPosition = scopeBind(newPosition, { safe: true });
     const boundFailed = scopeBind(failed, { safe: true });
 
-    const unwatchMap = new Map<(id: number) => void, number>();
+    const defaultUnwatchMap = new Map<(id: number) => void, number>();
+    const customUnwatchSet = new Set<Unsubscribe>();
 
     for (const provider of providres) {
       if (isDefaultProvider(provider)) {
@@ -185,14 +190,26 @@ export function trackGeolocation(
           params
         );
 
-        unwatchMap.set((id: number) => provider.clearWatch(id), watchId);
+        defaultUnwatchMap.set((id: number) => provider.clearWatch(id), watchId);
+      } else {
+        const unwatch = provider(params).watchPosition(
+          boundNewPosition,
+          boundFailed
+        );
+
+        customUnwatchSet.add(unwatch);
       }
     }
 
     return () => {
-      for (const [unwatch, id] of unwatchMap) {
+      for (const [unwatch, id] of defaultUnwatchMap) {
         unwatch(id);
-        unwatchMap.delete(unwatch);
+        defaultUnwatchMap.delete(unwatch);
+      }
+
+      for (const unwatch of customUnwatchSet) {
+        unwatch();
+        customUnwatchSet.delete(unwatch);
       }
     };
   });