Merge pull request #43 from tidepool-org/print_reports

[BACK-2540] Print reports

Author: krystophv

.eslintrc

@@ -0,0 +1,21 @@
+module.exports = {
+  extends: 'airbnb',
+  parser: '@babel/eslint-parser',
+  plugins: ['lodash'],
+  parserOptions: {
+    ecmaVersion: 6,
+    requireConfigFile: false,
+  },
+  rules: {
+    'no-plusplus': [
+      'error',
+      {
+        allowForLoopAfterthoughts: true,
+      },
+    ],
+    'import/extensions': [0, { '<js>': 'always' }],
+  },
+  settings: {
+    lodash: 3,
+  },
+};

.eslintrc.cjs

@@ -0,0 +1 @@
+16.20.1

.nvmrc

@@ -3,7 +3,7 @@ sudo: false
 language: node_js
 
 node_js:
-  - 12.14.0
+  - 16.20.1
   - node
 
 cache: yarn
@@ -28,6 +28,7 @@ services:
 
 script:
   - yarn run lint
+  - yarn test
   - ./artifact.sh
 
 matrix:

.travis.yml

@@ -1,9 +1,9 @@
 ### Stage 0 - Base image
-FROM node:12.14.0-alpine as base
+FROM node:16.20.1-alpine as base
 WORKDIR /app
 RUN apk --no-cache update && \
     apk --no-cache upgrade && \
-    apk add --no-cache --virtual .build-dependencies python make g++ && \
+    apk add --no-cache --virtual .build-dependencies python3 make g++ && \
     mkdir -p node_modules && chown -R node:node .
 
 
@@ -14,7 +14,7 @@ COPY package.json .
 COPY yarn.lock .
 RUN \
   # Build and separate all dependancies required for production
-  yarn install --production && cp -R node_modules production_node_modules \
+  yarn install --production --frozen-lockfile && cp -R node_modules production_node_modules \
   # Build all modules, including `devDependencies`
   && yarn install \
   && yarn cache clean
@@ -29,7 +29,7 @@ COPY --chown=node:node --from=dependencies /app/node_modules ./node_modules
 COPY --chown=node:node . .
 USER node
 EXPOSE 9300
-CMD node -r esm ./app.js
+CMD node ./app.js
 
 
 ### Stage 3 - Test
@@ -46,4 +46,4 @@ COPY --from=dependencies /app/production_node_modules ./node_modules
 COPY --chown=node:node . .
 USER node
 EXPOSE 9300
-CMD node -r esm ./app.js
+CMD node ./app.js

Dockerfile

@@ -1,43 +1,28 @@
 /* eslint no-restricted-syntax: [0, "ForInStatement"] */
 
 import _ from 'lodash';
-import fs from 'fs';
+import { existsSync, readFileSync } from 'fs';
 import http from 'http';
 import https from 'https';
-import axios from 'axios';
 import express from 'express';
 import bodyParser from 'body-parser';
-import queryString from 'query-string';
-import dataTools from '@tidepool/data-tools';
-import { Registry, Counter } from 'prom-client';
-import logMaker from './log';
+import { createTerminus } from '@godaddy/terminus';
+import { exportTimeout, register, logMaker } from './lib/utils.js';
+import { getUserData, getUserReport, postUserReport } from './lib/handlers/index.js';
 
