chore(modernize): Spin out base class for Controllers

lib/routes/admin-api/archive.js

@@ -1,20 +1,19 @@
 'use strict';
 
-const { Router } = require('express');
+const Controller = require('../controller');
 
 const logger = require('../../logger')('/admin-api/archive.js');
 const { FEATURE_REVIVED } = require('../../event-type');
 const extractUser = require('../../extract-user');
 
-class ArchiveController {
+class ArchiveController extends Controller {
     constructor({ featureToggleStore, eventStore }) {
-        const router = Router();
+        super();
-        this._router = router;
         this.featureToggleStore = featureToggleStore;
         this.eventStore = eventStore;
 
-        router.get('/features', this.getArchivedFeatures.bind(this));
+        this.get('/features', this.getArchivedFeatures);
-        router.post('/revive/:name', this.reviveFeatureToggle.bind(this));
+        this.post('/revive/:name', this.reviveFeatureToggle);
     }
 
     async getArchivedFeatures(req, res) {
@@ -37,10 +36,6 @@ class ArchiveController {
             return res.status(500).end();
         }
     }
-
-    router() {
-        return this._router;
-    }
 }
 
 module.exports = ArchiveController;

lib/routes/admin-api/event.js

@@ -1,35 +1,35 @@
 'use strict';
 
-const { Router } = require('express');
+const Controller = require('../controller');
 
 const eventDiffer = require('../../event-differ');
 const version = 1;
 
-module.exports.router = function(config) {
+class EventController extends Controller {
-    const { eventStore } = config.stores;
+    constructor({ eventStore }) {
-    const router = Router();
+        super();
+        this.eventStore = eventStore;
+        this.get('/', this.getEvents);
+        this.get('/:name', this.getEventsForToggle);
+    }
 
-    router.get('/', (req, res) => {
+    async getEvents(req, res) {
-        eventStore.getEvents().then(events => {
+        const events = await this.eventStore.getEvents();
         eventDiffer.addDiffs(events);
         res.json({ version, events });
-        });
+    }
-    });
 
-    router.get('/:name', (req, res) => {
+    async getEventsForToggle(req, res) {
         const toggleName = req.params.name;
-        eventStore.getEventsFilterByName(toggleName).then(events => {
+        const events = await this.eventStore.getEventsFilterByName(toggleName);
+
         if (events) {
             eventDiffer.addDiffs(events);
-                res.json({
+            res.json({ toggleName, events });
-                    toggleName,
-                    events,
-                });
         } else {
             res.status(404).json({ error: 'Could not find events' });
         }
-        });
+    }
-    });
+}
 
-    return router;
+module.exports = EventController;
-};

lib/routes/admin-api/index.js

@@ -1,36 +1,32 @@
 'use strict';
 
-const { Router } = require('express');
+const Controller = require('../controller');
-
 const features = require('./feature.js');
 const ArchiveController = require('./archive.js');
-const events = require('./event.js');
+const EventController = require('./event.js');
 const strategies = require('./strategy');
 const metrics = require('./metrics');
 const user = require('./user');
 const apiDef = require('./api-def.json');
 
-class AdminApi {
+class AdminApi extends Controller {
     constructor(config) {
-        const router = Router();
+        super();
-        this._router = router;
 
-        router.get('/', (req, res) => res.json(apiDef));
+        const stores = config.stores;
-        router.use('/features', features.router(config));
+
-        router.use('/archive', new ArchiveController(config.stores).router());
+        this.app.get('/', this.index);
-        router.use('/strategies', strategies.router(config));
+        this.app.use('/features', features.router(config));
-        router.use('/events', events.router(config));
+        this.app.use('/archive', new ArchiveController(stores).router());
-        router.use('/metrics', metrics.router(config));
+        this.app.use('/strategies', strategies.router(config));
-        router.use('/user', user.router(config));
+        this.app.use('/events', new EventController(stores).router());
+        this.app.use('/metrics', metrics.router(config));
+        this.app.use('/user', user.router(config));
     }
 
     index(req, res) {
         res.json(apiDef);
     }
-
-    router() {
-        return this._router;
-    }
 }
 
 module.exports = AdminApi;

lib/routes/controller.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const { Router } = require('express');
+/**
+ * Base class for Controllers to standardize binding to express Router.
+ */
+class Controller {
+    constructor() {
+        const router = Router();
+        this.app = router;
+    }
+
+    get(path, handler) {
+        this.app.get(path, handler.bind(this));
+    }
+
+    post(path, handler) {
+        this.app.post(path, handler.bind(this));
+    }
+
+    router() {
+        return this.app;
+    }
+}
+
+module.exports = Controller;