Adding more tests for application

Author: perki

docs/hds-lib.js

@@ -21173,7 +21173,7 @@ async function createAppStreams (app) {
     }
     if (!masterFound) { // check that app has "manage" level on baseStreamId
       const baseStreamFound = infos.permissions.find(p => (p.streamId === app.baseStreamId && p.level === 'manage'));
-      if (!baseStreamFound) throw new Error(`Application with "app" type of access requires  (streamId = '${app.baseStreamId}', level = "manage") or master access`);
+      if (!baseStreamFound) throw new Error(`Application with "app" type of access requires  (streamId = "${app.baseStreamId}", level = "manage") or master access`);
     }
   }
   // get streamStructure
@@ -21188,9 +21188,6 @@ async function createAppStreams (app) {
   }
   // not found create streams
   if (!found) {
-    if (app.appName == null) {
-      throw new Error('Cannot create app stream if not "appName" has been given');
-    }
     if (!isPersonalOrMaster) {
       throw new Error('Token has not sufficient right to create App streams. Create them upfront');
     }
@@ -22430,6 +22427,129 @@ function deepFreeze (object) {
 }
 
 
+/***/ }),
+
+/***/ "./tests/applicationClass.test.js":
+/*!****************************************!*\
+  !*** ./tests/applicationClass.test.js ***!
+  \****************************************/
+/***/ ((__unused_webpack_module, __unused_webpack_exports, __webpack_require__) => {
+
+/* eslint-env mocha */
+const { assert } = __webpack_require__(/*! ./test-utils/deps-node */ "./tests/test-utils/deps-browser.js");
+const { createUserAndPermissions } = __webpack_require__(/*! ./test-utils/pryvService */ "./tests/test-utils/pryvService.js");
+const Application = __webpack_require__(/*! ../src/appTemplates/Application */ "./src/appTemplates/Application.js");
+
+describe('[APAX] Application class', () => {
+  const baseStreamId = 'application-class';
+  const appName = 'application-app';
+  let user;
+  before(async () => {
+    const initialStreams = [{ id: 'applications', name: 'Applications' }, { id: baseStreamId, name: appName, parentId: 'applications' }];
+    const permissionsManager = [{ streamId: baseStreamId, level: 'manage' }];
+    user = await createUserAndPermissions(null, permissionsManager, initialStreams, appName);
+  });
+
+  it('[APAI] Application extension', async () => {
+    class Dummy extends Application { }
+
+    try {
+      await Dummy.newFromApiEndpoint(baseStreamId, user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'appSettings must be implemented');
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      new Dummy('u', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Missing or too short baseStreamId');
+    }
+  });
+
+  it('[APAA] Application name form accessInfo fails in not in settings', () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      new Dummy(baseStreamId, user.appApiEndpoint);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'appName must be given unless appSettings.appNameFromAccessInfo = true');
+    }
+  });
+
+  it('[APAB] Application name form accessInfo', async () => {
+    class Dummy2 extends Application {
+      get appSettings () {
+        return {
+          appNameFromAccessInfo: true
+        };
+      }
+    }
+
+    const dummy2 = await Dummy2.newFromApiEndpoint(baseStreamId, user.appApiEndpoint);
+    assert.ok(dummy2, 'if appSettings.appNameFromAccessInfo = true appName is not required');
+  });
+
+  it('[APAC] Application should throw error if baseStream is not accessible', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application with "app" type of access requires  (streamId = "uuuu", level = "manage") or master access');
+    }
+  });
+
+  it('[APAD] Application should throw error if personaToken are not explicity allowed', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.personalApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application should not use a personal token');
+    }
+  });
+
+  it('[APAE] Application should throw error if master token not provided and required', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return {
+          mustBemaster: true
+        };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application with "app" type of access requires "master" token (streamId = "*", level = "manage")');
+    }
+  });
+});
+
+
 /***/ }),
 
 /***/ "./tests/apptemplates.test.js":