-const log = logMaker('app.js', { level: process.env.DEBUG_LEVEL || 'info' });
-
-const { createTerminus } = require('@godaddy/terminus');
-
-const client = require('prom-client');
-
-const { collectDefaultMetrics } = client;
-const register = new Registry();
-
-collectDefaultMetrics({ register });
-
-const createCounter = (name, help, labelNames) => new Counter({
-  name, help, labelNames, registers: [register],
+export const log = logMaker('app.js', {
+  level: process.env.DEBUG_LEVEL || 'info',
 });
 
-const statusCount = createCounter('tidepool_export_status_count', 'The number of errors for each status code.', ['status_code', 'export_format']);
-
 function maybeReplaceWithContentsOfFile(obj, field) {
   const potentialFile = obj[field];
-  if (potentialFile != null && fs.existsSync(potentialFile)) {
+  if (potentialFile != null && existsSync(potentialFile)) {
     // eslint-disable-next-line no-param-reassign
-    obj[field] = fs.readFileSync(potentialFile).toString();
+    obj[field] = readFileSync(potentialFile).toString();
   }
 }
 
-const config = {};
+export const config = {};
 config.httpPort = process.env.HTTP_PORT;
 config.httpsPort = process.env.HTTPS_PORT;
 if (process.env.HTTPS_CONFIG) {
@@ -50,134 +35,27 @@ if (process.env.HTTPS_CONFIG) {
 if (!config.httpPort) {
   config.httpPort = 9300;
 }
-config.exportTimeout = _.defaultTo(parseInt(process.env.EXPORT_TIMEOUT, 10), 120000);
+config.exportTimeout = exportTimeout;
 log.info(`Export download timeout set to ${config.exportTimeout} ms`);
 
 const app = express();
 
 app.get('/metrics', async (req, res) => {
   res.set('Content-Type', register.contentType);
-  res.end(register.metrics());
+  res.end(await register.metrics());
 });
 
-function buildHeaders(request) {
-  if (request.headers['x-tidepool-session-token']) {
-    return {
-      headers: {
-        'x-tidepool-session-token': request.headers['x-tidepool-session-token'],
-      },
-    };
-  }
-  return {};
-}
-
-app.use(bodyParser.urlencoded({
-  extended: false,
-}));
-
-app.get('/export/:userid', async (req, res) => {
-  // Set the timeout for the request. Make it 10 seconds longer than
-  // our configured timeout to give the service time to cancel the API data
-  // request, and close the outgoing data stream cleanly.
-  req.setTimeout(config.exportTimeout + 10000);
-
-  const queryData = [];
-
-  let logString = `Requesting download for User ${req.params.userid}`;
-  if (req.query.bgUnits) {
-    logString += ` in ${req.query.bgUnits}`;
-  }
-  if (req.query.startDate) {
-    queryData.startDate = req.query.startDate;
-    logString += ` from ${req.query.startDate}`;
-  }
-  if (req.query.endDate) {
-    queryData.endDate = req.query.endDate;
-    logString += ` until ${req.query.endDate}`;
-  }
-  if (req.query.restricted_token) {
-    queryData.restricted_token = req.query.restricted_token;
-    logString += ' with restricted_token';
-  }
-  log.info(logString);
-
-  const exportFormat = req.query.format;
-
-  try {
-    const cancelRequest = axios.CancelToken.source();
-
-    const requestConfig = buildHeaders(req);
-    requestConfig.responseType = 'stream';
-    requestConfig.cancelToken = cancelRequest.token;
-    const dataResponse = await axios.get(`${process.env.API_HOST}/data/${req.params.userid}?${queryString.stringify(queryData)}`, requestConfig);
-    log.debug(`Downloading data for User ${req.params.userid}...`);
-
-    const processorConfig = { bgUnits: req.query.bgUnits || 'mmol/L' };
-
-    let writeStream = null;
+app.use(
+  bodyParser.urlencoded({
+    extended: false,
+  }),
+);
 
-    if (exportFormat === 'json') {
-      res.attachment('TidepoolExport.json');
-      writeStream = dataTools.jsonStreamWriter();
-
-      dataResponse.data
-        .pipe(dataTools.jsonParser())
-        .pipe(dataTools.splitPumpSettingsData())
-        .pipe(dataTools.tidepoolProcessor(processorConfig))
-        .pipe(writeStream)
-        .pipe(res);
-    } else {
-      res.attachment('TidepoolExport.xlsx');
-      writeStream = dataTools.xlsxStreamWriter(res, processorConfig);
-
-      dataResponse.data
-        .pipe(dataTools.jsonParser())
-        .pipe(dataTools.splitPumpSettingsData())
-        .pipe(dataTools.tidepoolProcessor(processorConfig))
-        .pipe(writeStream);
-    }
-
-    // Create a timeout timer that will let us cancel the incoming request gracefully if
-    // it's taking too long to fulfil.
-    const timer = setTimeout(() => {
-      res.emit('timeout', config.exportTimeout);
-    }, config.exportTimeout);
-
-    // Wait for the stream to complete, by wrapping the stream completion events in a Promise.
-    try {
-      await new Promise((resolve, reject) => {
-        dataResponse.data.on('end', resolve);
-        dataResponse.data.on('error', (err) => reject(err));
-        res.on('error', (err) => reject(err));
-        res.on('timeout', async () => {
-          statusCount.inc({ status_code: 408, export_format: exportFormat });
-          reject(new Error('Data export request took too long to complete. Cancelling the request.'));
-        });
-      });
-      statusCount.inc({ status_code: 200, export_format: exportFormat });
-      log.debug(`Finished downloading data for User ${req.params.userid}`);
-    } catch (e) {
-      log.error(`Error while downloading: ${e}`);
-      // Cancel the writeStream, rather than let it close normally.
-      // We do this to show error messages in the downloaded files.
-      writeStream.cancel();
-      cancelRequest.cancel('Data export timed out.');
-    }
-
-    clearTimeout(timer);
-  } catch (error) {
-    if (error.response && error.response.status === 403) {
-      statusCount.inc({ status_code: 403, export_format: exportFormat });
-      res.status(error.response.status).send('Not authorized to export data for this user.');
-      log.error(`${error.response.status}: ${error}`);
-    } else {
-      statusCount.inc({ status_code: 500, export_format: exportFormat });
-      res.status(500).send('Server error while processing data. Please contact Tidepool Support.');
-      log.error(`500: ${error}`);
-    }
-  }
-});
+app.use(bodyParser.json());
 
+app.get('/export/:userid', getUserData());
+app.get('/export/report/:userid', getUserReport());
+app.post('/export/report/:userid', postUserReport());
 
 function beforeShutdown() {
   return new Promise((resolve) => {
@@ -208,7 +86,9 @@ if (config.httpPort) {
 
 if (config.httpsPort) {
   if (_.isEmpty(config.httpsConfig)) {
-    log.error('SSL endpoint is enabled, but no valid config was found. Exiting.');
+    log.error(
+      'SSL endpoint is enabled, but no valid config was found. Exiting.',
+    );
     process.exit(1);
   } else {
     const server = https.createServer(config.httpsConfig, app);