Logging Prism's decisions.

CHANGELOG.md

@@ -18,7 +18,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ### Features
 
 - Prism now has got a static example fallback in case the `dynamic` flag is not enabled #347
-- Prism can now validate servers #351
 
 # 3.0.0-alpha.14 (2019-06-11)
 

package.json

@@ -43,6 +43,8 @@
     "@types/lodash": "^4.14.132",
     "@types/nock": "^10.0.3",
     "@types/node": "^12.0.2",
+    "@types/pino": "^5.8.7",
+    "@types/split2": "^2.1.6",
     "@types/signale": "^1.2.1",
     "@types/type-is": "^1.6.2",
     "chance": "^1.0.18",

packages/cli/README.md

@@ -14,6 +14,7 @@
 # Usage
 
 <!-- usage -->
+
 ```sh-session
 $ npm install -g @stoplight/prism-cli
 $ prism COMMAND
@@ -25,13 +26,15 @@ USAGE
   $ prism COMMAND
 ...
 ```
+
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-* [`prism help [COMMAND]`](#prism-help-command)
-* [`prism mock SPEC`](#prism-mock-spec)
+
+- [`prism help [COMMAND]`](#prism-help-command)
+- [`prism mock SPEC`](#prism-mock-spec)
 
 ## `prism help [COMMAND]`
 
@@ -70,6 +73,12 @@ OPTIONS
 _See code: [src/commands/mock.ts](https://github.com/stoplightio/prism/blob/v3.0.0-alpha.16/src/commands/mock.ts)_
 <!-- commandsstop -->
 
+## Running in production
+
+When running in development mode (which happens when the `NODE_ENV` environment variable is not set to `production`) or the `-m` flag is set to false, both the HTTP Server and the CLI (which is responsible of parsing and showing the received logs on the screen) will run within the same process.
+
+Processing logs slows down the process significantly. If you're planning to use the CLI in production (for example in a Docker Container) we recommend to run the CLI with the `-m` flag or set the `NODE_ENV` variable to `production`. In this way, the CLI and the HTTP server will run on two different processes, so that logs processing, parsing and printing does not slow down the http requests processing.
+
 ## Development
 
 ### Debugging

packages/cli/package.json

@@ -13,6 +13,7 @@
     "@stoplight/prism-core": "^3.0.0-alpha.16",
     "@stoplight/prism-http-server": "^3.0.0-alpha.16",
     "signale": "^1.4.0",
+    "split2": "^3.1.1",
     "tslib": "^1.0.0",
     "urijs": "^1.19.1"
   },

packages/cli/src/commands/__tests__/mock.spec.ts

@@ -1,38 +1,64 @@
-import { createServer } from '../../util/createServer';
+import { createMultiProcessPrism, createSingleProcessPrism } from '../../util/createServer';
 import Mock from '../mock';
-
-const listenMock = jest.fn().mockReturnValue('http://localhost:1000');
-
-jest.mock('../../util/createServer', () => ({
-  createServer: jest.fn(() => ({ listen: listenMock, prism: { resources: [{ method: 'get', path: '/test' }] } })),
-}));
+jest.mock('../../util/createServer');
 
 describe('mock command', () => {
   beforeEach(() => {
-    (createServer as jest.Mock).mockClear();
+    (createSingleProcessPrism as jest.Mock).mockClear();
+    (createMultiProcessPrism as jest.Mock).mockClear();
   });
-
   test('starts mock server', async () => {
     await Mock.run(['/path/to']);
-    expect(createServer).toHaveBeenLastCalledWith('/path/to', { mock: { dynamic: false } });
-    expect(listenMock).toHaveBeenLastCalledWith(4010, '127.0.0.1');
+    expect(createMultiProcessPrism).not.toHaveBeenCalled();
+    expect(createSingleProcessPrism).toHaveBeenLastCalledWith({
+      spec: '/path/to',
+      dynamic: false,
+      host: '127.0.0.1',
+      port: 4010,
+    });
   });
 
   test('starts mock server on custom port', async () => {
     await Mock.run(['-p', '666', '/path/to']);
-    expect(createServer).toHaveBeenLastCalledWith('/path/to', { mock: { dynamic: false } });
-    expect(listenMock).toHaveBeenLastCalledWith(666, '127.0.0.1');
+    expect(createMultiProcessPrism).not.toHaveBeenCalled();
+    expect(createSingleProcessPrism).toHaveBeenLastCalledWith({
+      spec: '/path/to',
+      dynamic: false,
+      host: '127.0.0.1',
+      port: 666,
+    });
   });
 
   test('starts mock server on custom host', async () => {
     await Mock.run(['-h', '0.0.0.0', '/path/to']);
-    expect(createServer).toHaveBeenLastCalledWith('/path/to', { mock: { dynamic: false } });
-    expect(listenMock).toHaveBeenLastCalledWith(4010, '0.0.0.0');
+    expect(createMultiProcessPrism).not.toHaveBeenCalled();
+    expect(createSingleProcessPrism).toHaveBeenLastCalledWith({
+      spec: '/path/to',
+      dynamic: false,
+      host: '0.0.0.0',
+      port: 4010,
+    });
   });
 
   test('starts mock server on custom host and port', async () => {
     await Mock.run(['-p', '666', '-h', '0.0.0.0', '/path/to']);
-    expect(createServer).toHaveBeenLastCalledWith('/path/to', { mock: { dynamic: false } });
-    expect(listenMock).toHaveBeenLastCalledWith(666, '0.0.0.0');
+    expect(createMultiProcessPrism).not.toHaveBeenCalled();
+    expect(createSingleProcessPrism).toHaveBeenLastCalledWith({
+      spec: '/path/to',
+      dynamic: false,
+      host: '0.0.0.0',
+      port: 666,
+    });
+  });
+
+  test('starts mock server with multiprocess option ', async () => {
+    await Mock.run(['-p', '666', '-m', '-h', '0.0.0.0', '/path/to']);
+    expect(createSingleProcessPrism).not.toHaveBeenCalled();
+    expect(createMultiProcessPrism).toHaveBeenLastCalledWith({
+      spec: '/path/to',
+      dynamic: false,
+      host: '0.0.0.0',
+      port: 666,
+    });
   });
 });

packages/cli/src/commands/mock.ts

@@ -1,43 +1,22 @@
 import { Command } from '@oclif/command';
-import * as signale from 'signale';
 import { ARGS, FLAGS } from '../const/options';
-import { createServer } from '../util/createServer';
+import { createMultiProcessPrism, createSingleProcessPrism } from '../util/createServer';
 
 export default class Server extends Command {
   public static description = 'Start a mock server with the given spec file';
-  public static flags = { port: FLAGS.port, host: FLAGS.host, dynamic: FLAGS.dynamic };
+  public static flags = FLAGS;
   public static args = [ARGS.spec];
 
-  public async run() {
-    const signaleInteractiveInstance = new signale.Signale({ interactive: true });
-
+  public run() {
     const {
-      flags: { port, dynamic, host },
+      flags: { port, dynamic, host, multiprocess },
       args: { spec },
     } = this.parse(Server);
 
-    signaleInteractiveInstance.await('Starting Prism…');
-
-    if (dynamic) {
-      signale.star('Dynamic example generation enabled.');
+    if (multiprocess) {
+      return createMultiProcessPrism({ dynamic, port, host, spec });
     }
 
-    const server = createServer(spec, { mock: { dynamic } });
-    try {
-      const address = await server.listen(port, host);
-
-      if (server.prism.resources.length === 0) {
-        signaleInteractiveInstance.fatal('No operations found in the current file.');
-        this.exit(1);
-      }
-
-      signaleInteractiveInstance.success(`Prism is listening on ${address}`);
-
-      server.prism.resources.forEach(resource => {
-        signale.note(`${resource.method.toUpperCase().padEnd(10)} ${address}${resource.path}`);
-      });
-    } catch (e) {
-      signaleInteractiveInstance.fatal(e.message);
-    }
+    return createSingleProcessPrism({ dynamic, port, host, spec });
   }
 }

packages/cli/src/const/options.ts

@@ -1,9 +1,10 @@
 import { flags as oflags } from '@oclif/command';
+import chalk from 'chalk';
 
 export const ARGS = {
   spec: {
     name: 'spec',
-    description: 'Path to a spec file',
+    description: 'Path to a spec file. Can be both a file or a fetchable resource on the web',
     required: true,
   },
 };
@@ -27,4 +28,17 @@ export const FLAGS = {
     description: 'Dynamically generate examples.',
     default: false,
   }),
+
+  multiprocess: oflags.boolean({
+    char: 'm',
+    description: 'Fork the http server from the CLI',
+    default: process.env.NODE_ENV === 'production',
+  }),
+};
+
+export const LOG_COLOR_MAP = {
+  CLI: chalk.bgWhiteBright,
+  'HTTP SERVER': chalk.bgYellowBright,
+  MOCKER: chalk.bgBlueBright,
+  HTTP: chalk.bgGreenBright,
 };