e2e: add X-Simcore-User-Agent to requests (ITISFoundation#3392)

Author: odeimaiz

services/static-webserver/client/source/class/osparc/auth/Data.js

@@ -88,6 +88,13 @@ qx.Class.define("osparc.auth.Data", {
       nullable: true,
       check: "Date",
       event: "changeExpirationDate"
+    },
+
+    // used for adding "tester" info to the request's headers
+    testerUserName: {
+      init: null,
+      nullable: true,
+      check: "String"
     }
   },
 

services/static-webserver/client/source/class/osparc/auth/Manager.js

@@ -166,6 +166,7 @@ qx.Class.define("osparc.auth.Manager", {
       };
       xhr.open("POST", url, true);
       xhr.setRequestHeader("Content-Type", "application/json");
+      osparc.io.rest.Resource.setTesterUserNameHeader(xhr);
       xhr.send(JSON.stringify(params));
     },
 

services/static-webserver/client/source/class/osparc/io/request/ApiRequest.js

@@ -30,5 +30,6 @@ qx.Class.define("osparc.io.request.ApiRequest", {
     });
 
     this.setRequestHeader("Content-Type", "application/json");
+    osparc.io.rest.Resource.setTesterUserNameHeader(this);
   }
 });

services/static-webserver/client/source/class/osparc/io/rest/Resource.js

@@ -21,19 +21,11 @@
 qx.Class.define("osparc.io.rest.Resource", {
   extend: qx.io.rest.Resource,
 
-  statics: {
-    AUTHENTICATION: null,
-
-    setAutheticationHeader: function(usernameOrToken, password=null) {
-      osparc.io.rest.Resource.AUTHENTICATION = new qx.io.request.authentication.Basic(usernameOrToken, password);
-    }
-  },
-
   construct: function(description) {
     this.base(arguments, description);
 
-    this.configureRequest(function(request, action, params, data) {
-      let headers = [{
+    this.configureRequest(request => {
+      const headers = [{
         key: "Accept",
         value: "application/json"
       }];
@@ -42,17 +34,32 @@ qx.Class.define("osparc.io.rest.Resource", {
         headers.concat(this.AUTHENTICATION.getAuthHeaders());
       }
 
-      headers.forEach(function(item, index, array) {
-        request.setRequestHeader(item.key, item.value);
-      });
+      headers.forEach(item => request.setRequestHeader(item.key, item.value));
 
       request.setRequestHeader("Content-Type", "application/json");
 
       const productName = qx.core.Environment.get("product.name");
       request.setRequestHeader("X-Simcore-Products-Name", productName);
+
+      this.self().setTesterUserNameHeader(request);
     });
   },
 
+  statics: {
+    AUTHENTICATION: null,
+
+    setAutheticationHeader: function(usernameOrToken, password=null) {
+      osparc.io.rest.Resource.AUTHENTICATION = new qx.io.request.authentication.Basic(usernameOrToken, password);
+    },
+
+    setTesterUserNameHeader: function(request) {
+      const tester = osparc.auth.Data.getInstance().getTesterUserName();
+      if (tester) {
+        request.setRequestHeader("X-Simcore-User-Agent", tester);
+      }
+    }
+  },
+
   members: {
     includesRoute: function(route) {
       return Object.keys(this.__routes).includes(route);

tests/e2e/tutorials/tutorialBase.js

@@ -48,6 +48,7 @@ class TutorialBase {
     this.__browser = await startPuppe.getBrowser(this.__demo);
     this.__page = await startPuppe.getPage(this.__browser);
     this.__responsesQueue = new responses.ResponsesQueue(this.__page);
+
     return this.__page;
   }
 
@@ -70,6 +71,20 @@ class TutorialBase {
     // eslint-disable-next-line no-undef
     const commit = await this.__page.evaluate(() => qx.core.Environment.get("osparc.vcsRef"));
     console.log("commit", commit);
+
+    await this.__page.evaluate((user, newUser) => {
+      let testerUserName = "";
+      if (newUser) {
+        testerUserName = "registered";
+      }
+      else if (user === null) {
+        testerUserName = "anonymous";
+      }
+      else {
+        testerUserName = user;
+      }
+      osparc.auth.Data.getInstance().setTesterUserName(testerUserName);
+    }, this.__user, this.__newUser);
   }
 
   async __printMe() {