pryv 2.3.5 → 2.3.7

package/README.md

@@ -696,6 +696,20 @@ just test <component> [...params]
 - Extra parameters at the end are passed on to [Mocha](https://mochajs.org/) (default settings are defined in `.mocharc.js` files)
 - Replace `test` with `test-debug`, `test-cover` for common presets
 
+By default, tests are run against [Pryv Lab](https://www.pryv.com/pryvlab/) with service information URL `https://reg.pryv.me/service/info`.
+
+To run the tests against another Pryv.io platform, set the `TEST_PRYVLIB_SERVICEINFO_URL` environment variable; for example:
+
+```bash
+TEST_PRYVLIB_SERVICEINFO_URL="https://reg.${DOMAIN}/service/info" just test all
+```
+
+To run the tests against _in-development_ API server components (e.g. open-source or Entreprise), set `TEST_PRYVLIB_DNSLESS_URL`; for example:
+
+```bash
+TEST_PRYVLIB_DNSLESS_URL="http://l.rec.la:3000/ just test all
+```
+
 #### Browser
 
 Assuming browser files have been built (see above):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "2.3.5",
+  "version": "2.3.7",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",

package/src/Connection.js

@@ -292,8 +292,8 @@ class Connection {
   }
 
   /**
-   * Difference in second between the API and locatime
-   * deltaTime is refined at each (non Raw) API call
+   * Difference in seconds between the Pryv.io API and local time
+   * deltaTime is refined at each (non-raw) API call
    * @readonly
    * @property {number} deltaTime
    */
@@ -302,7 +302,7 @@ class Connection {
   }
 
   /**
-   * API Endpoint of this connection
+   * API endpoint of this connection
    * @readonly
    * @property {APIEndpoint} deltaTime
    */

package/src/Service.js

@@ -68,6 +68,25 @@ class Service {
     return this._serviceInfo;
   }
 
+  /**
+   * Check if a service supports High Frequency Data Sets
+   * @return true if yes
+   */
+  async supportsHF () {
+    const infos = await this.info();
+    return (infos.features == null || infos.features.noHF !== true);
+  }
+
+  /**
+   * Check if a service has username in the hostname or in the path of the api
+   * @return true if the service does not rely on DNS to find a host related to a username
+   */
+  async isDnsLess () {
+    const infos = await this.info();
+    const hostname = infos.api.split('/')[2];
+    return !hostname.includes('{username}');
+  }
+
   /**
    * @private
    * @param {ServiceInfo} serviceInfo
@@ -114,7 +133,7 @@ class Service {
   }
 
   /**
-   * Return an API Endpoint from a username and token
+   * Return an API endpoint from a username and token
    * @param {string} username
    * @param {string} [token]
    * @return {APIEndpoint}
@@ -125,7 +144,7 @@ class Service {
   }
 
   /**
-   * Return an API Endpoint from a username and token and a ServiceInfo.
+   * Return an API endpoint from a username and token and a ServiceInfo.
    * This is method is rarely used. See **apiEndpointFor** as an alternative.
    * @param {ServiceInfo} serviceInfo
    * @param {string} username

package/src/ServiceAssets.js

@@ -36,7 +36,7 @@ class ServiceAssets {
 
   /**
    * get a value from path separated by `:`
-   * exemple of key `lib-js:buttonSignIn`
+   * example of key `lib-js:buttonSignIn`
    * @param {string} [keyPath] if null, will return the all assets
    */
   get (keyPath) {
@@ -53,7 +53,7 @@ class ServiceAssets {
   /**
    * get an Url from path separated by `:`
    * identical to doing assets.relativeURL(assets.get(keyPath))
-   * exemple of key `lib-js:buttonSignIn`
+   * example of key `lib-js:buttonSignIn`
    * @param {string} [keyPath] if null, will return the all assets
    */
   getUrl (keyPath) {

package/src/index.js

@@ -8,7 +8,7 @@
  * @property {pryv.Service} Service - To interact with Pryv.io at a "Platform level"
  * @property {pryv.Connection} Connection - To interact with an individual's (user) data set
  * @property {pryv.Browser} Browser - Browser Tools - Access request helpers and visuals (button)
- * @property {pryv.utils} utils - Exposes **superagent** for HTTP calls and tools to manipulate Pryv's API Endpoints
+ * @property {pryv.utils} utils - Exposes **superagent** for HTTP calls and tools to manipulate Pryv's API endpoints
  */
 module.exports = {
   Service: require('./Service'),

package/test/Connection.test.js

@@ -2,11 +2,12 @@
  * @license
  * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
  */
-/* global describe, it, xit, before, after, beforeEach, afterEach, expect, Browser, pryv, testData, Blob, FormData */
+/* global describe, it, xit, before, after, beforeEach, afterEach, expect, Browser, pryv, Blob, FormData */
 /* eslint-disable no-unused-expressions */
 
 const { URL, URLSearchParams } = require('universal-url');
 const cuid = require('cuid');
+const testData = require('../../../test/test-data');
 
 let conn = null;
 
@@ -261,7 +262,13 @@ describe('Connection', () => {
     });
   });
 
-  describe('HF events', () => {
+  describe('HF events', async function () {
+    before(async function () {
+      if (!await conn.service.supportsHF()) {
+        this.skip();
+      }
+    });
+
     it('Add data points to HF event', async () => {
       const res = await conn.api([{
         method: 'events.create',
@@ -302,8 +309,10 @@ describe('Connection', () => {
 
   describe('API', () => {
     it('endpoint property', async () => {
+      const [protocol, hostPath] = testData.serviceInfo.api.split('://');
+      const challenge = protocol + '://' + conn.token + '@' + hostPath.replace('{username}', testData.username);
       const apiEndpoint = conn.apiEndpoint;
-      expect(apiEndpoint.startsWith('https://' + conn.token + '@')).to.be.true;
+      expect(apiEndpoint).to.equal(challenge);
     });
   });
 

package/test/Service.test.js

@@ -5,6 +5,8 @@
 /* global describe, it, before, expect, pryv, testData */
 /* eslint-disable no-unused-expressions */
 
+const isNode = (typeof window === 'undefined');
+
 describe('Service', function () {
   before(async function () {
     this.timeout(5000);
@@ -75,7 +77,19 @@ describe('Service', function () {
     it('login() failed on wrong username', async function () {
       this.timeout(5000);
       const pryvService = new pryv.Service(testData.serviceInfoUrl);
-      await expect(pryvService.login('wrong-username', 'bobby', 'jslib-test')).to.be.rejectedWith('getaddrinfo ENOTFOUND wrong');
+      // check if username is in path or domain
+      try {
+        await pryvService.login('wrong-username', 'bobby', 'jslib-test');
+      } catch (error) {
+        let errorMessage = isNode ? 'getaddrinfo ENOTFOUND wrong' : 'Request has been terminated';
+        if (await pryvService.isDnsLess()) {
+          errorMessage = 'Unknown user "wrong-username"';
+        }
+        const receivedMessage = error.message.slice(0, errorMessage.length);
+        expect(receivedMessage).to.be.equal(errorMessage);
+        return;
+      }
+      throw new Error('Should fail');
     });
   });
 });