Initial commit for reporting support

Author: Vikas Agarwal

config/custom-environment-variables.json

@@ -50,5 +50,15 @@
   "accountsAppUrl": "ACCOUNTS_APP_URL",
   "inviteEmailSubject": "INVITE_EMAIL_SUBJECT",
   "inviteEmailSectionTitle": "INVITE_EMAIL_SECTION_TITLE",
-  "SSO_REFCODES": "SSO_REFCODES"
+  "SSO_REFCODES": "SSO_REFCODES",
+  "lookerConfig": {
+    "BASE_URL": "LOOKER_API_BASE_URL",
+    "CLIENT_ID": "LOOKER_API_CLIENT_ID",
+    "CLIENT_SECRET": "LOOKER_API_CLIENT_SECRET",
+    "TOKEN": "TOKEN",
+    "USE_MOCK": "LOOKER_API_ENABLE_MOCK",
+    "QUERIES": {
+      "REG_STATS": "LOOKER_API_REG_STATS_QUERY_ID"
+    }
+  }
 }

package.json

@@ -73,7 +73,7 @@
     "babel-plugin-add-module-exports": "^0.2.1",
     "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-es2015": "^6.9.0",
-    "bunyan": "^1.8.1",
+    "bunyan": "^1.8.12",
     "chai": "^3.5.0",
     "chai-as-promised": "^7.1.1",
     "eslint": "^3.16.1",

src/routes/index.js

