feat(core): Improved control flow with times and stopPropagation (#…

…202)
Netflix · Apr 27, 2019 · 2c8231e · 2c8231e
1 parent 604b6a7
commit 2c8231e
Show file tree

Hide file tree

Showing 20 changed files with 917 additions and 216 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -37,6 +37,7 @@
   - [Route Handler](server/route-handler.md)
   - [Request](server/request.md)
   - [Response](server/response.md)
+  - [Event](server/event.md)
 
 - Node Server
 

diff --git a/docs/assets/styles.css b/docs/assets/styles.css
@@ -354,3 +354,8 @@ body .sidebar-toggle span:nth-child(3) {
 .lang-json .token.property {
   color: #e96900;
 }
+
+/****** COPY TO CLIPBOARD ******/
+.docsify-copy-code-button {
+  font-size: 0.7em !important;
+}
diff --git a/docs/server/event.md b/docs/server/event.md
@@ -0,0 +1,29 @@
+# Event
+
+## Properties
+
+### type
+
+_Type_: `String`
+
+The event type. (e.g. `request`, `response`, `beforePersist`)
+
+## Methods
+
+### stopPropagation
+
+If several event listeners are attached to the same event type, they are called in the order in which they were added. If `stopPropagation` is invoked during one such call, no remaining listeners will be called.
+
+**Example**
+
+```js
+server.get('/session/:id').on('beforeResponse', (req, res, event) => {
+  event.stopPropagation();
+  res.setHeader('X-SESSION-ID', 'ABC123');
+});
+
+server.get('/session/:id').on('beforeResponse', (req, res, event) => {
+  // This will never be reached
+  res.setHeader('X-SESSION-ID', 'XYZ456');
+});
+```
diff --git a/docs/server/events-and-middleware.md b/docs/server/events-and-middleware.md
@@ -42,6 +42,7 @@ Fires right before the request goes out.
 | Param | Type                      | Description          |
 | ----- | ------------------------- | -------------------- |
 | req   | [Request](server/request) | The request instance |
+| event | [Event](server/event)     | The event instance   |
 
 **Example**
 
@@ -60,6 +61,7 @@ Fires right before the response materializes and the promise resolves.
 | ----- | --------------------------- | --------------------- |
 | req   | [Request](server/request)   | The request instance  |
 | res   | [Response](server/response) | The response instance |
+| event | [Event](server/event)       | The event instance    |
 
 **Example**
 
@@ -78,6 +80,7 @@ the response materializes and the promise resolves.
 | ----- | --------------------------- | --------------------- |
 | req   | [Request](server/request)   | The request instance  |
 | res   | [Response](server/response) | The response instance |
+| event | [Event](server/event)       | The event instance    |
 
 **Example**
 
@@ -97,6 +100,7 @@ Fires before the request/response gets persisted.
 | --------- | ------------------------- | ------------------------------------ |
 | req       | [Request](server/request) | The request instance                 |
 | recording | `Object`                  | The recording that will be persisted |
+| event     | [Event](server/event)     | The event instance                   |
 
 **Example**
 
@@ -116,6 +120,7 @@ and before the recording materializes into a response.
 | --------- | ------------------------- | ----------------------- |
 | req       | [Request](server/request) | The request instance    |
 | recording | `Object`                  | The retrieved recording |
+| event     | [Event](server/event)     | The event instance      |
 
 **Example**
 
@@ -134,6 +139,7 @@ Fires when any error gets emitted during the request life-cycle.
 | ----- | ------------------------- | -------------------- |
 | req   | [Request](server/request) | The request instance |
 | error | Error                     | The error            |
+| event | [Event](server/event)     | The event instance   |
 
 **Example**
 

diff --git a/docs/server/request.md b/docs/server/request.md
@@ -1,5 +1,90 @@
 # Request
 
+## Properties
+
+### method
+
+_Type_: `String`
+
+The request method. (e.g. `GET`, `POST`, `DELETE`)
+
+### url
+
+_Type_: `String`
+
+The request URL.
+
+### protocol
+
+_Type_: `String`
+
+The request url protocol. (e.g. `http://`, `https:`)
+
+### hostname
+
+_Type_: `String`
+
+The request url host name. (e.g. `localhost`, `netflix.com`)
+
+### port
+
+_Type_: `String`
+
+The request url port. (e.g. `3000`)
+
+### pathname
+
+_Type_: `String`
+
+The request url path name. (e.g. `/session`, `/movies/1`)
+
+### hash
+
+_Type_: `String`
+
+The request url hash.
+
+### headers
+
+_Type_: `Object`
+_Default_: `{}`
+
+The request headers.
+
+### body
+
+_Type_: `any`
+
+The request body.
+
+### query
+
+_Type_: `Object`
+_Default_: `{}`
+
+The request url query parameters.
+
+### params
+
+_Type_: `Object`
+_Default_: `{}`
+
+The matching route's path params.
+
+**Example**
+
+```js
+server.get('/movies/:id').intercept((req, res) => {
+  console.log(req.params.id);
+});
+```
+
+### recordingName
+
+_Type_: `String`
+
+The recording the request should be recorded under.
+
 ## Methods
 
 ### getHeader
@@ -161,88 +246,3 @@ A shortcut method that calls JSON.parse on the request's body.
 ```js
 req.jsonBody();
 ```
-
-## Properties
-
-### method
-
-_Type_: `String`
-
-The request method. (e.g. `GET`, `POST`, `DELETE`)
-
-### url
-
-_Type_: `String`
-
-The request URL.
-
-### protocol
-
-_Type_: `String`
-
-The request url protocol. (e.g. `http://`, `https:`)
-
-### hostname
-
-_Type_: `String`
-
-The request url host name. (e.g. `localhost`, `netflix.com`)
-
-### port
-
-_Type_: `String`
-
-The request url port. (e.g. `3000`)
-
-### pathname
-
-_Type_: `String`
-
-The request url path name. (e.g. `/session`, `/movies/1`)
-
-### hash
-
-_Type_: `String`
-
-The request url hash.
-
-### headers
-
-_Type_: `Object`
-_Default_: `{}`
-
-The request headers.
-
-### body
-
-_Type_: `any`
-
-The request body.
-
-### query
-
-_Type_: `Object`
-_Default_: `{}`
-
-The request url query parameters.
-
-### params
-
-_Type_: `Object`
-_Default_: `{}`
-
-The matching route's path params.
-
-**Example**
-
-```js
-server.get('/movies/:id').intercept((req, res) => {
-  console.log(req.params.id);
-});
-```
-
-### recordingName
-
-_Type_: `String`
-
-The recording the request should be recorded under.