Properly escape partition ID's (fixes #283) (#284)

This is a breaking change, for reasons descibed in that bug report.

Author: swansontec

lib/nano.js

@@ -1036,7 +1036,7 @@ module.exports = exports = function dbScope (cfg) {
 
       return relax({
         db: dbName,
-        path: '_partition/' + partitionKey
+        path: '_partition/' + encodeURIComponent(partitionKey)
       }, callback)
     }
 
@@ -1047,15 +1047,15 @@ module.exports = exports = function dbScope (cfg) {
       }
       return relax({
         db: dbName,
-        path: '_partition/' + partitionKey + '/_all_docs',
+        path: '_partition/' + encodeURIComponent(partitionKey) + '/_all_docs',
         qs: opts
       }, callback)
     }
 
     function partitionedListAsStream (partitionKey, qs) {
       return relax({
         db: dbName,
-        path: '_partition/' + partitionKey + '/_all_docs',
+        path: '_partition/' + encodeURIComponent(partitionKey) + '/_all_docs',
         qs: qs,
         stream: true
       })
@@ -1068,7 +1068,7 @@ module.exports = exports = function dbScope (cfg) {
 
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_find',
+        path: '_partition/' + encodeURIComponent(partition) + '/_find',
         method: 'POST',
         body: query
       }, callback)
@@ -1077,7 +1077,7 @@ module.exports = exports = function dbScope (cfg) {
     function partitionedFindAsStream (partition, query) {
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_find',
+        path: '_partition/' + encodeURIComponent(partition) + '/_find',
         method: 'POST',
         body: query,
         stream: true
@@ -1090,15 +1090,15 @@ module.exports = exports = function dbScope (cfg) {
       }
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_design/' + ddoc + '/_search/' + searchName,
+        path: '_partition/' + encodeURIComponent(partition) + '/_design/' + ddoc + '/_search/' + searchName,
         qs: opts
       }, callback)
     }
 
     function partitionedSearchAsStream (partition, ddoc, searchName, opts) {
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_design/' + ddoc + '/_search/' + searchName,
+        path: '_partition/' + encodeURIComponent(partition) + '/_design/' + ddoc + '/_search/' + searchName,
         qs: opts,
         stream: true
       })
@@ -1110,15 +1110,15 @@ module.exports = exports = function dbScope (cfg) {
       }
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_design/' + ddoc + '/_view/' + viewName,
+        path: '_partition/' + encodeURIComponent(partition) + '/_design/' + ddoc + '/_view/' + viewName,
         qs: opts
       }, callback)
     }
 
     function partitionedViewAsStream (partition, ddoc, viewName, opts) {
       return relax({
         db: dbName,
-        path: '_partition/' + partition + '/_design/' + ddoc + '/_view/' + viewName,
+        path: '_partition/' + encodeURIComponent(partition) + '/_design/' + ddoc + '/_view/' + viewName,
         qs: opts,
         stream: true
       })

test/partition.list.test.js

@@ -121,6 +121,23 @@ test('should be able to list partition docs (callback) - GET /db/_partition/_all
   })
 })
 
+test('should escape unusual characters - GET /db/_partition/a+b/_all_docs - db.partitionedList', async () => {
+  // mocks
+  const scope = nock(COUCH_URL)
+    .get('/db/_partition/a%2Bb/_all_docs')
+    .reply(200, response)
+
+  // test GET /db/_partition/_all_docs
+  return new Promise((resolve, reject) => {
+    db.partitionedList('a+b', (err, data) => {
+      expect(err).toBeNull()
+      expect(data).toStrictEqual(response)
+      expect(scope.isDone()).toBe(true)
+      resolve()
+    })
+  })
+})
+
 test('should handle missing database - GET /db/_partition/_all_docs - db.partitionedList', async () => {
   // mocks
   const scope = nock(COUCH_URL)