feat: api versioning (#96)

* feat: API versioning

* feat: Add versioning logic to root level

* Add type; fix todo

* Disable token refresh on dev

* Make the api versioning backward compatible; keep v1 route active

packages/backend/helpers/versionMiddleware.ts

@@ -0,0 +1,33 @@
+import { Request, Response, NextFunction } from 'express';
+
+type API_VERSIONS = 'v1' | 'v2' | 'latest';
+
+const DEFAULT_API_VERSION: API_VERSIONS = 'v1';
+
+declare global {
+    namespace Express {
+        interface Request {
+            version: API_VERSIONS;
+        }
+    }
+}
+
+const versionMiddleware = () => async (req: Request, _res: Response, next: () => any) => {
+    const version = (req.headers['x-api-version'] as API_VERSIONS) || DEFAULT_API_VERSION;
+    req.version = version;
+    next();
+};
+
+type VersionMap = {
+    [k in API_VERSIONS]?: any;
+};
+
+export const manageRouterVersioning = (versionMap: VersionMap) => {
+    return (req: Request, res: Response, next: NextFunction) => {
+        const { version } = req;
+        const fn = versionMap[version] || versionMap[DEFAULT_API_VERSION]; // call the v1 function as default
+        fn.call(this, req, res, next);
+    };
+};
+
+export default versionMiddleware;

packages/backend/index.ts

@@ -1,14 +1,12 @@
-import express, { Express } from 'express';
+import express, { Express, Request, Response } from 'express';
 // Note: Sentry should be initialized as early in your app as possible.
 import * as Sentry from '@sentry/node';
 import config from './config';
-import indexRouter, { crmRouter } from './routes/index';
-import revertAuthMiddleware from './helpers/authMiddleware';
+import indexRouter from './routes/index';
 import cors from 'cors';
 import cron from 'node-cron';
 import AuthService from './services/auth';
-import { connectionRouter } from './routes/connection';
-import metadataRouter from './routes/metadata';
+import versionMiddleware, { manageRouterVersioning } from './helpers/versionMiddleware';
 
 const rateLimit = require('express-rate-limit');
 const limiter = rateLimit({
@@ -38,6 +36,7 @@ Sentry.init({
     // of transactions for performance monitoring.
     // We recommend adjusting this value in production
     tracesSampleRate: 0.1,
+    enabled: process.env.NODE_ENV !== 'development',
 });
 
 // RequestHandler creates a separate execution context, so that all
@@ -50,10 +49,27 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 app.use(cors());
 app.use(limiter);
-app.use('/', indexRouter);
-app.use('/v1/crm', cors(), revertAuthMiddleware(), crmRouter);
-app.use('/v1/connection', cors(), revertAuthMiddleware(), connectionRouter);
-app.use('/v1/metadata', cors(), metadataRouter);
+app.use(versionMiddleware());
+
+// TODO: Just to test versions. Remove later
+const testv2Router = (_req: Request, res: Response) => {
+    res.send({ data: 'v2 hit' });
+};
+
+app.use(
+    '/',
+    manageRouterVersioning({
+        v1: indexRouter,
+        v2: testv2Router,
+    })
+);
+app.use(
+    '/v1',
+    manageRouterVersioning({
+        v1: indexRouter,
+        v2: testv2Router,
+    })
+);
 
 // The error handler must be before any other error middleware and after all controllers
 app.use(Sentry.Handlers.errorHandler());
@@ -63,6 +79,8 @@ app.listen(config.PORT, () => {
     // Refresh tokens on a schedule.
     // TODO: do this optimistically.
     cron.schedule(`*/2 * * * *`, async () => {
-        await AuthService.refreshOAuthTokensForThirdParty();
+        if (process.env.NODE_ENV !== 'development') {
+            await AuthService.refreshOAuthTokensForThirdParty();
+        }
     });
 }).setTimeout(600000);

packages/backend/routes/index.ts

@@ -1,8 +1,13 @@
 import prisma from '../prisma/client';
 import axios from 'axios';
 import express from 'express';
-import crmRouter from './crm';
+import cors from 'cors';
+
+import crmRouter from './v1/crm';
 import config from '../config';
+import revertAuthMiddleware from '../helpers/authMiddleware';
+import connectionRouter from './v1/connection';
+import metadataRouter from './v1/metadata';
 
 const router = express.Router();
 
@@ -52,5 +57,8 @@ router.post('/slack-alert', async (req, res) => {
     }
 });
 
+router.use('/crm', cors(), revertAuthMiddleware(), crmRouter);
+router.use('/connection', cors(), revertAuthMiddleware(), connectionRouter);
+router.use('/metadata', cors(), metadataRouter);
+
 export default router;
-export { crmRouter };

packages/backend/routes/connection/index.ts → packages/backend/routes/v1/connection/index.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import ConnectionService from '../../services/connection';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import ConnectionService from '../../../services/connection';
 
 const connectionRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/auth.ts → packages/backend/routes/v1/crm/auth.ts

@@ -1,10 +1,10 @@
 import axios from 'axios';
 import express from 'express';
-import config from '../../config';
+import config from '../../../config';
 import qs from 'qs';
-import AuthService from '../../services/auth';
-import prisma, { Prisma } from '../../prisma/client';
-import ConnectionService from '../../services/connection';
+import AuthService from '../../../services/auth';
+import prisma, { Prisma } from '../../../prisma/client';
+import ConnectionService from '../../../services/connection';
 
 const authRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/company.ts → packages/backend/routes/v1/crm/company.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import CompanyService from '../../services/company';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import CompanyService from '../../../services/company';
 
 const companyRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/contact.ts → packages/backend/routes/v1/crm/contact.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import ContactService from '../../services/contact';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import ContactService from '../../../services/contact';
 
 const contactRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/deal.ts → packages/backend/routes/v1/crm/deal.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import DealService from '../../services/deal';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import DealService from '../../../services/deal';
 
 const dealRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/event.ts → packages/backend/routes/v1/crm/event.ts

@@ -1,6 +1,6 @@
 import express from 'express';
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import EventService from '../../services/event';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import EventService from '../../../services/event';
 
 const eventRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/lead.ts → packages/backend/routes/v1/crm/lead.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import LeadService from '../../services/lead';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import LeadService from '../../../services/lead';
 
 const leadRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/note.ts → packages/backend/routes/v1/crm/note.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import NoteService from '../../services/note';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import NoteService from '../../../services/note';
 
 const noteRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/proxy.ts → packages/backend/routes/v1/crm/proxy.ts

@@ -1,6 +1,6 @@
 import express from 'express';
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import ProxyService from '../../services/proxy';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import ProxyService from '../../../services/proxy';
 
 const proxyRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/task.ts → packages/backend/routes/v1/crm/task.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import TaskService from '../../services/task';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import TaskService from '../../../services/task';
 
 const taskRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/crm/user.ts → packages/backend/routes/v1/crm/user.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
-import tenantMiddleware from '../../helpers/tenantIdMiddleware';
-import UserService from '../../services/user';
+import tenantMiddleware from '../../../helpers/tenantIdMiddleware';
+import UserService from '../../../services/user';
 
 const userRouter = express.Router({ mergeParams: true });
 

packages/backend/routes/metadata.ts → packages/backend/routes/v1/metadata.ts

@@ -1,5 +1,5 @@
 import express from 'express';
-import prisma from '../prisma/client';
+import prisma from '../../prisma/client';
 
 const metadataRouter = express.Router();