@@ -22565,7 +22685,6 @@ describe('[APTX] appTemplates', function () {
   });
 
   describe('[APIX] Collector invite flows & internals', () => {
-
     it('[APTI] Collector invite accept full flow testing internal', async () => {
       const newCollector = await appManaging.createCollector('Invite test 1');
       assert(newCollector.statusCode, 'draft');
@@ -22687,7 +22806,7 @@ describe('[APTX] appTemplates', function () {
       assert.equal(invites2[0].status, 'active');
     });
 
-        it('[APIA] Collector invite accept', async () => {
+    it('[APIA] Collector invite accept', async () => {
       const { collector, collectorClient, invite } = await helperNewInvite(appManaging, appClient, 'APIA');
       assert.ok(invite.status, 'pending');
       await collectorClient.accept();
@@ -22719,7 +22838,7 @@ describe('[APTX] appTemplates', function () {
       // connection is cached and valid
       const connection = invite.connection;
       const inviteInfo = await connection.accessInfo();
-      assert.ok(!!inviteInfo.clientData.hdsCollectorClient)
+      assert.ok(!!inviteInfo.clientData.hdsCollectorClient);
     });
 
     it('[APTR] Collector invite refuse', async () => {
@@ -22808,7 +22927,7 @@ describe('[APTX] appTemplates', function () {
         await AppClientAccount.newFromApiEndpoint(baseStreamIdClient, clientUserNonMaster.appApiEndpoint, appClientName);
         throw new Error('Should throw error');
       } catch (e) {
-        assert.equal(e.message, `Application with "app" type of access requires  (streamId = '${baseStreamIdClient}', level = "manage") or master access`);
+        assert.equal(e.message, `Application with "app" type of access requires  (streamId = "${baseStreamIdClient}", level = "manage") or master access`);
       }
       // personal
       const appClient = await AppClientAccount.newFromApiEndpoint(baseStreamIdClient, clientUser.apiEndpoint, appClientName);
@@ -23767,6 +23886,7 @@ var __webpack_exports__ = {};
  * Hook for webpack to build browser test-suite
  * Add new tests here
  */
+__webpack_require__(/*! ./applicationClass.test */ "./tests/applicationClass.test.js");
 __webpack_require__(/*! ./apptemplates.test */ "./tests/apptemplates.test.js");
 __webpack_require__(/*! ./hdsModel.test */ "./tests/hdsModel.test.js");
 __webpack_require__(/*! ./libSettings.test */ "./tests/libSettings.test.js");

docs/hds-lib.js.map

@@ -120,7 +120,7 @@ async function createAppStreams (app) {
     }
     if (!masterFound) { // check that app has "manage" level on baseStreamId
       const baseStreamFound = infos.permissions.find(p => (p.streamId === app.baseStreamId && p.level === 'manage'));
-      if (!baseStreamFound) throw new Error(`Application with "app" type of access requires  (streamId = '${app.baseStreamId}', level = "manage") or master access`);
+      if (!baseStreamFound) throw new Error(`Application with "app" type of access requires  (streamId = "${app.baseStreamId}", level = "manage") or master access`);
     }
   }
   // get streamStructure
@@ -135,9 +135,6 @@ async function createAppStreams (app) {
   }
   // not found create streams
   if (!found) {
-    if (app.appName == null) {
-      throw new Error('Cannot create app stream if not "appName" has been given');
-    }
     if (!isPersonalOrMaster) {
       throw new Error('Token has not sufficient right to create App streams. Create them upfront');
     }

docs/tests-browser.js

@@ -0,0 +1,113 @@
+/* eslint-env mocha */
+const { assert } = require('./test-utils/deps-node');
+const { createUserAndPermissions } = require('./test-utils/pryvService');
+const Application = require('../src/appTemplates/Application');
+
+describe('[APAX] Application class', () => {
+  const baseStreamId = 'application-class';
+  const appName = 'application-app';
+  let user;
+  before(async () => {
+    const initialStreams = [{ id: 'applications', name: 'Applications' }, { id: baseStreamId, name: appName, parentId: 'applications' }];
+    const permissionsManager = [{ streamId: baseStreamId, level: 'manage' }];
+    user = await createUserAndPermissions(null, permissionsManager, initialStreams, appName);
+  });
+
+  it('[APAI] Application extension', async () => {
+    class Dummy extends Application { }
+
+    try {
+      await Dummy.newFromApiEndpoint(baseStreamId, user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'appSettings must be implemented');
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      new Dummy('u', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Missing or too short baseStreamId');
+    }
+  });
+
+  it('[APAA] Application name form accessInfo fails in not in settings', () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      new Dummy(baseStreamId, user.appApiEndpoint);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'appName must be given unless appSettings.appNameFromAccessInfo = true');
+    }
+  });
+
+  it('[APAB] Application name form accessInfo', async () => {
+    class Dummy2 extends Application {
+      get appSettings () {
+        return {
+          appNameFromAccessInfo: true
+        };
+      }
+    }
+
+    const dummy2 = await Dummy2.newFromApiEndpoint(baseStreamId, user.appApiEndpoint);
+    assert.ok(dummy2, 'if appSettings.appNameFromAccessInfo = true appName is not required');
+  });
+
+  it('[APAC] Application should throw error if baseStream is not accessible', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application with "app" type of access requires  (streamId = "uuuu", level = "manage") or master access');
+    }
+  });
+
+  it('[APAD] Application should throw error if personaToken are not explicity allowed', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return { };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.personalApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application should not use a personal token');
+    }
+  });
+
+  it('[APAE] Application should throw error if master token not provided and required', async () => {
+    class Dummy extends Application {
+      get appSettings () {
+        return {
+          mustBemaster: true
+        };
+      }
+    }
+
+    try {
+      // eslint-disable-next-line no-new
+      await Dummy.newFromApiEndpoint('uuuu', user.appApiEndpoint, appName);
+      throw new Error('Should throw an error');
+    } catch (e) {
+      assert.equal(e.message, 'Application with "app" type of access requires "master" token (streamId = "*", level = "manage")');
+    }
+  });
+});

docs/tests-browser.js.map

@@ -367,7 +367,7 @@ describe('[APTX] appTemplates', function () {
         await AppClientAccount.newFromApiEndpoint(baseStreamIdClient, clientUserNonMaster.appApiEndpoint, appClientName);
         throw new Error('Should throw error');
       } catch (e) {
-        assert.equal(e.message, `Application with "app" type of access requires  (streamId = '${baseStreamIdClient}', level = "manage") or master access`);
+        assert.equal(e.message, `Application with "app" type of access requires  (streamId = "${baseStreamIdClient}", level = "manage") or master access`);
       }
       // personal
       const appClient = await AppClientAccount.newFromApiEndpoint(baseStreamIdClient, clientUser.apiEndpoint, appClientName);

src/appTemplates/Application.js

@@ -2,6 +2,7 @@
  * Hook for webpack to build browser test-suite
  * Add new tests here
  */
+require('./applicationClass.test');
 require('./apptemplates.test');
 require('./hdsModel.test');
 require('./libSettings.test');