@wemap/providers 10.0.0-alpha.11 → 10.0.0-alpha.13

package/package.json

@@ -42,6 +42,6 @@
     "url": "git+https://github.com/wemap/wemap-modules-js.git"
   },
   "type": "module",
-  "version": "10.0.0-alpha.11",
-  "gitHead": "51207f18c96fb4693c7719c6dcb0d73642d6ebb2"
+  "version": "10.0.0-alpha.13",
+  "gitHead": "3923469dae09f868af8c0ccb18b82db6282235cc"
 }

package/src/errors/MissingNativeInterfaceError.js

@@ -1,6 +1,7 @@
 class MissingNativeInterfaceError extends Error {
 
-    static DEFAULT_MESSAGE = 'Native interface is missing';
+    static DEFAULT_MESSAGE = 'Native interface is missing. You are maybe trying to '
+        + 'execute a code which is not available in a web browser';
 
     constructor(message) {
         super(message || MissingNativeInterfaceError.DEFAULT_MESSAGE);

package/src/events/AvailabilityHelper.js

@@ -0,0 +1,26 @@
+export default class AvailabilityHelper {
+
+    static async every(availabilityPromises) {
+        for (const aPr of availabilityPromises) {
+            const error = await aPr;
+            if (error) {
+                return error;
+            }
+        }
+        return null;
+    }
+
+    static async some(availabilityPromises) {
+        let firstError;
+        for (const aPr of availabilityPromises) {
+            const error = await aPr;
+            if (!error) {
+                return null;
+            } else if (!firstError) {
+                firstError = error;
+            }
+        }
+        return firstError || null;
+    }
+
+}

package/src/events/AvailabilityHelper.spec.js

@@ -0,0 +1,30 @@
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import AvailabilityHelper from './AvailabilityHelper.js';
+
+chai.use(chaiAsPromised);
+const { expect } = chai;
+
+const availabilityOk = Promise.resolve();
+const availabilityFail1 = Promise.resolve('Reason 1.');
+const availabilityFail2 = Promise.resolve('Reason 2.');
+
+describe('AvailabilityHelper', () => {
+
+    it('every', async () => {
+        expect(await AvailabilityHelper.every([availabilityOk, availabilityOk])).is.equal(null);
+        expect(await AvailabilityHelper.every([availabilityOk, availabilityFail1])).is.equal('Reason 1.');
+        expect(await AvailabilityHelper.every([availabilityFail1, availabilityOk])).is.equal('Reason 1.');
+        expect(await AvailabilityHelper.every([availabilityFail1, availabilityFail2])).is.equal('Reason 1.');
+        expect(await AvailabilityHelper.every([availabilityFail2, availabilityFail1])).is.equal('Reason 2.');
+    });
+
+    it('some', async () => {
+        expect(await AvailabilityHelper.some([availabilityOk, availabilityOk])).is.equal(null);
+        expect(await AvailabilityHelper.some([availabilityOk, availabilityFail1])).is.equal(null);
+        expect(await AvailabilityHelper.some([availabilityFail1, availabilityOk])).is.equal(null);
+        expect(await AvailabilityHelper.some([availabilityFail1, availabilityFail2])).is.equal('Reason 1.');
+        expect(await AvailabilityHelper.some([availabilityFail2, availabilityFail1])).is.equal('Reason 2.');
+    });
+});

package/src/mapmatching/MapMatchingHandler.js

@@ -115,6 +115,13 @@ class MapMatchingHandler extends Provider {
         this._mapMatching.maxAngleBearing = MapMatchingHandler.DEFAULT_MM_MAX_ANGLE;
     }
 
+    /**
+    * @override
+    */
+    static get pname() {
+        return 'MapMatchingHandler';
+    }
+
     /**
      * @override
      */

package/src/providers/FakeProvider.spec.js

@@ -16,7 +16,7 @@ class FakeProvider2Clazz extends Provider {
         return 'FakeProvider2';
     }
     get _availability() {
-        return Promise.reject(new Error());
+        return Promise.resolve(new Error());
     }
     start() { }
     stop() { }

package/src/providers/Provider.js

@@ -69,11 +69,12 @@ class Provider {
     }
 
     /**
-     * @type {Promise} returns an availability promise
+     * @type {Promise<Error?>} returns an availability promise
+     * Resolve with an error if the provider is not available
      */
     get availability() {
         if (ProvidersOptions.ignoreProviders.includes(this.pname)) {
-            return Promise.reject(new ContainsIgnoredProviderError());
+            return Promise.resolve(new ContainsIgnoredProviderError());
         }
 
         return this._availability;
@@ -182,11 +183,10 @@ class Provider {
         }
 
         (async () => {
-            try {
-                await availabilityPromise;
-            } catch (e) {
+            const error = await availabilityPromise;
+            if (error) {
                 this.state = ProviderState.STOPPED;
-                this.notifyError(e);
+                this.notifyError(error);
                 return;
             }
 

package/src/providers/Provider.spec.js

@@ -37,15 +37,15 @@ describe('Provider', () => {
 
     it('availability', async () => {
 
-        await expect(FakeProvider1.availability).to.be.fulfilled;
+        expect(FakeProvider1.availability).to.be.fulfilled;
         ProvidersOptions.ignoreProviders.push(FakeProvider1.pname);
-        await expect(FakeProvider1.availability).to.be.rejectedWith(ContainsIgnoredProviderError);
+        expect(await FakeProvider1.availability).is.instanceOf(ContainsIgnoredProviderError);
         ProvidersOptions.ignoreProviders = [];
 
-        await expect(FakeProvider2.availability).to.be.rejectedWith(Error);
+        expect(await FakeProvider2.availability).is.instanceOf(Error);
 
-        await expect(FakeProvider3.availability).to.be.fulfilled;
-        await expect(FakeProvider4.availability).to.be.fulfilled;
+        expect(FakeProvider3.availability).to.be.fulfilled;
+        expect(FakeProvider4.availability).to.be.fulfilled;
     });
 
     it('checkAvailability on start', async () => {

package/src/providers/attitude/absolute/AbsoluteAttitude.js

@@ -1,7 +1,6 @@
 /* eslint-disable max-statements */
 import { AbsoluteHeading, Attitude } from '@wemap/geo';
 import { deg2rad, diffAngle, Quaternion } from '@wemap/maths';
-import { PromiseUtils } from '@wemap/utils';
 
 import Provider from '../../Provider.js';
 import EventType from '../../../events/EventType.js';
@@ -12,6 +11,7 @@ import ProviderEvent from '../../../events/ProviderEvent.js';
 import HighRotationsDetector from '../../imu/HighRotationsDetector.js';
 import ProvidersOptions from '../../../ProvidersOptions.js';
 import Vps from '../../vision/vps/Vps.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 /**
  * Absolute attitude provider gives the device attitude in East-North-Up (ENU) frame
@@ -81,7 +81,7 @@ class AbsoluteAttitude extends Provider {
      * @override
      */
     get _availability() {
-        return PromiseUtils.any([
+        return AvailabilityHelper.some([
             AbsoluteAttitudeFromBrowser.availability,
             RelativeAttitude.availability
         ]);

package/src/providers/attitude/absolute/AbsoluteAttitudeFromBrowser.js

@@ -62,7 +62,7 @@ class AbsoluteAttitudeFromBrowser extends Provider {
     get _availability() {
         return BrowserUtils.isMobile
             ? Promise.resolve()
-            : Promise.reject(new AskImuOnDesktopError());
+            : Promise.resolve(new AskImuOnDesktopError());
     }
 
     /**

package/src/providers/attitude/relative/RelativeAttitudeFromBrowser.js

@@ -46,7 +46,7 @@ class RelativeAttitudeFromBrowser extends Provider {
     get _availability() {
         return BrowserUtils.isMobile
             ? Promise.resolve()
-            : Promise.reject(new AskImuOnDesktopError());
+            : Promise.resolve(new AskImuOnDesktopError());
     }
 
     /**

package/src/providers/attitude/relative/RelativeAttitudeFromEkf.js

@@ -7,6 +7,7 @@ import RelativeAttitudeFromInertial from './RelativeAttitudeFromInertial.js';
 
 import Accelerometer from '../../imu/Accelerometer.js';
 import Gyroscope from '../../imu/Gyroscope.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 
 /**
@@ -44,7 +45,7 @@ class RelativeAttitudeFromEkf extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability
         ]);

package/src/providers/attitude/relative/RelativeAttitudeFromInertial.js

@@ -1,6 +1,5 @@
 import { Attitude } from '@wemap/geo';
 import { deg2rad } from '@wemap/maths';
-import { PromiseUtils } from '@wemap/utils';
 
 import Provider from '../../Provider.js';
 import ProviderEvent from '../../../events/ProviderEvent.js';
@@ -8,6 +7,7 @@ import EventType from '../../../events/EventType.js';
 import RelativeAttitudeFromEkf from './RelativeAttitudeFromEkf.js';
 import RelativeAttitudeFromBrowser from './RelativeAttitudeFromBrowser.js';
 import HighRotationsDetector from '../../imu/HighRotationsDetector.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 
 class RelativeAttitudeFromInertial extends Provider {
@@ -36,10 +36,9 @@ class RelativeAttitudeFromInertial extends Provider {
      * @override
      */
     get _availability() {
-        return PromiseUtils.any([
+        return AvailabilityHelper.some([
             RelativeAttitudeFromEkf.availability,
-            RelativeAttitudeFromBrowser.availability,
-            HighRotationsDetector.availability
+            RelativeAttitudeFromBrowser.availability
         ]);
     }
 
@@ -49,9 +48,9 @@ class RelativeAttitudeFromInertial extends Provider {
     start() {
 
         RelativeAttitudeFromEkf.availability
-            .then(() => (this.provider = RelativeAttitudeFromEkf))
-            .catch(() => (this.provider = RelativeAttitudeFromBrowser))
-            .finally(() => {
+            .then(availabilityError => {
+                this.provider = !availabilityError ? RelativeAttitudeFromEkf : RelativeAttitudeFromBrowser;
+
                 this.listenerId = this.provider.addEventListener(
                     events => this._parseEvent(events[0]),
                     error => this.notifyError(error)

package/src/providers/imu/Imu.js

@@ -44,7 +44,7 @@ class Imu extends Provider {
     get _availability() {
         return BrowserUtils.isMobile
             ? Promise.resolve()
-            : Promise.reject(new AskImuOnDesktopError());
+            : Promise.resolve(new AskImuOnDesktopError());
     }
 
     /**

package/src/providers/inclination/Inclination.js

@@ -1,9 +1,8 @@
-import { PromiseUtils } from '@wemap/utils';
-
 import Provider from '../Provider.js';
 import EventType from '../../events/EventType.js';
 import InclinationFromAcc from './InclinationFromAcc.js';
 import InclinationFromRelativeAttitude from './InclinationFromRelativeAttitude.js';
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 
 /**
  * Inclination provider gives the inclination of the device using Imu Sensor
@@ -31,7 +30,7 @@ class Inclination extends Provider {
      * @override
      */
     get _availability() {
-        return PromiseUtils.any([
+        return AvailabilityHelper.some([
             InclinationFromAcc.availability,
             InclinationFromRelativeAttitude.availability
         ]);

package/src/providers/others/CameraNative.js

@@ -23,10 +23,11 @@ class CameraNative extends Provider {
      * @override
      */
     get _availability() {
-        return new Promise((resolve, reject) => {
-            ArCore.availability
-                .then(output => resolve(output))
-                .catch(() => reject('Providers will not use the camera.'));
+        return new Promise(async resolve => {
+            resolve(await ArCore.availability
+                ? new Error('Providers will not use the camera.')
+                : null
+            );
         });
     }
 

package/src/providers/position/absolute/AbsolutePosition.js

@@ -1,5 +1,5 @@
 import { UserPosition, GeoRelativePosition, Level } from '@wemap/geo';
-import { PromiseUtils, TimeUtils } from '@wemap/utils';
+import { TimeUtils } from '@wemap/utils';
 
 import Provider from '../../Provider.js';
 import EventType from '../../../events/EventType.js';
@@ -11,6 +11,7 @@ import ProvidersOptions from '../../../ProvidersOptions.js';
 import ProviderState from '../../ProviderState.js';
 import Vps from '../../vision/vps/Vps.js';
 import PoleStar from './PoleStar.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 class AbsolutePosition extends Provider {
 
@@ -64,7 +65,7 @@ class AbsolutePosition extends Provider {
         if (ProvidersOptions.hasVps) {
             providersToCheck.push(Vps.availability);
         }
-        return PromiseUtils.any(providersToCheck);
+        return AvailabilityHelper.some(providersToCheck);
     }
 
 
@@ -73,16 +74,16 @@ class AbsolutePosition extends Provider {
      */
     start() {
         GeoRelativePositionProvider.availability
-            .then(() => {
-                this._relativePositionProviderId = GeoRelativePositionProvider.addEventListener(
-                    events => this._onRelativePosition(events[0])
-                );
-            })
-            .catch(() => {
-                // do nothing
+            .then((error) => {
+                if (!error) {
+                    this._relativePositionProviderId = GeoRelativePositionProvider.addEventListener(
+                        events => this._onRelativePosition(events[0])
+                    );
+                } else {
+                    // do nothing
+                }
             });
 
-
         // GnssWifi
         this._gnssWifiProviderId = GnssWifi.addEventListener(
             events => {

package/src/providers/position/absolute/GnssWifi.js

@@ -45,7 +45,7 @@ class GnssWifi extends Provider {
     get _availability() {
         return typeof (navigator) === 'object' && navigator.geolocation
             ? Promise.resolve()
-            : Promise.reject(new GeolocationApiMissingError());
+            : Promise.resolve(new GeolocationApiMissingError());
     }
 
     /**

package/src/providers/position/absolute/PoleStar.js

@@ -71,10 +71,12 @@ class PoleStar extends Provider {
      * @override
      */
     get _availability() {
-        return new Promise((resolve) => {
+        try {
             this.nativeProvider.checkAvailability();
-            resolve();
-        });
+            return Promise.resolve();
+        } catch (e) {
+            return Promise.resolve(e);
+        }
     }
 
     addMethodsToNativeJsProvider() {

package/src/providers/position/relative/GeoRelativePosition.js

@@ -1,9 +1,8 @@
-import { PromiseUtils } from '@wemap/utils';
-
 import Provider from '../../Provider.js';
 import EventType from '../../../events/EventType.js';
 import GeoRelativePositionFromArCore from './GeoRelativePositionFromArCore.js';
 import Pdr from './Pdr.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 
 class GeoRelativePosition extends Provider {
@@ -26,7 +25,7 @@ class GeoRelativePosition extends Provider {
      * @override
      */
     get _availability() {
-        return PromiseUtils.any([
+        return AvailabilityHelper.some([
             Pdr.availability,
             GeoRelativePositionFromArCore.availability
         ]);
@@ -39,9 +38,8 @@ class GeoRelativePosition extends Provider {
     start() {
 
         GeoRelativePositionFromArCore.availability
-            .then(() => (this.geoRelativeProvider = GeoRelativePositionFromArCore))
-            .catch(() => (this.geoRelativeProvider = Pdr))
-            .finally(() => {
+            .then(availabilityError => {
+                this.geoRelativeProvider = availabilityError ? Pdr : GeoRelativePositionFromArCore;
                 this.providerId = this.geoRelativeProvider.addEventListener(
                     events => {
                         const event = events.find(_event => _event.dataType === EventType.GeoRelativePosition);

package/src/providers/position/relative/GeoRelativePositionFromArCore.js

@@ -1,4 +1,5 @@
 import { GeoRelativePosition } from '@wemap/geo';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 import EventType from '../../../events/EventType.js';
 import AbsoluteAttitude from '../../attitude/absolute/AbsoluteAttitude.js';
@@ -18,7 +19,10 @@ class GeoRelativePositionFromArCore extends Provider {
      * @override
      */
     get _availability() {
-        return ArCore.availability;
+        return AvailabilityHelper.every([
+            ArCore.availability,
+            AbsoluteAttitude.availability
+        ]);
     }
 
     /**

package/src/providers/position/relative/Pdr.js

@@ -5,6 +5,7 @@ import Provider from '../../Provider.js';
 import EventType from '../../../events/EventType.js';
 import StepDetector from '../../steps/StepDetector.js';
 import AbsoluteAttitude from '../../attitude/absolute/AbsoluteAttitude.js';
+import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
 
 class Pdr extends Provider {
@@ -31,7 +32,7 @@ class Pdr extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             StepDetector.availability,
             AbsoluteAttitude.availability
         ]);

package/src/providers/steps/StepDetector.js

@@ -1,6 +1,7 @@
 import { Constants as GeoConstants } from '@wemap/geo';
 import { Quaternion } from '@wemap/maths';
 
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import EventType from '../../events/EventType.js';
 import RelativeAttitudeFromInertial from '../attitude/relative/RelativeAttitudeFromInertial.js';
 import Accelerometer from '../imu/Accelerometer.js';
@@ -43,7 +44,7 @@ class StepDetector extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability,
             RelativeAttitudeFromInertial.availability

package/src/providers/steps/StepDetectorLadetto.js

@@ -1,6 +1,7 @@
 import { Constants as GeoConstants } from '@wemap/geo';
 import { Quaternion } from '@wemap/maths';
 
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import EventType from '../../events/EventType.js';
 import RelativeAttitudeFromInertial from '../attitude/relative/RelativeAttitudeFromInertial.js';
 import Accelerometer from '../imu/Accelerometer.js';
@@ -27,7 +28,7 @@ class StepDetectorLadetto extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability,
             RelativeAttitudeFromInertial.availability

package/src/providers/steps/StepDetectorMinMaxPeaks.js

@@ -1,6 +1,7 @@
 import { Constants as GeoConstants } from '@wemap/geo';
 import { Quaternion } from '@wemap/maths';
 
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import EventType from '../../events/EventType.js';
 import RelativeAttitudeFromInertial from '../attitude/relative/RelativeAttitudeFromInertial.js';
 import Accelerometer from '../imu/Accelerometer.js';
@@ -27,7 +28,7 @@ class StepDetectorMinMaxPeaks extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability,
             RelativeAttitudeFromInertial.availability

package/src/providers/steps/StepDetectorMinMaxPeaks2.js

@@ -1,6 +1,7 @@
 import { Constants as GeoConstants } from '@wemap/geo';
 import { Quaternion } from '@wemap/maths';
 
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import EventType from '../../events/EventType.js';
 import RelativeAttitudeFromInertial from '../attitude/relative/RelativeAttitudeFromInertial.js';
 import Accelerometer from '../imu/Accelerometer.js';
@@ -27,7 +28,7 @@ class StepDetectorMinMaxPeaks2 extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability,
             RelativeAttitudeFromInertial.availability

package/src/providers/steps/StepDetectorMinMaxPeaks3.js

@@ -1,6 +1,7 @@
 import { Constants as GeoConstants } from '@wemap/geo';
 import { Quaternion } from '@wemap/maths';
 
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import EventType from '../../events/EventType.js';
 import RelativeAttitudeFromInertial from '../attitude/relative/RelativeAttitudeFromInertial.js';
 import Accelerometer from '../imu/Accelerometer.js';
@@ -27,7 +28,7 @@ class StepDetectorMinMaxPeaks3 extends Provider {
      * @override
      */
     get _availability() {
-        return Promise.all([
+        return AvailabilityHelper.every([
             Accelerometer.availability,
             Gyroscope.availability,
             RelativeAttitudeFromInertial.availability

package/src/providers/steps/StraightLineDetector.js

@@ -1,3 +1,4 @@
+import AvailabilityHelper from '../../events/AvailabilityHelper.js';
 import Provider from '../Provider.js';
 import StepDetector from './StepDetector.js';
 import TurnDectector from '../attitude/TurnDectector.js';
@@ -27,6 +28,16 @@ class StraightLineDetector extends Provider {
         return 'StraightLineDetector';
     }
 
+    /**
+     * @override
+     */
+    get _availability() {
+        return AvailabilityHelper.every([
+            TurnDectector.availability,
+            StepDetector.availability
+        ]);
+    }
+
     /**
      * @override
      */

package/src/providers/vision/ArCore.js

@@ -162,11 +162,11 @@ class ArCore extends Provider {
             const nativeProvider = this.nativeProvider;
 
             if (!nativeProvider.checkAvailability()) {
-                return Promise.reject(new MissingArCoreError());
+                return Promise.resolve(new MissingArCoreError());
             }
 
         } catch (e) {
-            return Promise.reject(e);
+            return Promise.resolve(e);
         }
 
         return Promise.resolve();