mocks-server / main Goto Github PK

Can we please get the printout of the full request with headers into the log?

Describe the bug

Error loading ajv-errors dependency, validations won't be executed. Visit https://mocks-server.org/docs/how-to-fix-ajv-errors-installation for further info.: Unexpected token ':'
         SyntaxError: Unexpected token ':'
             at new Function (<anonymous>)
             at Ajv.compileSchema (/src/node_modules/@mocks-server/core/node_modules/ajv/dist/compile/index.js:90:30)...

This error is documented in https://www.mocks-server.org/docs/how-to-fix-ajv-errors-installation/ but none of the proposed solutions worked.

Only forcing both of these package versions fixed it:

        "ajv": "8.9.0",
        "ajv-errors": "3.0.0",

To Reproduce
Updating ajv to 8.9.10 and having "@mocks-server/main": "2.6.2"

Expected behavior
No errors happen on validation.

It is desirable to expose all cors options, so users can provide filters to apply the middleware only to some requests, etc. The admin-api-plugin should also always apply cors, even when it is disabled globally.

If provided, the validation should be more strict and mocks or routes containing validation errors should be completely ignored. It would be useful also to have a validation command that could be executed separately in order to check validations and return an error in case there are validation errors. This could be useful in pipelines, to be executed as a kind of linter, for example.

Is your feature request related to a problem? Please describe.
I would like to add the mock server to an Nx monorepo which includes some apps and libs. I would like to add as a new app then using the main.ts file I would like to start the mocksServer. I found a way using the MocksServer Core dependency, but also found it is archived. It is possible to access through the @mocks-server/main internal package?

const { Core } = require("@mocks-server/core");
const AdminApi = require("@mocks-server/plugin-admin-api");
const InquirerCli = require("@mocks-server/plugin-inquirer-cli");

const mocksServer = new Core({
  onlyProgrammaticOptions: false,
  plugins: [AdminApi, InquirerCli]
});

mocksServer
  .init({
    port: 3500,
    delay: 1000,
    log: "debug"
  })
  .then(server.start);

Describe the solution you'd like
Ability to use a Nx typescript based project in order to integrate into the Nx monorepo project. Could be a better approach to do it?

Hi, thanks for a great library! I have a question - have you considered creating a set of TypeScript type definitions for it? Or maybe someone has already created it, but I didn't find it?
Thank you very much for responding.

Currently, the register method of plugins is the only one which does not support asynchrony. It is desirable to allow plugins to return a Promise in the register method.

Is your feature request related to a problem? Please describe.
I would need to pass query params and headers to a mocked request, I tried to pass the params in the url but it is not possible because the mock-server failed.

Describe the solution you'd like
Would be great to have the possibility to pass them to the requests. I also have the same endpoint for two requests differentiated by HTTP query params grant_type

The repository property of packages is not displayed in NPM. It has not the right format probably.

It is desirable to avoid possible conflicts in alerts namespaces, so one plugin alerts methods couldn't impact on other pliguin alerts in case there is a coincidence in the beginning of their namespace.

Importing @mocks-server/admin-api-client in node does not work. It works only if you import @mocks-server/admin-api-client/dist/index.cjs.

It is desirable to change the main property of the package.json to point to that file instead of the index.umd file, which should imported specifically when requiring this package directly in a script tag

It is desirable to upgrade package dependencies.

Currently, custom route handlers validators can be defined only as an ajv schema. It would be useful to allow defining validators as a function, that would receive the route variant. The function should return an string with errors or null in case the route variant is valid.

The project currently has a good unit test coverage, but It is desirable to add also end-to-end tests. This tests should start really the mocks server and execute tests requesting really against the api.

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Invalid configuration option: node

Currently, node-watch only watches the mocks folder. If you are importing files outside this folder, changes in those files are not producing a "hot reload". It is desirable to allow to define extra folders to be watched.

In order to improve the scalability of the project, the main package should only contain dependencies to "core" and other "plugins" that will be distributed by default with this main distribution.

Doing this, it would be easier to develop new "plugins", and maybe add them to this main distribution. Anyway, adding the possibility to develop "plugins" for adding new features to the core functionality will be a better approach for the project.

A possible approach to achieve this could be splitting the logic in next packages:

• core - Responsible of:
  • Get user options. Should also provide a method to allow plugins adding their own options.
  • Expose methods for creating behaviors.
  • Expose methods for administration, such as change current behavior, change delay, change logs level, etc.
  • Expose getters for current behaviors and fixtures collections and models.
  • Emit events when a setting changes, the server is restarted, behaviors or fixtures are updated, etc.
  • Read mocks folder, register fixtures and create automatically default behavior.
  • Watch for file changes and update behaviors and fixtures when a change occurs.
  • Create http server serving mocks.
  • Expose a method for adding custom Routers to the server.
  • Emit events with server logs.
