Merge pull request #359 from mocks-server/release

Release v3.5.0

.eslintignore

@@ -6,4 +6,5 @@
 /packages/*/dist
 /packages/*/coverage
 /test/core-e2e/src/fixtures
+/test/core-e2e-legacy/src/fixtures
 /test/main-e2e/src/fixtures

.eslintrc.cjs

@@ -57,6 +57,7 @@ module.exports = {
         describe: true,
         expect: true,
         it: true,
+        fetch: false,
       },
       plugins: ["jest", "no-only-tests"],
       extends: ["plugin:jest/recommended"],

.github/workflows/build.yml

@@ -84,6 +84,8 @@ jobs:
             ${{ runner.os }}-pnpm-store-
       - name: Install dependencies
         run: pnpm install
+      - name: Generate graph
+        run: pnpm run graph -- --file=graph.json
       - name: Lint
         run: pnpm run lint
   test-unit:

mocks/admin-api-client-data-provider-e2e-mocks/mocks/routes/users.js

@@ -6,13 +6,15 @@ module.exports = [
     variants: [
       {
         id: "1",
+        handler: "json",
         response: {
           status: 200,
           body: [{ email: "[email protected]" }],
         },
       },
       {
         id: "2",
+        handler: "json",
         response: {
           status: 200,
           body: [{ email: "[email protected]" }],

mocks/admin-api-client-unit-mocks/mocks/routes/users.js

@@ -6,13 +6,15 @@ module.exports = [
     variants: [
       {
         id: "1",
+        handler: "json",
         response: {
           status: 200,
           body: [{ email: "[email protected]" }],
         },
       },
       {
         id: "2",
+        handler: "json",
         response: {
           status: 200,
           body: [{ email: "[email protected]" }],

package.json

@@ -51,7 +51,7 @@
     "cypress": "9.7.0",
     "cypress-fail-fast": "3.4.1",
     "deepmerge": "4.2.2",
-    "eslint": "8.15.0",
+    "eslint": "8.19.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-jest": "26.4.6",
     "eslint-plugin-no-only-tests": "2.6.0",

packages/admin-api-client/CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 ### Breaking change
 
+## [5.0.2] - 2022-07-05
+
+### Changed
+- refactor: Rename fetch variable into crossFetch
+
 ## [5.0.1] - 2022-06-03
 
 ### Changed

packages/admin-api-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mocks-server/admin-api-client",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "Client of @mocks-server/plugin-admin-api",
   "keywords": [
     "mocks-server",

packages/admin-api-client/sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.organization=mocks-server
 sonar.projectKey=mocks-server_main_admin-api-client
 sonar.projectName=admin-api-client
-sonar.projectVersion=5.0.1
+sonar.projectVersion=5.0.2
 
 sonar.javascript.file.suffixes=.js
 sonar.sourceEncoding=UTF-8

packages/admin-api-client/src/entities.js

@@ -1,4 +1,4 @@
-import fetch from "cross-fetch";
+import crossFetch from "cross-fetch";
 
 import {
   DEFAULT_BASE_PATH,
@@ -47,11 +47,11 @@ class Fetcher {
   }
 
   _read() {
-    return fetch(this.url).then(handleResponse);
+    return crossFetch(this.url).then(handleResponse);
   }
 
   _patch(data) {
-    return fetch(this.url, {
+    return crossFetch(this.url, {
       method: "PATCH",
       body: JSON.stringify(data),
       headers: {
@@ -61,13 +61,13 @@ class Fetcher {
   }
 
   _delete() {
-    return fetch(this.url, {
+    return crossFetch(this.url, {
       method: "DELETE",
     }).then(handleResponse);
   }
 
   _create(data) {
-    return fetch(this.url, {
+    return crossFetch(this.url, {
       method: "POST",
       body: JSON.stringify(data),
       headers: {

packages/admin-api-client/test/index.spec.js

@@ -170,14 +170,14 @@ describe("react-admin-client methods used with node", () => {
         {
           id: "get-user:1",
           routeId: "get-user",
-          handler: "default",
+          handler: "json",
           response: { body: [{ email: "[email protected]" }], status: 200 },
           delay: null,
         },
         {
           id: "get-user:2",
           routeId: "get-user",
-          handler: "default",
+          handler: "json",
           response: { body: [{ email: "[email protected]" }], status: 200 },
           delay: null,
         },
@@ -191,7 +191,7 @@ describe("react-admin-client methods used with node", () => {
       expect(data).toEqual({
         id: "get-user:2",
         routeId: "get-user",
-        handler: "default",
+        handler: "json",
         response: { body: [{ email: "[email protected]" }], status: 200 },
         delay: null,
       });

packages/core/CHANGELOG.md

@@ -10,6 +10,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [3.5.0] - 2022-07-05
+
+### Added
+- feat(#335): Pass only response property from variants to route variant handlers having the "version" property defined as "4". If it has another value, pass the whole variant object (for backward compatibility)
+- feat(#336): Add "Json" and "Middleware" variant handlers.
+- feat: Support defining the response preview in the v4 handlers as "preview" property. Keep "plainResponsePreview" for backward compatibility in old handlers.
+- feat: Support "deprecated" property in route handlers. Add an alert whenever any route variant uses a deprecated handler
+
+### Changed
+- feat: Log requests in the middleware added by the Mock class, so it has not to be logged in every different handler.
+
 ## [3.4.0] - 2022-07-01
 
 ### Added

packages/core/jest.config.js

@@ -26,7 +26,7 @@ module.exports = {
 
   // The glob patterns Jest uses to detect test files
   testMatch: ["<rootDir>/test/**/*.spec.js"],
-  // testMatch: ["<rootDir>/test/**/Core.spec.js"],
+  // testMatch: ["<rootDir>/test/**/mocks/helpers.spec.js"],
 
   // The test environment that will be used for testing
   testEnvironment: "node",

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mocks-server/core",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Pluggable mock server supporting multiple route variants and mocks",
   "keywords": [
     "mocks",

packages/core/sonar-project.properties

@@ -1,7 +1,7 @@
 sonar.organization=mocks-server
 sonar.projectKey=mocks-server_main_core
 sonar.projectName=core
-sonar.projectVersion=3.4.0
+sonar.projectVersion=3.5.0
 
 sonar.javascript.file.suffixes=.js
 sonar.sourceEncoding=UTF-8

packages/core/src/mocks/Mock.js

@@ -29,7 +29,8 @@ class Mock {
         : [routeVariant.method];
       methods.forEach((method) => {
         const httpMethod = HTTP_METHODS[method.toUpperCase()];
-        this._router[httpMethod](routeVariant.url, (_req, _res, next) => {
+        this._router[httpMethod](routeVariant.url, (req, _res, next) => {
+          this._logger.info(`Request ${req.method} => ${req.url} | req: ${req.id}`);
           const delay = routeVariant.delay !== null ? routeVariant.delay : this._getDelay();
           if (delay > 0) {
             this._logger.verbose(`Applying delay of ${delay}ms to route variant "${this._id}"`);

packages/core/src/mocks/Mocks.js

@@ -108,6 +108,7 @@ class Mocks {
       mocksDefinitions: this._mocksDefinitions,
       alerts: this._alertsMocks,
       logger: this._loggerLoadMocks,
+      loggerRoutes: this._loggerRoutes,
       routeVariants: this._routesVariants,
       getGlobalDelay: this.getDelay,
     });
@@ -212,6 +213,7 @@ class Mocks {
       getGlobalDelay: this.getDelay,
       alerts,
       logger: this._loggerLoadMocks,
+      loggerRoutes: this._loggerRoutes,
     });
   }
 

packages/core/src/mocks/helpers.js

@@ -8,8 +8,9 @@ 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 { flatten, compact } = require("lodash");
+const { flatten, compact, isUndefined } = require("lodash");
 
+const { getDataFromVariant, getPreview } = require("../routes-handlers/helpers");
 const CustomCore = require("../CustomCore");
 const Mock = require("./Mock");
 const {
@@ -135,11 +136,12 @@ function getPlainRoutes(routes, routesVariants) {
 
 function getPlainRoutesVariants(routesVariants) {
   return routesVariants.map((routeVariant) => {
+    const preview = getPreview(routeVariant);
     return {
       id: routeVariant.variantId,
       routeId: routeVariant.routeId,
       handler: routeVariant.constructor.id,
-      response: routeVariant.plainResponsePreview,
+      response: isUndefined(preview) ? null : preview,
       delay: routeVariant.delay,
     };
   });
@@ -200,6 +202,7 @@ function getVariantHandler({
   const variantNamespace = variantId || getVariantId(route.id, variantIndex);
   const routeVariantLogger = loggerRoutes.namespace(variantNamespace);
   const routeVariantAlerts = alertsRoutes.collection(variantNamespace);
+  const handlersAlerts = alertsRoutes.collection("handlers");
   const routeVariantCustomCore = new CustomCore({
     core,
     logger: routeVariantLogger,
@@ -215,15 +218,23 @@ function getVariantHandler({
   }
 
   try {
+    const variantArgument = getDataFromVariant(variant, Handler);
+    if (Handler.deprecated) {
+      handlersAlerts.set(
+        Handler.id,
+        `Handler '${Handler.id}' is deprecated and will be removed in next major version. Consider using another handler. https://www.mocks-server.org/docs/guides-migrating-from-v3#route-variants-handlers`
+      );
+    }
     routeHandler = new Handler(
       {
-        ...variant,
+        ...variantArgument,
         variantId,
         url: route.url,
         method: route.method,
       },
       routeVariantCustomCore
     );
+    // TODO, do not add properties to handler. Store it in "handler" property
     routeHandler.delay = getRouteHandlerDelay(variant, route);
     routeHandler.id = variant.id;
     routeHandler.variantId = variantId;
@@ -248,6 +259,7 @@ function getRouteVariants({
 }) {
   let routeIds = [];
   alerts.clean();
+  alertsRoutes.clean();
   return compact(
     flatten(
       routesDefinitions.map((route, index) => {
@@ -304,6 +316,7 @@ function getMock({
   mocksDefinitions,
   routeVariants,
   logger,
+  loggerRoutes,
   getGlobalDelay,
   alerts,
 }) {
@@ -335,7 +348,7 @@ function getMock({
         routeVariants,
         alerts
       ),
-      logger,
+      logger: loggerRoutes,
       getDelay: getGlobalDelay,
     });
   } catch (error) {
@@ -344,7 +357,14 @@ function getMock({
   return mock;
 }
 
-function getMocks({ mocksDefinitions, alerts, logger, routeVariants, getGlobalDelay }) {
+function getMocks({
+  mocksDefinitions,
+  alerts,
+  logger,
+  loggerRoutes,
+  routeVariants,
+  getGlobalDelay,
+}) {
   alerts.clean();
   let errorsProcessing = 0;
   let ids = [];
@@ -360,6 +380,7 @@ function getMocks({ mocksDefinitions, alerts, logger, routeVariants, getGlobalDe
         routeVariants,
         getGlobalDelay,
         logger,
+        loggerRoutes,
         alerts: alertsMock,
       });
       if (!mock) {

packages/core/src/mocks/validations.js

@@ -12,6 +12,8 @@ const Ajv = require("ajv");
 const { compact } = require("lodash");
 const betterAjvErrors = require("better-ajv-errors").default;
 
+const { getDataFromVariant, isVersion4 } = require("../routes-handlers/helpers");
+
 const ajv = new Ajv({ allErrors: true });
 
 const HTTP_METHODS = {
@@ -117,6 +119,7 @@ const routesSchema = {
             ],
           },
         },
+        // TODO, require "response" in all variants to be an object, do not allow additionalProperties
         required: ["id"],
       },
     },
@@ -282,17 +285,25 @@ function variantValidationErrors(route, variant, Handler) {
     return null;
   }
   const variantValidator = ajv.compile(Handler.validationSchema);
-  const isValid = variantValidator(variant);
+  const dataToCheck = getDataFromVariant(variant, Handler);
+  const dataMessage = isVersion4(Handler) ? "Invalid 'response' property:" : "";
+  const isValid = variantValidator(dataToCheck);
   if (!isValid) {
+    let validationMessage;
+    try {
+      validationMessage = validationSingleMessage(
+        Handler.validationSchema,
+        dataToCheck || {},
+        variantValidator.errors
+      );
+    } catch (error) {
+      validationMessage = " Wrong type";
+    }
     const idTrace = variant && variant.id ? `${traceId(variant.id)} ` : "";
     return {
       message: `Variant ${idTrace}in route ${traceId(
         route.id
-      )} is invalid: ${validationSingleMessage(
-        Handler.validationSchema,
-        variant,
-        variantValidator.errors
-      )}`,
+      )} is invalid: ${dataMessage}${validationMessage}`,
       errors: variantValidator.errors,
     };
   }