Callbacks

docs/guides/cli.md

@@ -15,7 +15,7 @@ prism mock https://raw.githack.com/OAI/OpenAPI-Specification/master/examples/v3.
 ●  note      DELETE     http://127.0.0.1:4010/pets/10
 ```
 
-The generated paths will have their parameters (query or path) bolded and in color. 
+The generated paths will have their parameters (query or path) bolded and in color.
 
 Then in another tab, you can hit the HTTP server with your favorite HTTP client.
 

examples/callbacks/README.md

@@ -0,0 +1,48 @@
+# Mocking Callbacks with Prism
+
+This example shows how Prism mocks callbacks.
+
+## Environment setup
+
+Start service exposing `/subscribe` callback (referred as `4010`)
+
+```bash
+prism mock -p 4010 service.oas3.yaml
+``` 
+
+Start service exposing `/notify` operation used for receiving callback requests (referred as `4011`)
+
+```bash
+prism mock -p 4011 client.oas3.yaml
+``` 
+
+## Run!
+
+Subscribe to callback
+
+```bash
+curl -v -H'Content-type: application/json' -d'{ "url": "http://localhost:4011/notify", "token": "ssecurre" }' http://127.0.0.1:4010/subscribe
+```
+
+Now, the console for `4010` service should show:
+```$xslt
+[HTTP SERVER] post /subscribe ℹ  info      Request received
+    [NEGOTIATOR] ℹ  info      Request contains an accept header: */*
+    [VALIDATOR] ✔  success   The request passed the validation rules. Looking for the best response
+    [NEGOTIATOR] ✔  success   Found a compatible content for */*
+    [NEGOTIATOR] ✔  success   Responding with the requested status code 202
+    [CALLBACK] ℹ  info      actions: Making request to http://localhost:4011/notify?token=ssecurre...
+    [CALLBACK] ℹ  info      actions: Request finished
+```
+
+The console of `4011` service:
+
+```
+[HTTP SERVER] post /notify ℹ  info      Request received
+    [NEGOTIATOR] ℹ  info      Request contains an accept header: */*
+    [VALIDATOR] ✔  success   The request passed the validation rules. Looking for the best response
+    [NEGOTIATOR] ✔  success   Found a compatible content for */*
+    [NEGOTIATOR] ✔  success   Responding with the requested status code 200
+```
+
+After subscribing via `/subscribe`, Prism successfully invoked `/notify` callback with mocked payload.

examples/callbacks/client.oas3.yaml

@@ -0,0 +1,25 @@
+openapi: 3.0.0
+paths:
+  /notify:
+    post:
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                action:
+                  type: string
+                payload:
+                  type: string
+              required:
+              - action
+              - payload
+      responses:
+        '200':
+          content:
+            text/plain:
+              examples:
+                ok:
+                  value: 'ok'

examples/callbacks/service.oas3.yaml

@@ -0,0 +1,52 @@
+openapi: 3.0.0
+paths:
+  /subscribe:
+    post:
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                url:
+                  type: string
+                  format: uri
+                token:
+                  type: string
+              required:
+              - url
+              - token
+      responses:
+        '202':
+          content:
+            text/plain:
+              examples:
+                ok:
+                  value: 'ok'
+
+      callbacks:
+        actions:
+          '{$request.body#/url}?token={$request.body#/token}':
+            post:
+              requestBody:
+                required: true
+                content:
+                  application/json:
+                    schema:
+                      type: object
+                      properties:
+                        action:
+                          type: string
+                        payload:
+                          type: string
+                      required:
+                        - action
+                        - payload
+              responses:
+                200:
+                  content:
+                    text/plain:
+                      examples:
+                        ok:
+                          value: 'ok'

packages/cli/package.json

@@ -7,7 +7,6 @@
   },
   "bugs": "https://github.com/stoplightio/prism/issues",
   "dependencies": {
-    "@stoplight/http-spec": "^2.2.3",
     "@stoplight/prism-core": "^3.1.1",
     "@stoplight/prism-http-server": "^3.1.1",
     "chokidar": "^3.2.1",

packages/cli/src/const/options.ts

@@ -5,4 +5,5 @@ export const LOG_COLOR_MAP = {
   'HTTP SERVER': { index: 0, color: chalk.bgYellowBright },
   NEGOTIATOR: { index: 1, color: chalk.bgCyanBright },
   VALIDATOR: { index: 1, color: chalk.bgGreenBright },
+  CALLBACK: { index: 1, color: chalk.bgBlue },
 };

packages/cli/src/util/__tests__/colorizer.spec.ts

@@ -3,16 +3,17 @@ import {
   PRE_PARAM_VALUE_TAG,
   POST_PARAM_VALUE_TAG,
   attachTagsToParamsValues,
-  transformPathParamsValues
+  transformPathParamsValues,
 } from '../colorizer';
 
 describe('colorizer', () => {
-
   describe('transformPathParamsValues()', () => {
     it('colorizes tagged values of query params', () => {
       const path = `/no_auth/pets/findByStatus?status=${PRE_PARAM_VALUE_TAG}sold,pending${POST_PARAM_VALUE_TAG}`;
 
-      expect(transformPathParamsValues(path, chalk.bold.blue)).toBe(`/no_auth/pets/findByStatus?status=${chalk.bold.blue('sold,pending')}`);
+      expect(transformPathParamsValues(path, chalk.bold.blue)).toBe(
+        `/no_auth/pets/findByStatus?status=${chalk.bold.blue('sold,pending')}`
+      );
     });
 
     it('colorizes tagged values of path params', () => {
@@ -23,30 +24,25 @@ describe('colorizer', () => {
   });
 
   describe('attachTagsToParamsValues()', () => {
-
     describe('adding tags', () => {
       it('tags multiple values', () => {
         const values = {
-          status: [
-            'available',
-            'pending',
-            'sold'
-          ]
+          status: ['available', 'pending', 'sold'],
         };
 
         expect(attachTagsToParamsValues(values)).toStrictEqual({
           status: [
             `${PRE_PARAM_VALUE_TAG}available${POST_PARAM_VALUE_TAG}`,
             `${PRE_PARAM_VALUE_TAG}pending${POST_PARAM_VALUE_TAG}`,
-            `${PRE_PARAM_VALUE_TAG}sold${POST_PARAM_VALUE_TAG}`
-          ]
+            `${PRE_PARAM_VALUE_TAG}sold${POST_PARAM_VALUE_TAG}`,
+          ],
         });
       });
 
       describe('tagging single values', () => {
         it('tags string values', () => {
           const valuesOfParams = {
-            name: 'dignissimos'
+            name: 'dignissimos',
           };
 
           expect(attachTagsToParamsValues(valuesOfParams)).toStrictEqual({
@@ -56,11 +52,11 @@ describe('colorizer', () => {
 
         it('tags numeric values', () => {
           const valuesOfParams = {
-            petId: 170
+            petId: 170,
           };
 
           expect(attachTagsToParamsValues(valuesOfParams)).toStrictEqual({
-            petId: `${PRE_PARAM_VALUE_TAG}170${POST_PARAM_VALUE_TAG}`
+            petId: `${PRE_PARAM_VALUE_TAG}170${POST_PARAM_VALUE_TAG}`,
           });
         });
       });
@@ -71,6 +67,5 @@ describe('colorizer', () => {
 
       expect(attachTagsToParamsValues(values)).toStrictEqual({});
     });
-
   });
 });