Merge pull request #133 from paulscherrerinstitute/feature/timeoutVal…

…uesConsistent

Modified timeout for nodejs server

.github/workflows/scicat-be.yml

@@ -61,6 +61,7 @@ jobs:
       run: |
         ciVars=$(cat <<EOF
           {
+            "SERVER": $(jq -R -s < helm_configs/backend/server.js),
             "CONFIG_LOCAL": $(jq -R -s < helm_configs/backend/config.local.js),
             "LOGIN_CALLBACKS": $(jq -R -s < helm_configs/backend/login-callbacks.js),
             "MIDDLEWARE": $(jq -R -s < helm_configs/backend/${{ needs.set_env.outputs.environment }}/middleware.json),

helm_configs/backend/server.js

@@ -0,0 +1,241 @@
+"use strict";
+
+var loopback = require("loopback");
+var boot = require("loopback-boot");
+
+var app = (module.exports = loopback());
+var configLocal = require("./config.local");
+
+const logger = require("../common/logger");
+
+const uuidv3 = require("uuid/v3");
+
+// Create an instance of PassportConfigurator with the app instance
+var PassportConfigurator = require("loopback-component-passport")
+  .PassportConfigurator;
+var passportConfigurator = new PassportConfigurator(app);
+
+var loginCallbacks = require("./boot/login-callbacks");
+
+// express sessions are required for passport ocid. If your
+// config.Local has a session for the expressionSecret, configure
+// express-session
+if (configLocal.expressSessionSecret){
+  var session = require("express-session");
+  app.use(session({
+    secret: configLocal.expressSessionSecret,
+    resave: false,
+    saveUninitialized: true
+  }));
+}
+
+
+// enhance the profile definition to allow for applying regexp based substitution rules to be applied
+// to the outcome of e.g. LDAP queries. This can for example be exploited to define the groups
+// a user belongs to by scanning the output of the memberOf fields of a user
+//
+// example of a profile entry in providers.json:
+// "accessGroups": ["memberOf", {match-string}, {substitution-string}]
+//
+// Please note: the match and substitution strings must escape the backslash and
+// double quote characters inside providers.json by prepending a backslash
+
+passportConfigurator.buildUserLdapProfile = function(user, options) {
+  var profile = {};
+
+  for (var profileAttributeName in options.profileAttributesFromLDAP) {
+    var profileAttributeValue =
+            options.profileAttributesFromLDAP[profileAttributeName];
+
+    if (profileAttributeValue.constructor === Array) {
+      var regex = new RegExp(profileAttributeValue[1], "g");
+      // transform array elements to simple group names
+      // then filter relevant elements by applying regular expression on element names
+      var newList = [];
+      var memberOfList = user[profileAttributeValue[0]];
+      if (memberOfList instanceof Array) {
+        user[profileAttributeValue[0]].map(function(elem) {
+          if (elem.match(regex)) {
+            newList.push(
+              elem.replace(regex, profileAttributeValue[2])
+            );
+          }
+        });
+      } else if (typeof memberOfList == "string") {
+        if (memberOfList.match(regex)) {
+          newList.push(
+            memberOfList.replace(regex, profileAttributeValue[2])
+          );
+        }
+      }
+      profile[profileAttributeName] = newList;
+    } else {
+      if (profileAttributeValue in user) {
+        profile[profileAttributeName] = JSON.parse(
+          JSON.stringify(user[profileAttributeValue])
+        );
+      } else {
+        profile[profileAttributeName] = "";
+      }
+    }
+  }
+  // If missing, add profile attributes required by UserIdentity Model
+  if (!profile.username) {
+    profile.username = [].concat(user["cn"])[0];
+  }
+  if (!profile.thumbnailPhoto2) {
+    if (Object.prototype.hasOwnProperty.call(user, "_raw")) {
+      let img;
+      const userRaw = user._raw;
+      if (Object.prototype.hasOwnProperty.call(userRaw, "THUMBNAILPHOTO")) {
+        img = user._raw.THUMBNAILPHOTO;
+      } else if (Object.prototype.hasOwnProperty.call(userRaw, "thumbnailPhoto")) {
+        img = user._raw.thumbnailPhoto;
+      }
+      if (img) {
+        profile.thumbnailPhoto =
+                    "data:image/jpeg;base64," + img.toString("base64");
+      } else {
+        profile.thumbnailPhoto = "error: no photo found";
+      }
+    } else {
+      profile.thumbnailPhoto = "error: no photo found";
+    }
+  }
+  if (!profile.id) {
+    profile.id = user["uid"];
+    if (!("uid" in user)) {
+      const MY_NAMESPACE = "1b671a64-40d5-491e-99b0-da01ff1f3341";
+      const generatedId = uuidv3(user["mail"], MY_NAMESPACE);
+      profile.id = generatedId;
+    }
+  }
+  if (!profile.emails) {
+    var email = [].concat(user["mail"])[0];
+    if (email) {
+      profile.emails = [
+        {
+          value: email
+        }
+      ];
+    }
+  }
+
+  if (configLocal.site === "ESS") {
+    if (!profile.accessGroups) {
+      profile.accessGroups = ["ess", "loki", "odin"];
+    }
+  }
+
+  console.log("++++++++++ Profile:", profile);
+  return profile;
+};
+
+if ("queue" in configLocal) {
+  var msg = "Queue configured to be ";
+  switch (configLocal.queue) {
+  case "rabbitmq":
+    console.log(msg + "RabbitMQ");
+    break;
+  case "kafka":
+    console.log(msg + "Apache Kafka");
+    break;
+  default:
+    console.log("Queuing system not configured.");
+    break;
+  }
+}
+
+if ("smtpSettings" in configLocal) {
+  console.log("Email settings detected");
+}
+
+var bodyParser = require("body-parser");
+app.start = function() {
+  // start the web server
+  const server=app.listen(function() {
+    app.emit("started");
+    var baseUrl = app.get("url").replace(/\/$/, "");
+    console.log("Web server listening at: %s", baseUrl);
+    if (app.get("loopback-component-explorer")) {
+      var explorerPath = app.get("loopback-component-explorer").mountPath;
+      console.log("Browse your REST API at %s%s", baseUrl, explorerPath);
+    }
+
+  });
+  console.log("keepAliveTimeout,headersTimeout default:", server.keepAliveTimeout, server.headersTimeout);
+  server.keepAliveTimeout = 76000;
+  server.headersTimeout = 77000;
+  console.log("keepAliveTimeout,headersTimeout changed to:", server.keepAliveTimeout, server.headersTimeout);
+
+  return server;
+};
+
+// Bootstrap the application, configure models, datasources and middleware.
+// Sub-apps like REST API are mounted via boot scripts.
+boot(app, __dirname, function(err) {
+  if (err) throw err;
+
+  // start the server if `$ node server.js`
+  if (require.main === module) app.start();
+});
+
+// to support JSON-encoded bodies
+app.middleware(
+  "parse",
+  bodyParser.json({
+    limit: "50mb"
+  })
+);
+// to support URL-encoded bodies
+app.middleware(
+  "parse",
+  bodyParser.urlencoded({
+    limit: "50mb",
+    extended: true
+  })
+);
+// // The access token is only available after boot
+app.middleware(
+  "auth",
+  loopback.token({
+    model: app.models.accessToken
+  })
+);
+
+// Load the provider configurations
+var config = {};
+try {
+  config = require("./providers.json");
+} catch (err) {
+  console.error(
+    "Please configure your passport strategy in `providers.json`."
+  );
+  process.exit(1);
+}
+
+// Initialize passport
+passportConfigurator.init();
+
+// Set up related models
+passportConfigurator.setupModels({
+  userModel: app.models.user,
+  userIdentityModel: app.models.userIdentity,
+  userCredentialModel: app.models.userCredential
+});
+
+
+
+// Configure passport strategies for third party auth providers
+for (var s in config) {
+  var c = config[s];
+  c.session = c.session !== false;
+  if (c.provider === "ldap") {
+    c["failureErrorCallback"] = err => logger.logError(err.message, {});
+  }
+  if (c.loginCallback && loginCallbacks[c.loginCallback]){
+    c.loginCallback = loginCallbacks[c.loginCallback];
+  }
+  passportConfigurator.configureProvider(s, c);
+
+}

helm_configs/backend/values.yaml

@@ -59,6 +59,7 @@ ingress:
 
 configMaps: 
   "{{ .Release.Name }}-cm":
+    server.js: "{{ .Values.ciVars.SERVER }}"
     config.local.js: "{{ .Values.ciVars.CONFIG_LOCAL }}"
     login-callbacks.js: "{{ .Values.ciVars.LOGIN_CALLBACKS }}"
     middleware.json: "{{ .Values.ciVars.MIDDLEWARE }}"
@@ -76,6 +77,9 @@ env:
         key: mail_auth
 
 volumeMounts:
+  - name: config-volume
+    mountPath: /home/node/app/server/server.js
+    subPath: server.js
   - name: config-volume
     mountPath: /home/node/app/server/config.local.js
     subPath: config.local.js