Update rewriter (typicode#580)

typicode · web-flow · commit 21d2fff3a9f8 · 2017-07-05T13:17:10.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,15 @@
 # Change Log
 
+## 0.11.0 - 2017-07-05
+
+Switch to [express-urlrewrite](https://github.com/kapouer/express-urlrewrite) to support rewriting query parameters (e.g.  `/articles?id=1 # → /posts/1`)
+
+If you're rewriting default routes, you'll need to update your `routes.json` file
+(see [add custom routes](https://github.com/typicode/json-server#add-custom-routes) for updated doc).
+
 ## 0.10.3 - 2017-06-28
 
-* Fix line-break error in CLI
+* Fix `line-break` error in CLI
 
 ## 0.10.2 - 2017-06-28
 
diff --git a/README.md b/README.md
@@ -314,9 +314,10 @@ Create a `routes.json` file. Pay attention to start every route with `/`.
 
 ```json
 {
-  "/api/": "/",
-  "/blog/:resource/:id/show": "/:resource/:id",
-  "/blog/:category": "/posts?category=:category"
+  "/api/*": "/$1",
+  "/:resource/:id/show": "/:resource/:id",
+  "/posts/:category": "/posts?category=:category",
+  "/articles\\?id=:id": "/posts/:id"
 }
 ```
 
@@ -331,8 +332,9 @@ Now you can access resources using additional routes.
 ```sh
 /api/posts # → /posts
 /api/posts/1  # → /posts/1
-/blog/posts/1/show # → /posts/1
-/blog/javascript # → /posts?category=javascript
+/posts/1/show # → /posts/1
+/posts/javascript # → /posts?category=javascript
+/articles?id=1 # → /posts/1
 ```
 
 ### Add middlewares
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "cors": "^2.3.0",
     "errorhandler": "^1.2.0",
     "express": "^4.9.5",
+    "express-urlrewrite": "^1.2.0",
     "json-parse-helpfulerror": "^1.0.3",
     "lodash": "^4.11.2",
     "lodash-id": "^0.13.0",
diff --git a/src/server/rewriter.js b/src/server/rewriter.js
@@ -1,38 +1,15 @@
 const express = require('express')
-const url = require('url')
-const _ = require('lodash')
-function updateQueryString(target, sourceUrl) {
-  return ~sourceUrl.indexOf('?')
-    ? _.assign(target, url.parse(sourceUrl, true).query)
-    : {}
-}
+const rewrite = require('express-urlrewrite')
+
 module.exports = routes => {
   const router = express.Router()
 
   router.get('/__rules', (req, res) => {
     res.json(routes)
   })
 
-  Object.keys(routes).forEach(route => {
-    if (route.indexOf(':') !== -1) {
-      router.all(route, (req, res, next) => {
-        // Rewrite target url using params
-        let target = routes[route]
-        for (let param in req.params) {
-          target = target.replace(`:${param}`, req.params[param])
-        }
-        req.url = target
-        req.query = updateQueryString(req.query, req.url)
-        next()
-      })
-    } else {
-      router.all(`${route}*`, (req, res, next) => {
-        // Rewrite url by replacing prefix
-        req.url = req.url.replace(route, routes[route])
-        req.query = updateQueryString(req.query, req.url)
-        next()
-      })
-    }
+  Object.keys(routes).forEach(key => {
+    router.use(rewrite(key, routes[key]))
   })
 
   return router
diff --git a/test/cli/index.js b/test/cli/index.js
@@ -42,7 +42,7 @@ describe('cli', () => {
     )
 
     routesFile = tempWrite.sync(
-      JSON.stringify({ '/blog/': '/' }),
+      JSON.stringify({ '/blog/*': '/$1' }),
       'routes.json'
     )
 
@@ -260,7 +260,7 @@ describe('cli', () => {
     })
 
     it('should watch routes file', done => {
-      fs.writeFileSync(routesFile, JSON.stringify({ '/api/': '/' }))
+      fs.writeFileSync(routesFile, JSON.stringify({ '/api/*': '/$1' }))
       setTimeout(() => {
         request.get('/api/posts').expect(200, done)
       }, 1000)
diff --git a/test/server/plural.js b/test/server/plural.js
@@ -8,11 +8,11 @@ describe('Server', () => {
   let router
   let db
   const rewriterRules = {
-    '/api/': '/',
+    '/api/*': '/$1',
     '/blog/posts/:id/show': '/posts/:id',
     '/comments/special/:userId-:body': '/comments/?userId=:userId&body=:body',
     '/firstpostwithcomments': '/posts/1?_embed=comments',
-    '/articles?_id=:id': '/posts/:id'
+    '/articles\\?_id=:id': '/posts/:id'
   }
 
   beforeEach(() => {
@@ -660,13 +660,8 @@ describe('Server', () => {
     it('should rewrite using params and query', () =>
       request(server).get('/comments/special/1-quux').expect([db.comments[4]]))
 
-    // TODO
-    // it('should rewrite query params', () => (
-    //   request(server)
-    //     .get('/articles?_id=1')
-    //     .expect(db.posts[0])
-    //     .end(done)
-    // })
+    it('should rewrite query params', () =>
+      request(server).get('/articles?_id=1').expect(db.posts[0]))
 
     it('should expose routes', () =>
       request(server).get('/__rules').expect(rewriterRules))

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ describe('cli', () => {`
`42`	`42`	`)`
`43`	`43`
`44`	`44`	`routesFile = tempWrite.sync(`
`45`		`- JSON.stringify({ '/blog/': '/' }),`
	`45`	`+ JSON.stringify({ '/blog/*': '/$1' }),`
`46`	`46`	`'routes.json'`
`47`	`47`	`)`
`48`	`48`
`@@ -260,7 +260,7 @@ describe('cli', () => {`
`260`	`260`	`})`
`261`	`261`
`262`	`262`	`it('should watch routes file', done => {`
`263`		`- fs.writeFileSync(routesFile, JSON.stringify({ '/api/': '/' }))`
	`263`	`+ fs.writeFileSync(routesFile, JSON.stringify({ '/api/*': '/$1' }))`
`264`	`264`	`setTimeout(() => {`
`265`	`265`	`request.get('/api/posts').expect(200, done)`
`266`	`266`	`}, 1000)`