Easy cookie (#72)

Author: Eomm

README.md

@@ -1,8 +1,8 @@
 # Light my Request
 
 [![Greenkeeper badge](https://badges.greenkeeper.io/fastify/light-my-request.svg)](https://greenkeeper.io/)
-
-[![Build Status](https://travis-ci.org/fastify/light-my-request.svg?branch=master)](https://travis-ci.org/fastify/light-my-request) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+[![Build Status](https://travis-ci.org/fastify/light-my-request.svg?branch=master)](https://travis-ci.org/fastify/light-my-request)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
 
 Injects a fake HTTP request/response into a node HTTP server for simulating server logic, writing tests, or debugging.  
 Does not use a socket connection so can be run against an inactive server (server not in listen mode).  
@@ -146,6 +146,7 @@ Injects a fake request into an HTTP server.
   - `authority` - a string specifying the HTTP HOST header value to be used if no header is provided, and the `url`
     does not include an authority component. Defaults to `'localhost'`.
   - `headers` - an optional object containing request headers.
+  - `cookies` - an optional object containing key-value pairs that will be encoded and added to `cookie` header. If the header is already set, the data will be appended.
   - `remoteAddress` - an optional string specifying the client remote address. Defaults to `'127.0.0.1'`.
   - `payload` - an optional request payload. Can be a string, Buffer, Stream or object. If the payload is string, Buffer or Stream is used as is as the request payload. Oherwise it is serialized with `JSON.stringify` forcing the request to have the `Content-type` equal to `application/json`
   - `query` - an optional object containing query parameters.
@@ -173,6 +174,7 @@ Injects a fake request into an HTTP server.
     - `rawPayload` - the raw payload as a Buffer.
     - `trailers` - an object containing the response trailers.
     - `json` - a function that parses the `application/json` response payload and returns an object. Throws if the content type does not contain `application/json`.
+    - `cookies` - a getter that parses the `set-cookie` response header and returns an array with all the cookies and their metadata.
 
 Note: You can also pass a string in place of the `options` object as a shorthand for `{url: string, method: 'GET'}`.
 
@@ -184,7 +186,7 @@ Checks if given object `obj` is a *light-my-request* `Request` object.
 
 There are following methods you can used as chaining:
 - `delete`, `get`, `head`, `options`, `patch`, `post`, `put`, `trace`. They will set the HTTP request method and also the request URL.
-- `body`, `headers`, `payload`, `query`. They can be used to set the request options object.
+- `body`, `headers`, `payload`, `query`, `cookies`. They can be used to set the request options object.
 
 And finally you need to call `end`. It has the signature `function (callback)`.
 If you invoke `end` without a callback function, the method will return a promise, thus you can:

index.d.ts

@@ -79,6 +79,7 @@ declare namespace LightMyRequest {
     payload: string
     body: string
     json: () => object
+    cookies: Array<object>
   }
 
   interface Chain {
@@ -94,6 +95,7 @@ declare namespace LightMyRequest {
     headers: (headers: http.IncomingHttpHeaders | http.OutgoingHttpHeaders) => Chain
     payload: (payload: InjectPayload) => Chain
     query: (query: object) => Chain
+    cookies: (query: object) => Chain
     end: (callback?: CallbackFunc) => Chain | Promise<Response>
   }
 }

index.js

@@ -31,6 +31,10 @@ const schema = {
   properties: {
     url: urlSchema,
     path: urlSchema,
+    cookies: {
+      type: 'object',
+      additionalProperties: true
+    },
     headers: {
       type: 'object',
       additionalProperties: true
@@ -143,6 +147,7 @@ httpMethods.forEach(method => {
 
 const chainMethods = [
   'body',
+  'cookies',
   'headers',
   'payload',
   'query'

lib/request.js

@@ -4,6 +4,7 @@
 
 const { Readable } = require('readable-stream')
 const util = require('util')
+const cookie = require('cookie')
 
 const parseURL = require('./parseURL')
 
@@ -27,6 +28,7 @@ function hostHeaderFromURL (parsedURL) {
  * @param {(Object|String)} options.url || options.path
  * @param {String} [options.method='GET']
  * @param {String} [options.remoteAddress]
+ * @param {Object} [options.cookies]
  * @param {Object} [options.headers]
  * @param {Object} [options.query]
  * @param {any} [options.payload]
@@ -50,6 +52,15 @@ function Request (options) {
   this.headers['user-agent'] = this.headers['user-agent'] || 'lightMyRequest'
   this.headers.host = this.headers.host || options.authority || hostHeaderFromURL(parsedURL)
 
+  if (options.cookies) {
+    const { cookies } = options
+    const cookieValues = Object.keys(cookies).map(key => cookie.serialize(key, cookies[key]))
+    if (this.headers.cookie) {
+      cookieValues.unshift(this.headers.cookie)
+    }
+    this.headers.cookie = cookieValues.join('; ')
+  }
+
   this.connection = {
     remoteAddress: options.remoteAddress || '127.0.0.1'
   }

lib/response.js

@@ -4,6 +4,8 @@ const http = require('http')
 const { Writable } = require('readable-stream')
 const util = require('util')
 
+const setCookie = require('set-cookie-parser')
+
 function Response (req, onEnd, reject) {
   http.ServerResponse.call(this, {
     method: req.method,
@@ -107,7 +109,10 @@ function generatePayload (response) {
     headers: response._lightMyRequest.headers,
     statusCode: response.statusCode,
     statusMessage: response.statusMessage,
-    trailers: {}
+    trailers: {},
+    get cookies () {
+      return setCookie.parse(this)
+    }
   }
 
   // Prepare payload and trailers

package.json

@@ -5,7 +5,9 @@
   "main": "index.js",
   "dependencies": {
     "ajv": "^6.10.2",
-    "readable-stream": "^3.4.0"
+    "cookie": "^0.4.0",
+    "readable-stream": "^3.4.0",
+    "set-cookie-parser": "^2.4.1"
   },
   "types": "index.d.ts",
   "devDependencies": {

test/index.test-d.ts

@@ -19,6 +19,7 @@ inject(dispatch, { method: 'get', url: '/' }, (err, res) => {
   expectType<Response>(res)
   console.log(res.payload)
   expectType<Function>(res.json)
+  console.log(res.cookies)
 })
 
 inject(dispatch)

test/test.js

@@ -1046,6 +1046,24 @@ test('chainable api: body method should work correctly', (t) => {
     })
 })
 
+test('chainable api: cookie', (t) => {
+  t.plan(2)
+
+  function dispatch (req, res) {
+    res.writeHead(200, { 'Content-Type': 'text/plain' })
+    res.end(req.headers.cookie)
+  }
+
+  inject(dispatch)
+    .get('http://example.com:8080/hello')
+    .body('test')
+    .cookies({ hello: 'world', fastify: 'rulez' })
+    .end((err, res) => {
+      t.error(err)
+      t.equal(res.body, 'hello=world; fastify=rulez')
+    })
+})
+
 test('chainable api: body method should throw if already invoked', (t) => {
   t.plan(1)
 
@@ -1349,3 +1367,66 @@ function readStream (stream, callback) {
     return callback(Buffer.concat(chunks))
   })
 }
+
+test('send cookie', (t) => {
+  t.plan(3)
+  const dispatch = function (req, res) {
+    res.writeHead(200, { 'Content-Type': 'text/plain' })
+    res.end(req.headers.host + '|' + req.headers.cookie)
+  }
+
+  inject(dispatch, { url: 'http://example.com:8080/hello', cookies: { foo: 'bar', grass: 'àìùòlé' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, 'example.com:8080|foo=bar; grass=%C3%A0%C3%AC%C3%B9%C3%B2l%C3%A9')
+    t.equal(res.rawPayload.toString(), 'example.com:8080|foo=bar; grass=%C3%A0%C3%AC%C3%B9%C3%B2l%C3%A9')
+  })
+})
+
+test('send cookie with header already set', (t) => {
+  t.plan(3)
+  const dispatch = function (req, res) {
+    res.writeHead(200, { 'Content-Type': 'text/plain' })
+    res.end(req.headers.host + '|' + req.headers.cookie)
+  }
+
+  inject(dispatch, {
+    url: 'http://example.com:8080/hello',
+    headers: { cookie: 'custom=one' },
+    cookies: { foo: 'bar', grass: 'àìùòlé' }
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, 'example.com:8080|custom=one; foo=bar; grass=%C3%A0%C3%AC%C3%B9%C3%B2l%C3%A9')
+    t.equal(res.rawPayload.toString(), 'example.com:8080|custom=one; foo=bar; grass=%C3%A0%C3%AC%C3%B9%C3%B2l%C3%A9')
+  })
+})
+
+test('read cookie', (t) => {
+  t.plan(3)
+  const dispatch = function (req, res) {
+    res.setHeader('Set-Cookie', [
+      'type=ninja',
+      'dev=me; Expires=Fri, 17 Jan 2020 20:26:08 -0000; Max-Age=1234; Domain=.home.com; Path=/wow; Secure; HttpOnly; SameSite=Strict'
+    ])
+    res.writeHead(200, { 'Content-Type': 'text/plain' })
+    res.end(req.headers.host + '|' + req.headers.cookie)
+  }
+
+  inject(dispatch, { url: 'http://example.com:8080/hello', cookies: { foo: 'bar' } }, (err, res) => {
+    t.error(err)
+    t.equal(res.payload, 'example.com:8080|foo=bar')
+    t.deepEqual(res.cookies, [
+      { name: 'type', value: 'ninja' },
+      {
+        name: 'dev',
+        value: 'me',
+        expires: new Date('Fri, 17 Jan 2020 20:26:08 -0000'),
+        maxAge: 1234,
+        domain: '.home.com',
+        path: '/wow',
+        secure: true,
+        httpOnly: true,
+        sameSite: 'Strict'
+      }
+    ])
+  })
+})