Merge pull request #79 from mocks-server/feat-78-alerts

Add alerts

Author: javierbrea

.eslintrc.json

@@ -6,7 +6,7 @@
   "parserOptions": { 
     "ecmaVersion": "2018"
   },
-  "plugins": ["prettier"],
+  "plugins": ["prettier", "no-only-tests"],
   "rules": {
     "prettier/prettier": [
       "error",
@@ -16,7 +16,8 @@
       }
     ],
     "no-undef": "error",
-    "no-unused-vars": ["error", { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }]
+    "no-unused-vars": ["error", { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }],
+    "no-only-tests/no-only-tests": [2]
   },
   "extends": ["prettier"],
   "root": true

CHANGELOG.md

@@ -10,7 +10,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [unreleased]
 ### Added
+- feat(#78): Add alerts router
+- chore(lint): Add eslint plugin to avoid only in tests
 ### Changed
+- chore(deps): Update dependencies
+- test(e2e): Move utils to a support folder
+- feat: Add/remove routers on start/stop plugin methods, not in init method.
 ### Fixed
 ### Removed
 

jest.config.js

@@ -25,7 +25,8 @@ module.exports = {
   },
 
   // The glob patterns Jest uses to detect test files
-  testMatch: ["**/test/unit/**/?(*.)+(spec|test).js?(x)"],
+  testMatch: ["<rootDir>/test/unit/**/*.spec.js"],
+  // testMatch: ["<rootDir>/test/unit/**/Plugin.spec.js"],
 
   // The test environment that will be used for testing
   testEnvironment: "node",

jest.e2e.config.js

@@ -5,7 +5,8 @@ module.exports = {
   // Automatically clear mock calls and instances between every test
   clearMocks: true,
 
-  testMatch: ["**/test/e2e/**/?(*.)+(spec|test).js?(x)"],
+  testMatch: ["<rootDir>/test/e2e/**/*.spec.js"],
+  // testMatch: ["<rootDir>/test/e2e/**/stop-plugin.spec.js"],
 
   // Indicates whether the coverage information should be collected while executing the test
   collectCoverage: false,

package-lock.json

@@ -34,13 +34,14 @@
     "@mocks-server/core": ">=1.3.0"
   },
   "dependencies": {
-    "@mocks-server/admin-api-paths": "1.0.8",
+    "@mocks-server/admin-api-paths": "1.1.0",
     "@hapi/boom": "9.1.0",
     "express": "4.17.1"
   },
   "devDependencies": {
-    "@mocks-server/core": "1.5.1",
+    "@mocks-server/core": "1.6.0",
     "eslint": "7.12.1",
+    "eslint-plugin-no-only-tests": "2.4.0",
     "eslint-config-prettier": "6.15.0",
     "eslint-plugin-prettier": "3.1.4",
     "fs-extra": "9.0.1",

package.json

@@ -0,0 +1,70 @@
+/*
+Copyright 2020 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+"use strict";
+
+const express = require("express");
+const Boom = require("@hapi/boom");
+
+const { PLUGIN_NAME } = require("./constants");
+
+class AlertsApi {
+  constructor(core) {
+    this._core = core;
+    this._tracer = core.tracer;
+    this._router = express.Router();
+    this._router.get("/", this.getCollection.bind(this));
+    this._router.get("/:id", this.getModel.bind(this));
+  }
+
+  _parseModel(alert) {
+    return {
+      id: alert.context,
+      context: alert.context,
+      message: alert.message,
+      error: alert.error
+        ? {
+            name: alert.error.name,
+            message: alert.error.message,
+            stack: alert.error.stack,
+          }
+        : null,
+    };
+  }
+
+  _parseCollection() {
+    return this._core.alerts.map(this._parseModel);
+  }
+
+  getCollection(req, res) {
+    this._tracer.verbose(`${PLUGIN_NAME}: Sending alerts | ${req.id}`);
+    res.status(200);
+    res.send(this._parseCollection());
+  }
+
+  getModel(req, res, next) {
+    const id = req.params.id;
+    this._tracer.verbose(`${PLUGIN_NAME}: Sending alert ${id} | ${req.id}`);
+    const foundAlert = this._core.alerts.find((alert) => alert.context === id);
+    if (foundAlert) {
+      res.status(200);
+      res.send(this._parseModel(foundAlert));
+    } else {
+      next(Boom.notFound(`Alert with id "${id}" was not found`));
+    }
+  }
+
+  get router() {
+    return this._router;
+  }
+}
+
+module.exports = AlertsApi;

src/Alerts.js

@@ -16,13 +16,15 @@ const {
   BEHAVIORS,
   ABOUT,
   FIXTURES,
+  ALERTS,
 } = require("@mocks-server/admin-api-paths");
 
 const packageInfo = require("../package.json");
 const DeprecatedApi = require("./deprecated/Api");
 
 const Settings = require("./Settings");
 const Behaviors = require("./Behaviors");
+const Alerts = require("./Alerts");
 const Fixtures = require("./Fixtures");
 const About = require("./About");
 
@@ -41,6 +43,7 @@ class Plugin {
     this._deprecatedApi = new DeprecatedApi(core);
     this._settingsApi = new Settings(this._core);
     this._behaviorsApi = new Behaviors(this._core);
+    this._alertsApi = new Alerts(this._core);
     this._aboutApi = new About(this._core);
     this._fixturesApi = new Fixtures(this._core);
     core.addSetting({
@@ -66,28 +69,34 @@ class Plugin {
 
   async init() {
     await this._deprecatedApi.init();
-    this._core.onChangeSettings(this._onChangeSettings);
     this._initRouter();
+  }
+
+  start() {
+    this._stopListeningOnChangeSettings = this._core.onChangeSettings(this._onChangeSettings);
     this._addDeprecatedRouter();
     this._addRouter();
   }
 
+  stop() {
+    if (this._stopListeningOnChangeSettings) {
+      this._stopListeningOnChangeSettings();
+    }
+    this._removeDeprecatedRouter();
+    this._removeRouter();
+  }
+
   _initRouter() {
     this._router = express.Router();
     this._router.use(SETTINGS, this._settingsApi.router);
     this._router.use(BEHAVIORS, this._behaviorsApi.router);
     this._router.use(ABOUT, this._aboutApi.router);
     this._router.use(FIXTURES, this._fixturesApi.router);
+    this._router.use(ALERTS, this._alertsApi.router);
   }
 
   _addDeprecatedRouter() {
-    if (
-      this._settings.get(ADMIN_API_DEPRECATED_PATHS_OPTION) === false &&
-      this._addedDeprecatedRouter
-    ) {
-      this._core.removeRouter(DEPRECATED_API_PATH, this._deprecatedApi.router);
-      this._addedDeprecatedRouter = false;
-    }
+    this._removeDeprecatedRouter();
     if (
       this._settings.get(ADMIN_API_DEPRECATED_PATHS_OPTION) === true &&
       !this._addedDeprecatedRouter
@@ -97,12 +106,24 @@ class Plugin {
     }
   }
 
+  _removeDeprecatedRouter() {
+    if (this._addedDeprecatedRouter) {
+      this._core.removeRouter(DEPRECATED_API_PATH, this._deprecatedApi.router);
+      this._addedDeprecatedRouter = false;
+    }
+  }
+
   _addRouter() {
-    if (this._previousRoutersPath) {
-      this._core.removeRouter(this._previousRoutersPath, this._router);
+    this._removeRouter();
+    this._routersPath = this._settings.get(ADMIN_API_PATH_OPTION);
+    this._core.addRouter(this._routersPath, this._router);
+  }
+
+  _removeRouter() {
+    if (this._routersPath) {
+      this._core.removeRouter(this._routersPath, this._router);
+      this._routersPath = null;
     }
-    this._previousRoutersPath = this._settings.get(ADMIN_API_PATH_OPTION);
-    this._core.addRouter(this._previousRoutersPath, this._router);
   }
 
   _onChangeSettings(newSettings) {

src/Plugin.js

@@ -8,7 +8,7 @@ http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
 
-const { startServer, stopServer, request } = require("./utils");
+const { startServer, stopServer, request } = require("./support/utils");
 const { version } = require("../../package.json");
 
 describe("about api", () => {
@@ -17,8 +17,8 @@ describe("about api", () => {
     server = await startServer("web-tutorial");
   });
 
-  afterAll(() => {
-    stopServer(server);
+  afterAll(async () => {
+    await stopServer(server);
   });
 
   describe("get /", () => {