• admin-api - Responsible of:
  • Registering the administration api as a new custom Router in the provided core.
  • Use core methods to change administration settings.
  • Use core getters to return administration settings.
  • Use core getters to return current behaviors and fixtures collections and models.
• inquirer-cli - Responsible of:
  • Displaying the interactive CLI.
  • Use core methods to change administration settings.
  • Use core getters to display administration settings.
  • Use core getters to display current behaviors and fixtures number.
  • Refresh the CLI when corresponds, listening to core events.
• main - Responsible of:
  • Create a new instantance of the "core", and create new instances of "admin-api" and "inquirer-cli" passing to them the core reference.
  • Start all pieces.

Here goes a draft:

const MocksServer = require("@mocks-server/core");
const AdminApi = require("@mocks-server/admin-api");
const InquirerCli = require("@mocks-server/inquirer-cli");

const mocksServer = new MocksServer();

// plugins add their own options to core;
const adminApi = new AdminApi(mocksServer);
const inquirerCli = new InquirerCli(mocksServer);

mocksServer.getOptions()
  .then(options => {
    // plugins are initialized with user options.
    // These is needed to allow them register custom Routes based on user options, etc., before server starts.
    return Promise.all([
      adminApi.init(options),
      inquirerCli.init(options)
    ]);
  })
  .then(() => {
    // mocks server is started
    return mocksServer.start();
  });

Expose an API about plugins, allowing to list, start/stop them, install more, etc. This API should be also exposed also in the admin-api-plugin.

It is desirable to add a command (maybe a plugin) to validate the server responses using a OpenApi document, which would be a kind of "contract tests". Further investigation is needed in order to find the better approach to implement it.

After refactoring the code as indicated in the #23 issue, making it pluggable, plugins code should be migrated to their own repositories.

There are two new repositories created for this purpose:

• https://github.com/mocks-server/plugin-admin-api
• https://github.com/mocks-server/plugin-inquirer-cli

Documentation about how to create and register plugins should be added to the website, as describe in the mocks-server/website#19

It is desirable to publish a PostMan collection/workspace with the administration API specifications

It is desirable to provide a mechanism to allow to add or modify existing fixtures programmatically, and even to save the modifications to the file system.

Icons should be used in CLI only when the system support them

Legacy mode should be removed in next major version.

It would be interesting to implement a session mechanism linked to a current feature.

It is desirable to allow to define different variants depending of values received as queryStrings. It needs a further investigation in order to decide which would be the better approach, as the main structure of the routes properties would change.

Currently, the jsonBodyParser middleware is added to the whole server. It would be useful to allow to deactivate it using an option, or a property in routes or variants.

It is desirable to create a plugin providing a web UI.

Expose an about API providing information about current version, etc.

In some scenarios, it is desirable to start more than one Mocks Server while running Cypress. This package should be able to control more than one Mocks Server.

In some projects, the package returns an error due to an installation bug:

internal/modules/cjs/loader.js:888
  throw err;
  ^

Error: Cannot find module 'ajv/dist/compile/codegen'
Require stack:
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/ajv-errors/dist/index.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/validations.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/Mock.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/helpers.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/Mocks.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/Core.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/index.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/main/lib/start.js
- /Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/main/bin/mocks-server
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:885:15)
    at Function.Module._load (internal/modules/cjs/loader.js:730:27)
    at Module.require (internal/modules/cjs/loader.js:957:19)
    at require (internal/modules/cjs/helpers.js:88:18)
    at Object.<anonymous> (/Users/javierbrea/proyectos/data-provider/axios/node_modules/ajv-errors/dist/index.js:4:19)
    at Module._compile (internal/modules/cjs/loader.js:1068:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1097:10)
    at Module.load (internal/modules/cjs/loader.js:933:32)
    at Function.Module._load (internal/modules/cjs/loader.js:774:14)
    at Module.require (internal/modules/cjs/loader.js:957:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/ajv-errors/dist/index.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/validations.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/Mock.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/helpers.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/mocks/Mocks.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/src/Core.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/core/index.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/main/lib/start.js',
    '/Users/javierbrea/proyectos/data-provider/axios/node_modules/@mocks-server/main/bin/mocks-server'
  ]
}
npm ERR! code ELIFECYCLE
npm ERR! errno 1

