feat: add smooth-plugin-headers (#32)

vripoche · gregberge · commit 1409b4fb2f44 · 2019-07-14T23:39:11.000+02:00
diff --git a/packages/smooth-plugin-headers/README.md b/packages/smooth-plugin-headers/README.md
@@ -0,0 +1,46 @@
+# smooth-plugin-headers
+
+Automatically adds response headers.
+
+## Usage
+
+Edit `smooth.config.js`:
+
+```js
+// smooth.config.js
+module.exports = {
+  plugins: [
+    {
+      resolve: 'smooth-plugin-headers',
+      options: {
+        // Add any options here
+      },
+    }
+  ],
+}
+```
+
+## Options
+
+### headers
+
+Set headers for all maching pages, ReactRouter format can be used (see [path-to-regexp](https://www.npmjs.com/package/path-to-regexp)).  
+Headers entries are merged on differents rules but are overwritten on sames, below rules overwrite above ones.
+
+```js
+// smooth.config.js
+module.exports = {
+  plugins: [
+    {
+      resolve: 'smooth-plugin-headers',
+      options: {
+        headers: {
+          '(.*)': ['Cache-Control: public, max-age=900'],
+          '(*.ico)': ['Cache-Control: public, max-age=2592000'],
+          '/graphql': ['Cache-Control: no-cache'],
+        },
+      },
+    }
+  ],
+}
+```
diff --git a/packages/smooth-plugin-headers/package.json b/packages/smooth-plugin-headers/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "smooth-plugin-headers",
+  "description": "Smooth plugin to add custom headers",
+  "version": "0.1.1-alpha.56",
+  "repository": "https://github.com/smooth-code/smooth.js/tree/master/packages/smooth-plugin-headers",
+  "author": "Vivien Ripoche <vivienripoche@gmail.com>",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "smooth",
+    "smooth-plugin"
+  ],
+  "engines": {
+    "node": ">=8"
+  },
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "prebuild": "shx rm -rf lib",
+    "build": "babel --root-mode upward -d lib --ignore \"**/*.test.js\" --copy-files src",
+    "prepublishOnly": "yarn run build"
+  },
+  "dependencies": {
+    "path-to-regexp": "^3.0.0"
+  },
+  "peerDependencies": {
+    "smooth": "^0.1.0"
+  }
+}
diff --git a/packages/smooth-plugin-headers/smooth-node.js b/packages/smooth-plugin-headers/smooth-node.js
@@ -0,0 +1 @@
+module.exports = require('./src/smooth-node')
diff --git a/packages/smooth-plugin-headers/src/smooth-node.js b/packages/smooth-plugin-headers/src/smooth-node.js
@@ -0,0 +1,25 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import pathToRegexp from 'path-to-regexp'
+
+export function parseHeaders(url = '', headers = {}) {
+  return [
+    ...Object.entries(headers)
+      .reduce((acc, [rule, values = []]) => {
+        if (pathToRegexp(rule).test(url)) {
+          values.forEach(header => {
+            const [, key, value] = /^([^:]*)\s*:\s*(.*)$/.exec(header)
+            acc.set(key, value)
+          })
+        }
+        return acc
+      }, new Map())
+      .entries(),
+  ]
+}
+
+export function onCreateServer({ app }, { headers = {} }) {
+  app.use(({ url }, res, next) => {
+    parseHeaders(url, headers).forEach(args => res.set(...args))
+    next()
+  })
+}
diff --git a/packages/smooth-plugin-headers/src/smooth-node.test.js b/packages/smooth-plugin-headers/src/smooth-node.test.js
@@ -0,0 +1,48 @@
+import { parseHeaders } from './smooth-node'
+
+describe('Smooth Header Plugin', () => {
+  describe('parseHeaders', () => {
+    it('should parse to empty array by default', () => {
+      expect(parseHeaders()).toEqual([])
+    })
+
+    it('should parse Cache-control on matching (.*)', () => {
+      expect(
+        parseHeaders('/page/home', { '(.*)': ['Cache-Control: no-cache'] }),
+      ).toEqual([['Cache-Control', 'no-cache']])
+    })
+
+    it('should not parse Cache-control on non matching /page/(.*) url', () => {
+      expect(
+        parseHeaders('/home', { '/page/(.*)': ['Cache-Control: no-cache'] }),
+      ).toEqual([])
+    })
+
+    it('should parse Cache-control only on matching /home url', () => {
+      expect(
+        parseHeaders('/home', {
+          '/page/(.*)': ['Cache-Control: no-cache'],
+          '/home': ['Cache-Control: public, max-age=31557600'],
+        }),
+      ).toEqual([['Cache-Control', 'public, max-age=31557600']])
+    })
+
+    it('should parse all headers rules that match with url', () => {
+      expect(
+        parseHeaders('/home', {
+          '/(.*)': ['Cache-Control: no-cache'],
+          '/home': ['Basic-Auth: user:passwd'],
+        }),
+      ).toEqual([['Cache-Control', 'no-cache'], ['Basic-Auth', 'user:passwd']])
+    })
+
+    it('should overwrite same rules', () => {
+      expect(
+        parseHeaders('/favicon.ico', {
+          '/(.*)': ['Cache-Control: no-cache'],
+          '/(.*).ico': ['Cache-Control: public, max-age=2592000'],
+        }),
+      ).toEqual([['Cache-Control', 'public, max-age=2592000']])
+    })
+  })
+})
diff --git a/yarn.lock b/yarn.lock
@@ -8804,6 +8804,11 @@ path-to-regexp@^1.7.0:
   dependencies:
     isarray "0.0.1"
 
+path-to-regexp@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-3.0.0.tgz#c981a218f3df543fa28696be2f88e0c58d2e012a"
+  integrity sha512-ZOtfhPttCrqp2M1PBBH4X13XlvnfhIwD7yCLx+GoGoXRPQyxGOTdQMpIzPSPKXAJT/JQrdfFrgdJOyAzvgpQ9A==
+
 path-type@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/path-type/-/path-type-1.1.0.tgz#59c44f7ee491da704da415da5a4070ba4f8fe441"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('./src/smooth-node')`