handle versioning semantically

Author: scottqueen-bixal

src/app.js

@@ -2,13 +2,16 @@ const express = require('express');
 const apiDataGovFilter = require('./api-data-gov-filter');
 const db = require('./db');
 const logger = require('./logger');
+const router = express.Router();
+const routesVersioning = require('express-routes-versioning')();
 
 const app = express();
 
 if (process.env.NODE_ENV != 'test') {
   app.use(logger);
 }
 app.use(apiDataGovFilter);
+app.use(router);
 
 const formatDateForDataPoint = (dataPoint) => {
   if (dataPoint.date) {
@@ -51,7 +54,8 @@ const fetchData = (req, res) => {
       id: dataPoint.id,
       date: formatDateForDataPoint(dataPoint),
       report_name: dataPoint.report_name,
-      report_agency: dataPoint.report_agency
+      report_agency: dataPoint.report_agency,
+      version: dataPoint.version
     }, dataPoint.data));
     const filteredResponse = filterDownloadResponse(response, params);
     res.json(filteredResponse);
@@ -70,8 +74,59 @@ app.get('/', (req, res) => {
     current_time: new Date()
   });
 });
-app.get('/v1.1/domain/:domain/reports/:reportName/data', checkDomainFilter);
-app.get('/v1.1/agencies/:reportAgency/reports/:reportName/data', fetchData);
-app.get('/v1.1/reports/:reportName/data', fetchData);
+
+// we need to support legacy route
+// app.get('/v1.1/domain/:domain/reports/:reportName/data', checkDomainFilter);
+// app.get('/v1.1/agencies/:reportAgency/reports/:reportName/data', fetchData);
+// app.get('/v1.1/reports/:reportName/data', fetchData);
+
+// We need a way to set versions without breaking the request
+// Right now if we update '/v1/reports/:reportName/data' to '/v2/reports/:reportName/data' anyone requesting from '/v1/reports/:reportName/data' will have a broken application
+
+// middleware
+router.use('/v:version/', function(req, res, next) {
+    console.log('req', req.params.version)
+    const version = req.params.version;
+    req.version = version
+    next();
+});
+
+router.get('/v:version/reports/:reportName/data',
+routesVersioning({
+   "1.1.0": respondV1, // legacy
+   "~1.2.0": fetchData,
+}, NoMatchFoundCallback));
+
+router.get('/v:version/:domain/reports/:reportName/data',
+routesVersioning({
+   "1.1.0": respondDomainV1, // legacy
+   "~1.2.0": checkDomainFilter,
+}, NoMatchFoundCallback));
+
+router.get('/v:version/:reportAgency/reports/:reportName/data',
+routesVersioning({
+   "1.1.0": respondV1, // legacy
+   "~1.2.0": fetchData,
+}, NoMatchFoundCallback));
+
+function NoMatchFoundCallback(req, res) {
+  res.status(404).send("Version not found. See https://analytics.usa.gov/developer");
+}
+
+// v1
+function respondV1(req, res) {
+  req.params.version = '1.1'
+  // TODO - report this message to response
+  console.log('v1 is deprecated. Use v2 instead. See https://analytics.usa.gov/developer')
+  return fetchData(req, res)
+}
+
+function respondDomainV1(req, res) {
+  req.params.version = '1.1'
+  // TODO - report this message to response
+  console.log('v1 is deprecated. Use v2 instead. See https://analytics.usa.gov/developer')
+  return checkDomainFilter(req, res)
+}
+
 
 module.exports = app;