My stack is Next v12 and TypeScript; On v12, there is an SWC option that enables us to have a better performance in the app. To enable SWC, we have to remove the babel configuration to enable SWC. However, running the app without babel configuration is throwing out errors.

It is complaining that it cannot understand the es6 import statements.

How can I use babel without babelrc? Can we have some sort of babel configuration that is only available in the mocks.config.js?

It is desirable to add OpenApi 3.0 api definitions, and Swagger UI, which could be available at the admin/swagger path.

When adding traces about loaded plugins, etc. built-in or native plugins should be differentiate from the installed ones.

Describe the bug
When trying the middleware example presented in the docs there is an error when starting up the server:

TypeError: this._router[METHODS[routeVariant.method]] is not a function at _routesVariants.forEach (.../node_modules/@mocks-server/core/src/mocks/Mock.js:34:49) at Array.forEach (<anonymous>) at Mock._initRouter (.../node_modules/@mocks-server/core/src/mocks/Mock.js:33:26) at new Mock (.../node_modules/@mocks-server/core/src/mocks/Mock.js:28:10) at _mocks._mocksDefinitions.map (.../node_modules/@mocks-server/core/src/mocks/Mocks.js:83:18) at Array.map (<anonymous>) at Mocks._processMocks (.../node_modules/@mocks-server/core/src/mocks/Mocks.js:81:8) at Mocks.load (.../node_modules/@mocks-server/core/src/mocks/Mocks.js:147:10) at Orchestrator._onLoadMocks (.../node_modules/@mocks-server/core/src/Orchestrator.js:54:19) at EventEmitter.emit (events.js:198:13)

To Reproduce
Use the content of the middlewares.js file in the documentation and add either of the routes to the 'base' mock setup.
When you start the server the above error will occur.
If you add method: "GET" to the route, it works, however it looks like a wildcard doesn't work for that field (*)

Expected behavior
The server loads and the middleware route fires on all requests

** Operating system, Node.js an npm versions, or browser version (please complete the following information):**

• OS: macOS Catalina 10.15.7
• Node.js: v10.21.0
• npm: 6.14.4

It is desirable to add e2e tests checking methods for Mocks Server v2

It is desirable to add an option to allow loading routes from extra folders. This is interesting in some scenarios, as in monorepos which may want to divide the code of the API mocks, for example. All of these extra folders should be also watched, and the babelRegister option should also work in them.

A mechanism to know line numbers should be provided in tracer.store.

It is desirable to add a filter option to the default route handler. It should work in the same way that the filter option does in the proxy handlers. It should accept a function that would receive the req object. If the function returns true, or a resolved Promise, then the route would process the request, otherwise it won't.

This feature was originally proposed in #282

It would be useful to allow to define different log levels for different routes and variants.

Add a log option to commands. If provided, a log should be printed. Default should be true.

Currently, changing settings is an async task, as it is made using events internally. It is desirable to provide a method for changing settings synchronously somehow, or at least provide feedback about when a setting has been really changed, because some plugins (are the plugin-admin-api) need to know when the setting has been changed in order to response to the API request.