@@ -309,6 +309,9 @@ router.route('/v4/projects/:projectId(\\d+)/workstreams/:workStreamId(\\d+)/work
   .patch(require('./workItems/update'))
   .delete(require('./workItems/delete'));
 
+router.route('/v4/projects/:projectId/reports')
+  .get(require('./projectReports/getReport'));
+
 // register error handler
 router.use((err, req, res, next) => { // eslint-disable-line no-unused-vars
   // DO NOT REMOVE next arg.. even though eslint

src/routes/projectReports/LookAuth.js

@@ -0,0 +1,73 @@
+/* eslint-disable func-names */
+/* eslint-disable require-jsdoc */
+/* eslint-disable valid-jsdoc */
+
+// Look Auth
+
+
+import config from 'config';
+
+const axios = require('axios');
+
+const NEXT_5_MINS = 5 * 60 * 1000;
+
+
+function LookAuth(logger) {
+  // load credentials from config
+  this.BASE_URL = config.lookerConfig.BASE_URL;
+  this.CLIENT_ID = config.lookerConfig.CLIENT_ID;
+  this.CLIENT_SECRET = config.lookerConfig.CLIENT_SECRET;
+  const token = config.lookerConfig.TOKEN;
+
+  this.logger = logger;
+
+  // Token is stringified and saved as string. It has 4 properties, access_token, expires_in and type, timestamp
+  if (token) {
+    this.lastToken = JSON.stringify(token);
+  }
+}
+
+LookAuth.prototype.getToken = async function () {
+  const res = await new Promise((resolve) => {
+    if (!this.isExpired()) {
+      resolve(this.lastToken.access_token);
+    } else {
+      resolve('');
+    }
+  });
+  if (res === '') {
+    return this.login();
+  }
+  return res;
+};
+
+/** *********************Login to Looker ************** */
+LookAuth.prototype.login = async function () {
+  const loginUrl = `${this.BASE_URL}/login?client_id=${this.CLIENT_ID}&client_secret=${this.CLIENT_SECRET}`;
+  const res = await axios.post(loginUrl, {}, { headers: { 'Content-Type': 'application/json' } });
+  this.lastToken = res.data;
+  this.lastToken.timestamp = new Date().getTime();
+  return this.lastToken.access_token;
+};
+
+
+/** ***************Check if the Token has expired ********** */
+LookAuth.prototype.isExpired = function () {
+  // If no token is present, assume the token has expired
+  if (!this.lastToken) {
+    return true;
+  }
+
+  const tokenTimestamp = this.lastToken.timestamp;
+  const expiresIn = this.lastToken.expires_in;
+  const currentTimestamp = new Date().getTime();
+
+  // If the token will good for next 5 minutes
+  if ((tokenTimestamp + expiresIn + NEXT_5_MINS) > currentTimestamp) {
+    return false;
+  }
+  // Token is good, and can be used to make the next call.
+  return true;
+};
+
+module.exports = LookAuth;

src/routes/projectReports/LookRun.js

@@ -0,0 +1,80 @@
+/* eslint-disable valid-jsdoc */
+/* eslint-disable require-jsdoc */
+/* eslint-disable func-names */
+
+import config from 'config';
+import LookAuth from './LookAuth';
+
+const axios = require('axios');
+
+function LookApi(logger) {
+  this.BASE_URL = config.lookerConfig.BASE_URL;
+  this.formatting = 'json';
+  this.limit = 5000;
+  this.logger = logger;
+  this.lookAuth = new LookAuth(logger);
+}
+
+LookApi.prototype.runLook = function (lookId) {
+  const endpoint = `${this.BASE_URL}/looks/${lookId}/run/${this.formatting}?limit=${this.limit}`;
+  return this.callApi(endpoint);
+};
+
+LookApi.prototype.findUserByEmail = function (email) {
+  const filter = { 'user.email': email };
+  return this.runQueryWithFilter(1234, filter);
+};
+
+LookApi.prototype.findByHandle = function (handle) {
+  const filter = { 'user.handle': handle };
+  return this.runQueryWithFilter(12345, filter);
+};
+
+LookApi.prototype.findProjectRegSubmissions = function (directProjectId) {
+  const queryId = config.lookerConfig.QUERIES.REG_STATS;
+  const fields = ['challenge.track', 'challenge.num_registrations', 'challenge.num_submissions'];
+  const view = 'challenge';
+  const filters = { 'challenge.tc_direct_project_id': directProjectId };
+  return this.runQueryWithFilter(queryId, view, fields, filters);
+};
+
+LookApi.prototype.runQueryWithFilter = function (queryId, view, fields, filters) {
+  const endpoint = `${this.BASE_URL}/queries/run/${this.formatting}`;
+
+  const body = {
+    id: queryId,
+    model: 'topcoder_model_main',
+    view,
+    filters,
+    fields,
+    // sorts: ['user.email desc 0'],
+    limit: 10,
+    query_timezon: 'America/Los_Angeles',
+
+  };
+  return this.callApi(endpoint, body);
+};
+
+LookApi.prototype.runQuery = function (queryId) {
+  const endpoint = `${this.BASE_URL}/queries/${queryId}/run/${this.formatting}?limit=${this.limit}`;
+  return this.callApi(endpoint);
+};
+
+LookApi.prototype.callApi = function (endpoint, body) {
+  return this.lookAuth.getToken().then((token) => {
+    let newReq = null;
+    if (body) {
+      newReq = axios.post(endpoint, body, {
+        headers: { 'Content-Type': 'application/json', 'Authorization': `token ${token}` }
+      });
+    } else {
+      newReq = axios.get(endpoint);
+    }
+    return newReq;
+  }).then((res) => {
+    this.logger.info(res.data);
+    return res.data;
+  });
+};
+
+module.exports = LookApi;

src/routes/projectReports/getReport.js

@@ -0,0 +1,49 @@
+/* eslint-disable no-unused-vars */
+import config from 'config';
+import _ from 'lodash';
+
+import { middleware as tcMiddleware } from 'tc-core-library-js';
+import models from '../../models';
+import LookApi from './LookRun';
+import mock from './mock';
+import util from '../../util';
+
+const permissions = tcMiddleware.permissions;
+
+
+module.exports = [
+  permissions('project.view'),
+  async (req, res, next) => {
+    const projectId = Number(req.params.projectId);
+    const reportName = req.query.reportName;
+
+
+    if (config.lookerConfig.USE_MOCK) {
+      req.log.info('using mock');
+      // using mock
+      return mock(projectId, reportName, req, res);
+      // res.status(200).json(util.wrapResponse(req.id, project));
+    }
+    const lookApi = new LookApi(req.log);
+    const project = await models.Project.find({
+      where: { id: projectId },
+      attributes: ['directProjectId'],
+      raw: true,
+    });
+    const directProjectId = _.get(project, 'directProjectId');
+    if (!directProjectId) {
+      return res.status(400).send('Direct Project not linked');
+    }
+    if (reportName === 'summary') {
+      try {
+        const result = await lookApi.findProjectRegSubmissions(directProjectId);
+        req.log.debug(result);
+        return res.status(200).json(util.wrapResponse(req.id, result));
+      } catch (err) {
+        req.log.error(err);
+        return res.status(500).send(err.toString());
+      }
+    }
+    return res.status(404).send('Report not found');
+  },
+];

src/routes/projectReports/mock.js

@@ -0,0 +1,13 @@
+import util from '../../util';
+
+const summaryJson = require('./mockFiles/summary.json');
+
+module.exports = (projectId, reportName, req, res) => {
+  if (Number(projectId) === 123456) {
+    res.status(500).json('Invalid project id');
+  } else if (reportName === 'summary') {
+    res.status(200).json(util.wrapResponse(req.id, summaryJson));
+  } else {
+    res.status(400).json('Invalid report name');
+  }
+};

src/routes/projectReports/mockFiles/summary.json

@@ -0,0 +1,17 @@
+[ { "challenge.track": "Develop",
+
+   "challenge.num_registrations": 399,
+
+   "challenge.num_submissions": 72 },
+
+ { "challenge.track": "Design",
+
+   "challenge.num_registrations": 54,
+
+   "challenge.num_submissions": 28 },
+
+ { "challenge.track": null,
+
+   "challenge.num_registrations": 453,
+
+   "challenge.num_submissions": 100 } ]