Adding new endpoint for user level reports

Author: Vikas Agarwal

src/routes/index.js

@@ -310,6 +310,10 @@ router.route('/v5/projects/metadata/planConfig/:key/versions/:version(\\d+)')
   .patch(require('./planConfig/version/update'))
   .delete(require('./planConfig/version/delete'));
 
+// user level reports
+router.route('/v5/projects/reports/embed')
+.get(require('./userReports/getEmbedReport'));
+
 // work streams
 router.route('/v5/projects/:projectId(\\d+)/workstreams')
   .get(require('./workStreams/list'))

src/routes/projectReports/getEmbedReport.js

@@ -105,7 +105,7 @@ module.exports = [
       const embedUrl = REPORTS[reportName];
       req.log.trace(`Generating embed URL for ${reportName} report, using ${embedUrl} as embed URL.`);
       if (embedUrl) {
-        result = await lookerSerivce.generateEmbedUrl(req.authUser, project, member, embedUrl);
+        result = await lookerSerivce.generateEmbedUrlForProject(req.authUser, project, member, embedUrl);
       } else {
         return res.status(404).send('Report not found');
       }

src/routes/userReports/getEmbedReport.js

@@ -0,0 +1,77 @@
+/* eslint-disable no-unused-vars */
+import config from 'config';
+import _ from 'lodash';
+import { middleware as tcMiddleware } from 'tc-core-library-js';
+import util from '../../util';
+import { USER_ROLE, ADMIN_ROLES, MANAGER_ROLES } from '../../constants';
+import models from '../../models';
+import lookerSerivce from '../../services/lookerService';
+
+const permissions = tcMiddleware.permissions;
+
+
+module.exports = [
+  async (req, res, next) => {
+    const mockReport = config.get('lookerConfig.USE_MOCK') === 'true';
+    let reportName = mockReport ? 'mock' : req.query.reportName;
+    const authUser = req.authUser;
+    let REPORTS = null;
+    let allowedUsers = null;
+    try {
+      allowedUsers = JSON.parse(_.get(config, 'lookerConfig.ALLOWED_USERS', '[]'));
+      req.log.trace(allowedUsers, 'allowedUsers');
+      REPORTS = JSON.parse(config.get('lookerConfig.EMBED_REPORTS_MAPPING'));
+    } catch (error) {
+      req.log.error(error);
+      req.log.debug('Invalid reports mapping. Should be a valid JSON.');
+    }
+    if (!mockReport && !REPORTS) {
+      return res.status(404).send('Report not found');
+    }
+
+    try {
+      const isAdmin = util.hasRoles(req, ADMIN_ROLES);
+      const userDisallowed = allowedUsers.length > 0 && !allowedUsers.includes(authUser.userId);
+      if (userDisallowed) {
+        req.log.error(`User whitelisting prevented accessing report ${reportName} to ${authUser.userId}`);
+        return res.status(403).send('User is not allowed to access the report');
+      }
+      const token = await util.getM2MToken();
+      const callerUser = await util.getTopcoderUser(authUser.userId, token, req.log);
+      req.log.trace(callerUser, 'callerUser');
+      const member = {
+        firstName: callerUser.firstName,
+        lastName: callerUser.lastName,
+        userId: callerUser.userId,
+        role: '',
+      };
+      let roleKey = '';
+      if (!mockReport) {
+        if (util.hasRoles(req, [USER_ROLE.COPILOT])) {
+          roleKey = 'copilot';
+        }
+        if (isAdmin || util.hasRoles(req, MANAGER_ROLES)) {
+          roleKey = 'topcoder';
+        } else {
+          roleKey = 'customer';
+        }
+        reportName = `${reportName}-${roleKey}`;
+      }
+      // pick the report based on its name
+      let result = {};
+      const embedUrl = REPORTS[reportName];
+      req.log.trace(`Generating embed URL for ${reportName} report, using ${embedUrl} as embed URL.`);
+      if (embedUrl) {
+        result = await lookerSerivce.generateEmbedUrlForUser(req.authUser, member, embedUrl);
+      } else {
+        return res.status(404).send('Report not found');
+      }
+
+      req.log.trace(result);
+      return res.status(200).json(result);
+    } catch (err) {
+      req.log.error(err);
+      return res.status(500).send(err.toString());
+    }
+  },
+];

src/services/lookerService.js

@@ -92,6 +92,44 @@ function createdSignedEmbedUrl(options) {
   return `${host}${embedPath}?${queryString}`;
 }
 
+/**
+ * Generates the looker embed URL for the given look/dashboard.
+ *
+ * @param {Object} authUser requesting user
+ * @param {Object} member member object for the requesting user
+ * @param {String} reportUrl embed URL (look,dashboard etc)
+ * @returns {String} URL for embedding the looker report, it can be GET only once
+ */
+function generateEmbedUrlForUser(authUser, member, reportUrl) {
+  const SESSION_LENGTH = parseInt(config.lookerConfig.SESSION_LENGTH, 10);
+  const urlData = {
+    host: config.lookerConfig.LOOKER_HOST,
+    secret: config.lookerConfig.EMBED_KEY,
+    external_user_id: authUser.userId,
+    group_ids: [],
+    first_name: member.firstName,
+    last_name: member.lastName,
+    permissions: ['access_data', 'see_looks', 'see_user_dashboards', 'schedule_look_emails', 'download_with_limit'],
+    models: ['tc_user_projects'],
+    access_filters: {
+      tc_user_projects: {
+        tc_user_id: `${member.userId}`,
+      },
+    },
+    user_attributes: {
+      user_roles_project: member.role,
+      user_roles_platform: authUser.roles,
+      tc_user_id: member.userId,
+    },
+    session_length: SESSION_LENGTH,
+    embed_url: reportUrl,
+    force_logout_login: true,
+  };
+
+  const url = createdSignedEmbedUrl(urlData);
+  return `https://${url}`;
+}
+
 /**
  * Generates the looker embed URL for the given look/dashboard.
  *
@@ -101,7 +139,7 @@ function createdSignedEmbedUrl(options) {
  * @param {String} reportUrl embed URL (look,dashboard etc)
  * @returns {String} URL for embedding the looker report, it can be GET only once
  */
-function generateEmbedUrl(authUser, project, member, reportUrl) {
+function generateEmbedUrlForProject(authUser, project, member, reportUrl) {
   const SESSION_LENGTH = parseInt(config.lookerConfig.SESSION_LENGTH, 10);
   const urlData = {
     host: config.lookerConfig.LOOKER_HOST,
@@ -121,6 +159,7 @@ function generateEmbedUrl(authUser, project, member, reportUrl) {
       connect_project_id: `${project.id}`,
       user_roles_project: member.role,
       user_roles_platform: authUser.roles,
+      tc_user_id: member.userId,
     },
     session_length: SESSION_LENGTH,
     embed_url: reportUrl,
@@ -132,5 +171,6 @@ function generateEmbedUrl(authUser, project, member, reportUrl) {
 }
 
 module.exports = {
-  generateEmbedUrl,
+  generateEmbedUrlForUser,
+  generateEmbedUrlForProject,
 };