plural.js

const assert = require('assert')
const _ = require('lodash')
const request = require('supertest')
const jsonServer = require('../../src/server')
const { parseArgv } = require('../../src/server/utils')
const cliArg = parseArgv(process.env.arg)

describe('Server', () => {
  let server
  let router
  let db
  const rewriterRules = {
    '/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',
  }

  beforeEach(() => {
    db = {}

    db.posts = [
      { id: 1, body: 'foo' },
      { id: 2, body: 'bar' },
    ]

    db.tags = [
      { id: 1, body: 'Technology' },
      { id: 2, body: 'Photography' },
      { id: 3, body: 'photo' },
    ]

    db.users = [
      { id: 1, username: 'Jim', tel: '0123' },
      { id: 2, username: 'George', tel: '123' },
    ]

    db.comments = [
      { id: 1, body: 'foo', published: true, postId: 1, userId: 1 },
      { id: 2, body: 'bar', published: false, postId: 1, userId: 2 },
      { id: 3, body: 'baz', published: false, postId: 2, userId: 1 },
      { id: 4, body: 'qux', published: true, postId: 2, userId: 2 },
      { id: 5, body: 'quux', published: false, postId: 2, userId: 1 },
    ]

    db.buyers = [
      { id: 1, name: 'Aileen', country: 'Colombia', total: 100 },
      { id: 2, name: 'Barney', country: 'Colombia', total: 200 },
      { id: 3, name: 'Carley', country: 'Colombia', total: 300 },
      { id: 4, name: 'Daniel', country: 'Belize', total: 30 },
      { id: 5, name: 'Ellen', country: 'Belize', total: 20 },
      { id: 6, name: 'Frank', country: 'Belize', total: 10 },
      { id: 7, name: 'Grace', country: 'Argentina', total: 1 },
      { id: 8, name: 'Henry', country: 'Argentina', total: 2 },
      { id: 9, name: 'Isabelle', country: 'Argentina', total: 3 },
    ]

    db.refs = [
      { id: 'abcd-1234', url: 'http://example.com', postId: 1, userId: 1 },
    ]

    db.stringIds = [{ id: '1234' }]

    db.deep = [{ a: { b: 1 } }, { a: 1 }]

    db.nested = [
      { resource: { name: 'dewey' } },
      { resource: { name: 'cheatem' } },
      { resource: { name: 'howe' } },
    ]

    db.list = [
      { id: 1 },
      { id: 2 },
      { id: 3 },
      { id: 4 },
      { id: 5 },
      { id: 6 },
      { id: 7 },
      { id: 8 },
      { id: 9 },
      { id: 10 },
      { id: 11 },
      { id: 12 },
      { id: 13 },
      { id: 14 },
      { id: 15 },
    ]

    server = jsonServer.create()
    router = jsonServer.router(db, cliArg)
    server.use(jsonServer.defaults())
    server.use(jsonServer.rewriter(rewriterRules))
    server.use(router)
  })

  describe('GET /db', () => {
    test('should respond with json and full database', () =>
      request(server)
        .get('/db')
        .expect('Content-Type', /json/)
        .expect(...(cliArg._noDbRoute ? [404, {}] : [200, db])))
  })

  describe('GET /:resource', () => {
    test('should respond with json and corresponding resources', () =>
      request(server)
        .get('/posts')
        .set('Origin', 'http://example.com')
        .expect('Content-Type', /json/)
        .expect('Access-Control-Allow-Credentials', 'true')
        .expect('Access-Control-Allow-Origin', 'http://example.com')
        .expect(200, db.posts))

    test('should respond with 404 if resource is not found', () =>
      request(server).get('/undefined').expect(404))
  })

  describe('GET /:resource?attr=&attr=', () => {
    test('should respond with json and filter resources', () =>
      request(server)
        .get('/comments?postId=1&published=true')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[0]]))

    test('should be strict', () =>
      request(server)
        .get('/users?tel=123')
        .expect('Content-Type', /json/)
        .expect(200, [db.users[1]]))

    test('should support multiple filters', () =>
      request(server)
        .get('/comments?id=1&id=2')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[0], db.comments[1]]))

    test('should support deep filter', () =>
      request(server)
        .get('/deep?a.b=1')
        .expect('Content-Type', /json/)
        .expect(200, [db.deep[0]]))

    test('should ignore JSONP query parameters callback and _ ', () =>
      request(server)
        .get('/comments?callback=1&_=1')
        .expect('Content-Type', /text/)
        .expect(new RegExp(db.comments[0].body)) // JSONP returns text
        .expect(200))

    test('should ignore unknown query parameters', () =>
      request(server)
        .get('/comments?foo=1&bar=2')
        .expect('Content-Type', /json/)
        .expect(200, db.comments))

    // https://github.com/typicode/json-server/issues/510
    test('should not fail with null value', () => {
      db.posts.push({ id: 99, body: null })
      return request(server)
        .get('/posts?body=foo')
        .expect('Content-Type', /json/)
        .expect(200, [db.posts[0]])
    })
  })

  describe('GET /:resource?q=', () => {
    test('should respond with json and make a full-text search', () =>
      request(server)
        .get('/tags?q=pho')
        .expect('Content-Type', /json/)
        .expect(200, [db.tags[1], db.tags[2]]))

    test('should respond with json and make a deep full-text search', () =>
      request(server)
        .get('/deep?q=1')
        .expect('Content-Type', /json/)
        .expect(200, db.deep))

    test('should return an empty array when nothing is matched', () =>
      request(server)
        .get('/tags?q=nope')
        .expect('Content-Type', /json/)
        .expect(200, []))

    test('should support other query parameters', () =>
      request(server)
        .get('/comments?q=qu&published=true')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[3]]))

    test('should ignore duplicate q query parameters', () =>
      request(server)
        .get('/comments?q=foo&q=bar')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[0]]))

    test('should support filtering by boolean value false', () =>
      request(server)
        .get('/comments?published=false')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[1], db.comments[2], db.comments[4]]))
  })

  describe('GET /:resource?_end=', () => {
    test('should respond with a sliced array', () =>
      request(server)
        .get('/comments?_end=2')
        .expect('Content-Type', /json/)
        .expect('x-total-count', db.comments.length.toString())
        .expect('Access-Control-Expose-Headers', 'X-Total-Count')
        .expect(200, db.comments.slice(0, 2)))
  })

  describe('GET /:resource?_sort=', () => {
    test('should respond with json and sort on a field', () =>
      request(server)
        .get('/tags?_sort=body')
        .expect('Content-Type', /json/)
        .expect(200, [db.tags[1], db.tags[0], db.tags[2]]))

    test('should reverse sorting with _order=DESC', () =>
      request(server)
        .get('/tags?_sort=body&_order=DESC')
        .expect('Content-Type', /json/)
        .expect(200, [db.tags[2], db.tags[0], db.tags[1]]))

    test('should reverse sorting with _order=desc (case insensitive)', () =>
      request(server)
        .get('/tags?_sort=body&_order=desc')
        .expect('Content-Type', /json/)
        .expect(200, [db.tags[2], db.tags[0], db.tags[1]]))

    test('should sort on numerical field', () =>
      request(server)
        .get('/posts?_sort=id&_order=DESC')
        .expect('Content-Type', /json/)
        .expect(200, db.posts.reverse()))

    test('should sort on nested field', () =>
      request(server)
        .get('/nested?_sort=resource.name')
        .expect('Content-Type', /json/)
        .expect(200, [db.nested[1], db.nested[0], db.nested[2]]))

    test('should sort on multiple fields', () =>
      request(server)
        .get('/buyers?_sort=country,total&_order=asc,desc')
        .expect('Content-Type', /json/)
        .expect(200, [
          db.buyers[8],
          db.buyers[7],
          db.buyers[6],
          db.buyers[3],
          db.buyers[4],
          db.buyers[5],
          db.buyers[2],
          db.buyers[1],
          db.buyers[0],
        ]))
  })

  describe('GET /:resource?_start=&_end=', () => {
    test('should respond with a sliced array', () =>
      request(server)
        .get('/comments?_start=1&_end=2')
        .expect('Content-Type', /json/)
        .expect('X-Total-Count', db.comments.length.toString())
        .expect('Access-Control-Expose-Headers', 'X-Total-Count')
        .expect(200, db.comments.slice(1, 2)))
  })

  describe('GET /:resource?_start=&_limit=', () => {
    test('should respond with a limited array', () =>
      request(server)
        .get('/comments?_start=1&_limit=1')
        .expect('Content-Type', /json/)
        .expect('X-Total-Count', db.comments.length.toString())
        .expect('Access-Control-Expose-Headers', 'X-Total-Count')
        .expect(200, db.comments.slice(1, 2)))
  })

  describe('GET /:resource?_page=', () => {
    test('should paginate', () =>
      request(server)
        .get('/list?_page=2')
        .expect('Content-Type', /json/)
        .expect('x-total-count', db.list.length.toString())
        .expect('Access-Control-Expose-Headers', 'X-Total-Count, Link')
        .expect(200, db.list.slice(10, 20)))
  })

  describe('GET /:resource?_page=&_limit=', () => {
    test('should paginate with a custom limit', () => {
      const link = [
        '<http://localhost/list?_page=1&_limit=1>; rel="first"',
        '<http://localhost/list?_page=1&_limit=1>; rel="prev"',
        '<http://localhost/list?_page=3&_limit=1>; rel="next"',
        '<http://localhost/list?_page=15&_limit=1>; rel="last"',
      ].join(', ')
      return request(server)
        .get('/list?_page=2&_limit=1')
        .set('host', 'localhost')
        .expect('Content-Type', /json/)
        .expect('x-total-count', db.list.length.toString())
        .expect('link', link)
        .expect('Access-Control-Expose-Headers', 'X-Total-Count, Link')
        .expect(200, db.list.slice(1, 2))
    })
  })

  describe('GET /:resource?attr_gte=&attr_lte=', () => {
    test('should respond with a limited array', () =>
      request(server)
        .get('/comments?id_gte=2&id_lte=3')
        .expect('Content-Type', /json/)
        .expect(200, db.comments.slice(1, 3)))
  })

  describe('GET /:resource?attr_ne=', () => {
    test('should respond with a limited array', () =>
      request(server)
        .get('/comments?id_ne=1')
        .expect('Content-Type', /json/)
        .expect(200, db.comments.slice(1)))

    test('should accept multiple parameters', () =>
      request(server)
        .get('/comments?id_ne=1&id_ne=2')
        .expect('Content-Type', /json/)
        .expect(200, db.comments.slice(2)))
  })

  describe('GET /:resource?attr_like=', () => {
    test('should respond with an array that matches the like operator (case insensitive)', () =>
      request(server)
        .get('/tags?body_like=photo')
        .expect('Content-Type', /json/)
        .expect(200, [db.tags[1], db.tags[2]]))
    test('should accept multiple parameters', () =>
      request(server)
        .get('/tags?body_like=photo&body_like=tech')
        .expect('Content-Type', /json/)
        .expect(200, db.tags))
  })

  describe('GET /:parent/:parentId/:resource', () => {
    test('should respond with json and corresponding nested resources', () =>
      request(server)
        .get('/posts/1/comments')
        .expect('Content-Type', /json/)
        .expect(200, [db.comments[0], db.comments[1]]))
  })

  describe('GET /:resource/:id', () => {
    test('should respond with json and corresponding resource', () =>
      request(server)
        .get('/posts/1')
        .expect('Content-Type', /json/)
        .expect(200, db.posts[0]))

    test('should support string id, respond with json and corresponding resource', () =>
      request(server)
        .get('/refs/abcd-1234')
        .expect('Content-Type', /json/)
        .expect(200, db.refs[0]))

    test('should support integer id as string', () =>
      request(server)
        .get('/stringIds/1234')
        .expect('Content-Type', /json/)
        .expect(200, db.stringIds[0]))

    test('should respond with 404 if resource is not found', () =>
      request(server)
        .get('/posts/9001')
        .expect('Content-Type', cliArg._noDataNext ? /html/ : /json/)
        .expect(404, {}))
  })

  describe('GET /:resource?_embed=', () => {
    test('should respond with corresponding resources and embedded resources', () => {
      const posts = _.cloneDeep(db.posts)
      posts[0].comments = [db.comments[0], db.comments[1]]
      posts[1].comments = [db.comments[2], db.comments[3], db.comments[4]]
      return request(server)
        .get('/posts?_embed=comments')
        .expect('Content-Type', /json/)
        .expect(200, posts)
    })
  })

  describe('GET /:resource?_embed&_embed=', () => {
    test('should respond with corresponding resources and embedded resources', () => {
      const posts = _.cloneDeep(db.posts)
      posts[0].comments = [db.comments[0], db.comments[1]]
      posts[0].refs = [db.refs[0]]
      posts[1].comments = [db.comments[2], db.comments[3], db.comments[4]]
      posts[1].refs = []
      return request(server)
        .get('/posts?_embed=comments&_embed=refs')
        .expect('Content-Type', /json/)
        .expect(200, posts)
    })
  })

  describe('GET /:resource/:id?_embed=', () => {
    test('should respond with corresponding resources and embedded resources', () => {
      const post = _.cloneDeep(db.posts[0])
      post.comments = [db.comments[0], db.comments[1]]
      return request(server)
        .get('/posts/1?_embed=comments')
        .expect('Content-Type', /json/)
        .expect(200, post)
    })
  })

  describe('GET /:resource/:id?_embed=&_embed=', () => {
    test('should respond with corresponding resource and embedded resources', () => {
      const post = _.cloneDeep(db.posts[0])
      post.comments = [db.comments[0], db.comments[1]]
      post.refs = [db.refs[0]]
      return request(server)
        .get('/posts/1?_embed=comments&_embed=refs')
        .expect('Content-Type', /json/)
        .expect(200, post)
    })
  })

  describe('GET /:resource?_expand=', () => {
    test('should respond with corresponding resource and expanded inner resources', () => {
      const refs = _.cloneDeep(db.refs)
      refs[0].post = db.posts[0]
      return request(server)
        .get('/refs?_expand=post')
        .expect('Content-Type', /json/)
        .expect(200, refs)
    })
  })

  describe('GET /:resource/:id?_expand=', () => {
    test('should respond with corresponding resource and expanded inner resources', () => {
      const comment = _.cloneDeep(db.comments[0])
      comment.post = db.posts[0]
      return request(server)
        .get('/comments/1?_expand=post')
        .expect('Content-Type', /json/)
        .expect(200, comment)
    })
  })

  describe('GET /:resource?_expand=&_expand', () => {
    test('should respond with corresponding resource and expanded inner resources', () => {
      const refs = _.cloneDeep(db.refs)
      refs[0].post = db.posts[0]
      refs[0].user = db.users[0]
      return request(server)
        .get('/refs?_expand=post&_expand=user')
        .expect('Content-Type', /json/)
        .expect(200, refs)
    })
  })

  describe('GET /:resource/:id?_expand=&_expand=', () => {
    test('should respond with corresponding resource and expanded inner resources', () => {
      const comments = db.comments[0]
      comments.post = db.posts[0]
      comments.user = db.users[0]
      return request(server)
        .get('/comments/1?_expand=post&_expand=user')
        .expect('Content-Type', /json/)
        .expect(200, comments)
    })
  })

  describe('GET /:resource>_delay=', () => {
    test('should delay response', (done) => {
      const start = new Date()
      request(server)
        .get('/posts?_delay=1100')
        .expect(200, function (err) {
          const end = new Date()
          done(end - start > 1000 ? err : new Error("Request wasn't delayed"))
        })
    })
  })

  describe('POST /:resource', () => {
    test('should respond with json, create a resource and increment id', async () => {
      await request(server)
        .post('/posts')
        .send({ body: 'foo', booleanValue: true, integerValue: 1 })
        .expect('Access-Control-Expose-Headers', 'Location')
        .expect('Location', /posts\/3$/)
        .expect('Content-Type', /json/)
        .expect(201, {
          id: 3,
          body: 'foo',
          booleanValue: true,
          integerValue: 1,
        })
      assert.strictEqual(db.posts.length, 3)
    })

    test('should support x-www-form-urlencoded', async () => {
      await request(server)
        .post('/posts')
        .type('form')
        .send({ body: 'foo', booleanValue: true, integerValue: 1 })
        .expect('Content-Type', /json/)
        // x-www-form-urlencoded will convert to string
        .expect(201, {
          id: 3,
          body: 'foo',
          booleanValue: 'true',
          integerValue: '1',
        })
      assert.strictEqual(db.posts.length, 3)
    })

    test('should respond with json, create a resource and generate string id', async () => {
      await request(server)
        .post('/refs')
        .send({ url: 'http://foo.com', postId: 1 })
        .expect('Content-Type', /json/)
        .expect(201)
      assert.strictEqual(db.refs.length, 2)
    })
  })

  describe('POST /:parent/:parentId/:resource', () => {
    test('should respond with json and set parentId', () =>
      request(server)
        .post('/posts/1/comments')
        .send({ body: 'foo' })
        .expect('Content-Type', /json/)
        .expect(201, { id: 6, postId: '1', body: 'foo' }))
  })

  describe('POST /:resource?_delay=', () => {
    test('should delay response', (done) => {
      const start = new Date()
      request(server)
        .post('/posts?_delay=1100')
        .send({ body: 'foo', booleanValue: true, integerValue: 1 })
        .expect(201, function (err) {
          const end = new Date()
          done(end - start > 1000 ? err : new Error("Request wasn't delayed"))
        })
    })
  })

  describe('PUT /:resource/:id', () => {
    test('should respond with json and replace resource', async () => {
      const post = { id: 1, booleanValue: true, integerValue: 1 }
      const res = await request(server)
        .put('/posts/1')
        .set('Accept', 'application/json')
        // body property omitted to test that the resource is replaced
        .send(post)
        .expect('Content-Type', /json/)
        .expect(200, post)
      // TODO find a "supertest" way to test this
      // https://github.com/typicode/json-server/issues/396
      assert.deepStrictEqual(res.body, post)
      // assert it was created in database too
      assert.deepStrictEqual(db.posts[0], post)
    })

    test('should respond with 404 if resource is not found', () =>
      request(server)
        .put('/posts/9001')
        .send({ id: 1, body: 'bar' })
        .expect('Content-Type', cliArg._noDataNext ? /html/ : /json/)
        .expect(404, {}))
  })

  describe('PUT /:resource:id?_delay=', () => {
    test('should delay response', (done) => {
      const start = new Date()
      request(server)
        .put('/posts/1?_delay=1100')
        .set('Accept', 'application/json')
        .send({ id: 1, booleanValue: true, integerValue: 1 })
        .expect(200, function (err) {
          const end = new Date()
          done(end - start > 1000 ? err : new Error("Request wasn't delayed"))
        })
    })
  })

  describe('PATCH /:resource/:id', () => {
    test('should respond with json and update resource', async () => {
      const partial = { body: 'bar' }
      const post = { id: 1, body: 'bar' }
      const res = await request(server)
        .patch('/posts/1')
        .send(partial)
        .expect('Content-Type', /json/)
        .expect(200, post)
      assert.deepStrictEqual(res.body, post)
      // assert it was created in database too
      assert.deepStrictEqual(db.posts[0], post)
    })

    test('should respond with 404 if resource is not found', () =>
      request(server)
        .patch('/posts/9001')
        .send({ body: 'bar' })
        .expect('Content-Type', cliArg._noDataNext ? /html/ : /json/)
        .expect(404, {}))
  })

  describe('PATCH /:resource:id?_delay=', () => {
    test('should delay response', (done) => {
      const start = new Date()
      request(server)
        .patch('/posts/1?_delay=1100')
        .send({ body: 'bar' })
        .send({ id: 1, booleanValue: true, integerValue: 1 })
        .expect(200, function (err) {
          const end = new Date()
          done(end - start > 1000 ? err : new Error("Request wasn't delayed"))
        })
    })
  })

  describe('DELETE /:resource/:id', () => {
    test('should respond with empty data, destroy resource and dependent resources', async () => {
      await request(server).del('/posts/1').expect(200, {})
      assert.strictEqual(db.posts.length, 1)
      assert.strictEqual(db.comments.length, cliArg._noRemoveDependents ? 5 : 3)
    })

    test('should respond with 404 if resource is not found', () =>
      request(server)
        .del('/posts/9001')
        .expect('Content-Type', cliArg._noDataNext ? /html/ : /json/)
        .expect(404, {}))
  })

  describe('DELETE /:resource:id?_delay=', () => {
    test('should delay response', (done) => {
      const start = new Date()
      request(server)
        .del('/posts/1?_delay=1100')
        .send({ id: 1, booleanValue: true, integerValue: 1 })
        .expect(200, function (err) {
          const end = new Date()
          done(end - start > 1000 ? err : new Error("Request wasn't delayed"))
        })
    })
  })

  describe('Static routes', () => {
    describe('GET /', () => {
      test('should respond with html', () =>
        request(server)
          .get('/')
          .expect(/You're successfully running JSON Server/)
          .expect(200))
    })

    describe('GET /script.js', () => {
      test('should respond with js', () =>
        request(server)
          .get('/script.js')
          .expect('Content-Type', /javascript/)
          .expect(200))
    })

    describe('GET /style.css', () => {
      test('should respond with css', () =>
        request(server)
          .get('/style.css')
          .expect('Content-Type', /css/)
          .expect(200))
    })
  })

  describe('Database state', () => {
    test('should be accessible', () => {
      assert(router.db.getState())
    })
  })

  describe('Responses', () => {
    test('should have no cache headers (for IE)', () =>
      request(server)
        .get('/db')
        .expect('Cache-Control', 'no-cache')
        .expect('Pragma', 'no-cache')
        .expect('Expires', '-1'))
  })

  describe('Rewriter', () => {
    test('should rewrite using prefix', () =>
      request(server).get('/api/posts/1').expect(db.posts[0]))

    test('should rewrite using params', () =>
      request(server).get('/blog/posts/1/show').expect(db.posts[0]))

    test('should rewrite using query without params', () => {
      const expectedPost = _.cloneDeep(db.posts[0])
      expectedPost.comments = [db.comments[0], db.comments[1]]
      return request(server).get('/firstpostwithcomments').expect(expectedPost)
    })

    test('should rewrite using params and query', () =>
      request(server)
        .get('/comments/special/1-quux')
        .expect(200, [db.comments[4]]))

    test('should rewrite query params', () =>
      request(server).get('/articles?_id=1').expect(db.posts[0]))

    test('should expose routes', () =>
      request(server).get('/__rules').expect(rewriterRules))
  })

  describe('router.render', () => {
    beforeEach(() => {
      router.render = (req, res) => {
        res.jsonp({ data: res.locals.data })
      }
    })

    test('should be possible to wrap response', () =>
      request(server)
        .get('/posts/1')
        .expect('Content-Type', /json/)
        .expect(200, { data: db.posts[0] }))
  })

  describe('router.db._.id', () => {
    beforeEach(() => {
      router.db.setState({
        posts: [{ _id: 1 }],
      })

      router.db._.id = '_id'
    })

    test('should be possible to GET using a different id property', () =>
      request(server)
        .get('/posts/1')
        .expect('Content-Type', /json/)
        .expect(200, router.db.getState().posts[0]))

    test('should be possible to POST using a different id property', () =>
      request(server)
        .post('/posts')
        .send({ body: 'hello' })
        .expect('Content-Type', /json/)
        .expect(201, { _id: 2, body: 'hello' }))
  })
})