It is desirable that current concept of server "features" is renamed into "behaviors" for better comprehension.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency @data-provider/axios to v5.0.2
• chore(deps): update dependency @testing-library/cypress to v8.0.7
• chore(deps): update pnpm/action-setup action to v2.2.4
• fix(deps): update babel monorepo (@babel/core, @babel/eslint-parser, @babel/preset-env, @babel/preset-react, @babel/preset-typescript, @babel/register)
• fix(deps): update dependency cross-fetch to v3.1.8
• fix(deps): update dependency inquirer to v8.2.5
• fix(deps): update dependency react-redux to v7.2.9
• chore(deps): update dependency babel-loader to v8.3.0
• chore(deps): update dependency eslint to v8.44.0
• chore(deps): update dependency start-server-and-test to v1.15.4
• chore(deps): update dependency typescript to v4.9.5
• chore(deps): update dependency webpack to v5.88.1
• chore(deps): update typescript-eslint monorepo to v5.61.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• fix(deps): update dependency cosmiconfig to v7.1.0
• fix(deps): update dependency swagger-ui-dist to v4.19.1
• chore(deps): update actions/setup-node action to v3
• chore(deps): update andstor/file-existence-action action to v2
• chore(deps): update dependency @rollup/plugin-babel to v6
• chore(deps): update dependency @rollup/plugin-commonjs to v23
• chore(deps): update dependency @rollup/plugin-commonjs to v24
• chore(deps): update dependency @rollup/plugin-commonjs to v25
• chore(deps): update dependency @rollup/plugin-node-resolve to v14
• chore(deps): update dependency @rollup/plugin-node-resolve to v15
• chore(deps): update dependency @rollup/plugin-typescript to v10
• chore(deps): update dependency @rollup/plugin-typescript to v11
• chore(deps): update dependency @rollup/plugin-typescript to v9
• chore(deps): update dependency @testing-library/cypress to v9
• chore(deps): update dependency axios to v1
• chore(deps): update dependency babel-loader to v9
• chore(deps): update dependency babel-plugin-module-resolver to v5
• chore(deps): update dependency cypress to v10
• chore(deps): update dependency cypress to v11
• chore(deps): update dependency cypress to v12
• chore(deps): update dependency cypress-fail-fast to v4
• chore(deps): update dependency cypress-fail-fast to v5
• chore(deps): update dependency cypress-fail-fast to v6
• chore(deps): update dependency cypress-fail-fast to v7
• chore(deps): update dependency eslint-plugin-jest to v27
• chore(deps): update dependency eslint-plugin-no-only-tests to v3
• chore(deps): update dependency husky to v8
• chore(deps): update dependency lint-staged to v13
• chore(deps): update dependency prettier to v3
• chore(deps): update dependency react-scripts to v5
• chore(deps): update dependency rollup to v3
• chore(deps): update dependency serve to v14
• chore(deps): update dependency sinon to v14
• chore(deps): update dependency sinon to v15
• chore(deps): update dependency start-server-and-test to v2
• chore(deps): update dependency typescript to v5
• chore(deps): update dependency wait-on to v7
• chore(deps): update jest monorepo to v28 (major) (babel-jest, jest)
• chore(deps): update jest monorepo to v29 (major) (babel-jest, jest)
• chore(deps): update nrwl monorepo to v14 (major) (@nrwl/cli, @nrwl/eslint-plugin-nx, @nrwl/tao, @nrwl/workspace)
• chore(deps): update nrwl monorepo to v15 (major) (@nrwl/cli, @nrwl/eslint-plugin-nx, @nrwl/tao, @nrwl/workspace)
• chore(deps): update nrwl monorepo to v16 (major) (@nrwl/eslint-plugin-nx, @nrwl/tao, @nrwl/workspace)
• chore(deps): update nrwl/nx-set-shas action to v3
• chore(deps): update react monorepo to v18 (major) (react, react-dom)
• fix(deps): update dependency @data-provider/react to v2
• fix(deps): update dependency @hapi/boom to v10
• fix(deps): update dependency commander to v10
• fix(deps): update dependency commander to v11
• fix(deps): update dependency commander to v9.5.0
• fix(deps): update dependency cosmiconfig to v8
• fix(deps): update dependency cross-fetch to v4
• fix(deps): update dependency express-request-id to v2
• fix(deps): update dependency express-request-id to v3
• fix(deps): update dependency fs-extra to v11
• fix(deps): update dependency inquirer to v9
• fix(deps): update dependency inquirer-autocomplete-prompt to v2
• fix(deps): update dependency inquirer-autocomplete-prompt to v3
• fix(deps): update dependency node-emoji to v2
• fix(deps): update dependency react-redux to v8
• fix(deps): update dependency swagger-ui-dist to v5
• fix(deps): update dependency update-notifier to v6
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency rollup to v2.79.1
• chore(deps): update dependency eslint-plugin-jest to v26.9.0

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update nrwl monorepo to v13.10.6 (@nrwl/cli, @nrwl/eslint-plugin-nx, @nrwl/tao, @nrwl/workspace)
• chore(deps): update dependency @rollup/plugin-commonjs to v22

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

It is desirable to allow configuration using environment variables.

The approach could be similar to the Cypress one, which accepts environment variables defined in upper snake case, with a project namespace prefix:

MOCKS_SERVER_PORT=4000 npm run mocks-server

It would be great if compatibility with the dotenv-flow package is added too.

It is desirable to include Plugin Proxy in main distribution in order to support route variants of type "proxy".

Currently the plainResponsePreview of a route variant returns "function" if the response is an express middleware, and an object if it is a static variant. It is desirable to always return the same type. A property type could be added, and it should have function value for the first case, and static for the second one.

Posting a large JSON payload causes "request entity too large" error and there is no configuration to up this limit.

I believe the default body-parser for the JSON is 100k. There is an option to set a limit but it isn't exposed to the mocks-server user.

It is desirable to add metrics property to the core, providing stats about received requests, sent responses, response times, etc.

Currently plugins can define options, but not low level configuration options. It is desirable to provide a mechanism to plugins to define new low level configuration options and to access to them easily.