feat: add merge mode (#87)

* feat: add merge endpoint

* formatting

* load merge too

* remove extra server

* print the data.json file

* restore the data.json from git

* add merge docs to README

Author: bahmutov

.github/workflows/ci.yml

@@ -14,6 +14,9 @@ jobs:
           build: npm test
           start: npm start
 
+      - name: Restore the data
+        run: git checkout ./cypress/fixtures/data.json
+
       - name: Run JSON server tests 🧪
         uses: cypress-io/github-action@v4
         with:
@@ -23,6 +26,7 @@ jobs:
           config: 'baseUrl=http://localhost:4000'
 
       - name: Semantic Release 🚀
+        if: github.ref == 'refs/heads/master'
         uses: cycjimmy/semantic-release-action@v2
         with:
           branch: master

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true
+}

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
   "eslint.enable": false,
-  "standard.enable": true
+  "standard.enable": false
 }

README.md

@@ -20,6 +20,8 @@ npm install --save json-server-reset
 
 ## Use
 
+### reset
+
 If you are using [json-server](https://github.com/typicode/json-server), add this module as a middleware. For example, imagine our data file to be `data.json` with the following resources
 
 ```json
@@ -70,6 +72,30 @@ $ http :3000/todos
 []
 ```
 
+### merge
+
+Instead of overwriting the entire database with new data, you can merge the existing data with a subset (by the top key).
+
+```
+// current data
+// { todos: [...], people: [...] }
+```
+
+Let's reset just the "people" resource list, leaving the todos unchanged. Include the [src/merge.js](./src/merge.js) middleware
+
+```
+json-server data.json --middlewares ./node_modules/json-server-reset --middlewares ./node_modules/json-server-reset/src/merge
+```
+
+Call the endpoint `POST /merge`
+
+```
+$ http POST :3000/merge people:=[]
+
+// updated data
+// { todos: [...], people: [] }
+```
+
 ### Debugging
 
 Run this module with environment variable
@@ -91,11 +117,13 @@ const reset = require('json-server-reset')
 // create json server and its router first
 const server = jsonServer.create()
 const router = jsonServer.router(dataFilename)
-server.use(jsonServer.defaults({
-  static: '.', // optional static server folder
-  bodyParser: true,
-  readOnly: false
-}))
+server.use(
+  jsonServer.defaults({
+    static: '.', // optional static server folder
+    bodyParser: true,
+    readOnly: false,
+  }),
+)
 server.use(reset)
 server.db = router.db
 server.use(router)
@@ -112,9 +140,9 @@ See [example-server.js](./cypress/fixtures/example-server.js)
 
 Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017
 
-* [@bahmutov](https://twitter.com/bahmutov)
-* [glebbahmutov.com](https://glebbahmutov.com)
-* [blog](https://glebbahmutov.com/blog)
+- [@bahmutov](https://twitter.com/bahmutov)
+- [glebbahmutov.com](https://glebbahmutov.com)
+- [blog](https://glebbahmutov.com/blog)
 
 License: MIT - do anything with the code, but don't blame me if it does not work.
 

cypress/e2e/merge.cy.js

@@ -0,0 +1,66 @@
+describe('json-server-reset', () => {
+  const reset = () => {
+    cy.request({
+      method: 'POST',
+      url: '/reset',
+      body: {
+        todos: [],
+        people: [],
+      },
+    })
+  }
+  beforeEach(reset)
+
+  const mergeTodos = (todos = []) => cy.request('POST', '/merge', { todos })
+
+  const getPeople = () => cy.request('/people').its('body')
+
+  const getTodos = () => cy.request('/todos').its('body')
+
+  const addTodo = () =>
+    cy.request({
+      method: 'POST',
+      url: '/todos',
+      body: {
+        id: 1,
+        title: 'do something',
+      },
+    })
+
+  const addPerson = () =>
+    cy.request({
+      method: 'POST',
+      url: '/people',
+      body: {
+        name: `A person ${Cypress._.random(1e4)}`,
+      },
+    })
+
+  it('updates people while keeping todos', () => {
+    addTodo()
+    getTodos().should('deep.equal', [{ id: 1, title: 'do something' }])
+    getPeople().should('deep.equal', [])
+    mergeTodos()
+    getTodos().should('deep.equal', [])
+    getPeople().should('deep.equal', [])
+    addPerson()
+    getPeople().should('have.length', 1)
+    mergeTodos()
+    getPeople().should('have.length', 1)
+    addTodo()
+    getPeople().should('have.length', 1)
+    getTodos().should('have.length', 1)
+    mergeTodos([
+      {
+        id: 1,
+        title: 'first',
+      },
+      {
+        id: 2,
+        title: 'second',
+      },
+    ])
+    getPeople().should('have.length', 1)
+    getTodos().should('have.length', 2)
+  })
+})

cypress/e2e/spec.cy.js

@@ -6,8 +6,8 @@ describe('json-server-reset', () => {
       method: 'POST',
       url: '/reset',
       body: {
-        todos: []
-      }
+        todos: [],
+      },
     })
   }
   beforeEach(reset)
@@ -20,8 +20,8 @@ describe('json-server-reset', () => {
       url: '/todos',
       body: {
         id: 1,
-        title: 'do something'
-      }
+        title: 'do something',
+      },
     })
 
   it('starts with empty list of todos', () => {
@@ -41,15 +41,15 @@ describe('json-server-reset', () => {
 
   it('immediately saves DB file', () => {
     cy.readFile('cypress/fixtures/data.json').should('deep.equal', {
-      todos: []
+      todos: [],
     })
     addTodo()
     cy.readFile('cypress/fixtures/data.json').should('deep.equal', {
-      todos: [{ id: 1, title: 'do something' }]
+      todos: [{ id: 1, title: 'do something' }],
     })
     reset()
     cy.readFile('cypress/fixtures/data.json').should('deep.equal', {
-      todos: []
+      todos: [],
     })
   })
 
@@ -64,25 +64,31 @@ describe('json-server-reset', () => {
         method: 'POST',
         url: '/reset',
         body: {},
-        failOnStatusCode: false
-      }).its('status').should('equal', 400)
+        failOnStatusCode: false,
+      })
+        .its('status')
+        .should('equal', 400)
     })
 
     it('rejects resetting without an object', () => {
       cy.request({
         method: 'POST',
         url: '/reset',
-        failOnStatusCode: false
-      }).its('status').should('equal', 400)
+        failOnStatusCode: false,
+      })
+        .its('status')
+        .should('equal', 400)
     })
 
     it('rejects resetting with an array', () => {
       cy.request({
         method: 'POST',
         url: '/reset',
         body: [],
-        failOnStatusCode: false
-      }).its('status').should('equal', 400)
+        failOnStatusCode: false,
+      })
+        .its('status')
+        .should('equal', 400)
     })
   })
 })

cypress/fixtures/data.json

@@ -1,3 +1,18 @@
 {
-  "todos": []
+  "todos": [
+    {
+      "id": 1,
+      "title": "first"
+    },
+    {
+      "id": 2,
+      "title": "second"
+    }
+  ],
+  "people": [
+    {
+      "name": "A person 5155",
+      "id": 1
+    }
+  ]
 }

cypress/fixtures/example-server.js

@@ -1,16 +1,20 @@
 const jsonServer = require('json-server')
-const reset = require('../..')
+const reset = require('../../src')
+const merge = require('../../src/merge')
 const path = require('path')
 const dataFilename = path.join(__dirname, 'data.json')
 
 // create json server and its router first
 const server = jsonServer.create()
 const router = jsonServer.router(dataFilename)
-server.use(jsonServer.defaults({
-  bodyParser: true,
-  readOnly: false
-}))
+server.use(
+  jsonServer.defaults({
+    bodyParser: true,
+    readOnly: false,
+  }),
+)
 server.use(reset)
+server.use(merge)
 server.db = router.db
 server.use(router)