feat: warn and reject invalid resets

* use Cypress v11

* update the github workflows

* add testing local server

* fixing setting the app

* feat: reject reset with an empty object or array

* fix: wait for the write promise

* handle sync and async write

Author: bahmutov

.github/workflows/badges.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout 🛎
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Update version badges 🏷
         run: npx -p dependency-version-badge update-badge json-server cypress

.github/workflows/ci.yml

@@ -5,15 +5,23 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout 🛎
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Run tests 🧪
         # https://github.com/cypress-io/github-action
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           build: npm test
           start: npm start
 
+      - name: Run JSON server tests 🧪
+        uses: cypress-io/github-action@v4
+        with:
+          # we have already installed all dependencies above
+          install: false
+          start: node ./cypress/fixtures/example-server.js
+          config: 'baseUrl=http://localhost:4000'
+
       - name: Semantic Release 🚀
         uses: cycjimmy/semantic-release-action@v2
         with:

README.md

@@ -87,21 +87,22 @@ Then set it to be the middleware _before_ the rest of the `json-server` middlewa
 ```js
 const jsonServer = require('json-server')
 const reset = require('json-server-reset')
-const setApp = require('json-server-reset/src/set-app')
-const bodyParser = require('json-server/lib/server/body-parser')
 
 // create json server and its router first
 const server = jsonServer.create()
-const router = jsonServer.router(db)
-// then pass it to json-server-reset
-server.use(setApp(server, router.db))
-server.use(bodyParser)
+const router = jsonServer.router(dataFilename)
+server.use(jsonServer.defaults({
+  static: '.', // optional static server folder
+  bodyParser: true,
+  readOnly: false
+}))
 server.use(reset)
-// the rest of middlewares
-server.use(jsonServer.defaults())
+server.db = router.db
 server.use(router)
 ```
 
+See [example-server.js](./cypress/fixtures/example-server.js)
+
 ## Examples
 
 - [Cypress basics workshop](https://github.com/bahmutov/cypress-workshop-basics)

cypress.config.js

@@ -0,0 +1,13 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  video: false,
+  e2e: {
+    // We've imported your old cypress plugins here.
+    // You may want to clean this up later by importing these.
+    setupNodeEvents (on, config) {
+      return require('./cypress/plugins/index.js')(on, config)
+    },
+    baseUrl: 'http://localhost:3000'
+  }
+})

cypress.json

@@ -52,4 +52,37 @@ describe('json-server-reset', () => {
       todos: []
     })
   })
+
+  context('invalid input', () => {
+    it('warns when resetting with non-existing keys', () => {
+      cy.request('POST', '/reset', { todos: [] })
+      cy.request('POST', '/reset', { people: [] })
+    })
+
+    it('rejects resetting with an empty object', () => {
+      cy.request({
+        method: 'POST',
+        url: '/reset',
+        body: {},
+        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)
+    })
+
+    it('rejects resetting with an array', () => {
+      cy.request({
+        method: 'POST',
+        url: '/reset',
+        body: [],
+        failOnStatusCode: false
+      }).its('status').should('equal', 400)
+    })
+  })
 })

cypress/integration/spec.js renamed to cypress/e2e/spec.cy.js

@@ -0,0 +1,19 @@
+const jsonServer = require('json-server')
+const reset = require('../..')
+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(reset)
+server.db = router.db
+server.use(router)
+
+server.listen(4000, () => {
+  console.log('JSON Server is running on port 4000')
+})

cypress/fixtures/example-server.js

@@ -42,19 +42,22 @@
     "unused-deps": "dependency-check --unused --no-dev .",
     "cy:open": "cypress open",
     "cy:run": "cypress run",
+    "cy:open:4000": "cypress open --config baseUrl=http://localhost:4000",
     "start": "json-server cypress/fixtures/data.json --middlewares ./src/index.js",
+    "start:server": "node ./cypress/fixtures/example-server",
     "e2e": "start-server-and-test 3000 cy:run",
     "dev": "start-server-and-test 3000 cy:open",
+    "dev2": "start-test start:server 4000 cy:open:4000",
     "semantic-release": "semantic-release"
   },
   "devDependencies": {
     "ban-sensitive-files": "1.9.18",
     "check-more-types": "2.24.0",
-    "cypress": "9.7.0",
+    "cypress": "11.2.0",
     "dependency-check": "4.1.0",
     "deps-ok": "1.4.1",
     "git-issues": "1.3.1",
-    "json-server": "0.17.0",
+    "json-server": "0.17.1",
     "lazy-ass": "1.6.0",
     "license-checker": "15.0.0",
     "mocha": "4.1.0",
@@ -67,6 +70,6 @@
     "debug": "4.3.4"
   },
   "peerDependencies": {
-    "json-server": ">=0.15"
+    "json-server": ">=0.17"
   }
 }