Unique indexes (#1971)

* Add unique indexing * Add unique indexing for username/email * WIP * Finish unique indexes * Notes on how to upgrade to 2.3.0 safely * index on unique-indexes: c454180 Revert "Log objects rather than JSON stringified objects (#1922)" * reconfigure username/email tests * Start dealing with test shittyness * Remove tests for files that we are removing * most tests passing * fix failing test * Make specific server config for tests async * Fix more tests * fix more tests * Fix another test * fix more tests * Fix email validation * move some stuff around * Destroy server to ensure all connections are gone * Fix broken cloud code * Save callback to variable * no need to delete non existant cloud * undo * Fix all tests where connections are left open after server closes. * Fix issues caused by missing gridstore adapter * Update guide for 2.3.0 and fix final tests * use strict * don't use features that won't work in node 4 * Fix syntax error * Fix typos * Add duplicate finding command * Update 2.3.0.md
parse-community · Jun 11, 2016 · 7e868b2 · 7e868b2
1 parent 6415a35
commit 7e868b2
Show file tree

Hide file tree

Showing 37 changed files with 1,738 additions and 1,528 deletions.
diff --git a/2.3.0.md b/2.3.0.md
@@ -0,0 +1,82 @@
+# Upgrading Parse Server to version 2.3.0
+
+Parse Server version 2.3.0 begins using unique indexes to ensure User's username and email are unique. This is not a backwards incompatable change, but it may in some cases cause a significant performance regression until the index finishes building. Building the unique index before upgrading your Parse Server version will eliminate the performance impact, and is a recommended step before upgrading any app to Parse Server 2.3.0. New apps starting with version 2.3.0 do not need to take any steps before beginning their project.
+
+If you are using MongoDB in Cluster or Replica Set mode, we recommend reading Mongo's [documentation on index building](https://docs.mongodb.com/v3.0/tutorial/build-indexes-on-replica-sets/) first. If you are not using these features, you can execute the following commands from the Mongo shell to build the unique index. You may also want to create a backup first.
+
+```js
+// Select the database that your Parse App uses
+use parse;
+
+// Select the collection your Parse App uses for users. For migrated apps, this probably includes a collectionPrefix.
+var coll = db['your_prefix:_User'];
+
+// You can check if the indexes already exists by running coll.getIndexes()
+coll.getIndexes();
+
+// The indexes you want should look like this. If they already exist, you can skip creating them.
+{
+  "v" : 1,
+  "unique" : true,
+  "key" : {
+    "username" : 1
+  },
+  "name" : "username_1",
+  "ns" : "parse.your_prefix:_User",
+  "background" : true,
+  "sparse" : true
+}
+
+{
+  "v" : 1,
+  "unique" : true,
+  "key" : {
+    "email" : 1
+  },
+  "name" : "email_1",
+  "ns" : "parse.your_prefix:_User",
+  "background" : true,
+  "sparse" : true
+}
+
+// Create the username index.
+// "background: true" is mandatory and avoids downtime while the index builds.
+// "sparse: true" is also mandatory because Parse Server uses sparse indexes.
+coll.ensureIndex({ username: 1 }, { background: true, unique: true, sparse: true });
+
+// Create the email index.
+// "background: true" is still mandatory.
+// "sparse: true" is also mandatory both because Parse Server uses sparse indexes, and because email addresses are not required by the Parse API.
+coll.ensureIndex({ email: 1 }, { background: true, unique: true, sparse: true });
+```
+
+There are some issues you may run into during this process:
+
+## Mongo complains that the index already exists, but with different options
+
+In this case, you will need to remove the incorrect index. If your app relies on the existence of the index in order to be performant, you can create a new index, with "-1" for the direction of the field, so that it counts as different options. Then, drop the conflicting index, and create the unique index.
+
+## There is already non-unique data in the username or email field
+
+This is possible if you have explicitly set some user's emails to null. If this is bogus data, and those null fields shoud be unset, you can unset the null emails with this command. If your app relies on the difference between null and unset emails, you will need to upgrade your app to treat null and unset emails the same before building the index and upgrading to Parse Server 2.3.0.
+
+```js
+coll.update({ email: { $exists: true, $eq: null } }, { $unset: { email: '' } }, { multi: true })
+```
+
+## There is already non-unique data in the username or email field, and it's not nulls
+
+This is possible due to a race condition in previous versions of Parse Server. If you have this problem, it is unlikely that you have a lot of rows with duplicate data. We recommend you clean up the data manually, by removing or modifying the offending rows.
+
+This command, can be used to find the duplicate data:
+
+```js
+coll.aggregate([
+  {$match: {"username": {"$ne": null}}},
+  {$group: {_id: "$username", uniqueIds: {$addToSet: "$_id"}, count: {$sum: 1}}},
+  {$match: {count: {"$gt": 1}}},
+  {$project: {id: "$uniqueIds", username: "$_id", _id : 0} },
+  {$unwind: "$id" },
+  {$out: '_duplicates'} // Save the list of duplicates to a new, "_duplicates collection. Remove this line to just output the list.
+], {allowDiskUse:true})
+```
diff --git a/package.json b/package.json
@@ -40,6 +40,7 @@
     "parse-server-simple-mailgun-adapter": "^1.0.0",
     "redis": "^2.5.0-1",
     "request": "^2.65.0",
+    "request-promise": "^3.0.0",
     "tv4": "^1.2.7",
     "winston": "^2.1.1",
     "winston-daily-rotate-file": "^1.0.1",

diff --git a/spec/CloudCode.spec.js b/spec/CloudCode.spec.js
@@ -1,33 +1,28 @@
 "use strict"
 const Parse = require("parse/node");
 const request = require('request');
+const rp = require('request-promise');
 const InMemoryCacheAdapter = require('../src/Adapters/Cache/InMemoryCacheAdapter').InMemoryCacheAdapter;
 
 describe('Cloud Code', () => {
   it('can load absolute cloud code file', done => {
-    setServerConfiguration({
-      serverURL: 'http://localhost:8378/1',
-      appId: 'test',
-      masterKey: 'test',
-      cloud: __dirname + '/cloud/cloudCodeRelativeFile.js'
-    });
-    Parse.Cloud.run('cloudCodeInFile', {}, result => {
-      expect(result).toEqual('It is possible to define cloud code in a file.');
-      done();
-    });
+    reconfigureServer({ cloud: __dirname + '/cloud/cloudCodeRelativeFile.js' })
+    .then(() => {
+      Parse.Cloud.run('cloudCodeInFile', {}, result => {
+        expect(result).toEqual('It is possible to define cloud code in a file.');
+        done();
+      });
+    })
   });
 
   it('can load relative cloud code file', done => {
-    setServerConfiguration({
-      serverURL: 'http://localhost:8378/1',
-      appId: 'test',
-      masterKey: 'test',
-      cloud: './spec/cloud/cloudCodeAbsoluteFile.js'
-    });
-    Parse.Cloud.run('cloudCodeInFile', {}, result => {
-      expect(result).toEqual('It is possible to define cloud code in a file.');
-      done();
-    });
+    reconfigureServer({ cloud: './spec/cloud/cloudCodeAbsoluteFile.js' })
+    .then(() => {
+      Parse.Cloud.run('cloudCodeInFile', {}, result => {
+        expect(result).toEqual('It is possible to define cloud code in a file.');
+        done();
+      });
+    })
   });
 
   it('can create functions', done => {
@@ -568,67 +563,75 @@ describe('Cloud Code', () => {
   });
 
   it('clears out the user cache for all sessions when the user is changed', done => {
+    let session1;
+    let session2;
+    let user;
     const cacheAdapter = new InMemoryCacheAdapter({ ttl: 100000000 });
-    setServerConfiguration(Object.assign({}, defaultConfiguration, { cacheAdapter: cacheAdapter }));
-    Parse.Cloud.define('checkStaleUser', (request, response) => {
-      response.success(request.user.get('data'));
-    });
+    reconfigureServer({ cacheAdapter })
+    .then(() => {
+      Parse.Cloud.define('checkStaleUser', (request, response) => {
+        response.success(request.user.get('data'));
+      });
 
-    let user = new Parse.User();
-    user.set('username', 'test');
-    user.set('password', 'moon-y');
-    user.set('data', 'first data');
-    user.signUp()
+      user = new Parse.User();
+      user.set('username', 'test');
+      user.set('password', 'moon-y');
+      user.set('data', 'first data');
+      return user.signUp();
+    })
     .then(user => {
-      let session1 = user.getSessionToken();
-      request.get({
-        url: 'http://localhost:8378/1/login?username=test&password=moon-y',
+      session1 = user.getSessionToken();
+      return rp({
+        uri: 'http://localhost:8378/1/login?username=test&password=moon-y',
         json: true,
         headers: {
           'X-Parse-Application-Id': 'test',
           'X-Parse-REST-API-Key': 'rest',
         },
-      }, (error, response, body) => {
-        let session2 = body.sessionToken;
-
-        //Ensure both session tokens are in the cache
-        Parse.Cloud.run('checkStaleUser')
-        .then(() => {
-          request.post({
-            url: 'http://localhost:8378/1/functions/checkStaleUser',
-            json: true,
-            headers: {
-              'X-Parse-Application-Id': 'test',
-              'X-Parse-REST-API-Key': 'rest',
-              'X-Parse-Session-Token': session2,
-            }
-          }, (error, response, body) => {
-            Parse.Promise.all([cacheAdapter.get('test:user:' + session1), cacheAdapter.get('test:user:' + session2)])
-            .then(cachedVals => {
-              expect(cachedVals[0].objectId).toEqual(user.id);
-              expect(cachedVals[1].objectId).toEqual(user.id);
-
-              //Change with session 1 and then read with session 2.
-              user.set('data', 'second data');
-              user.save()
-              .then(() => {
-                request.post({
-                  url: 'http://localhost:8378/1/functions/checkStaleUser',
-                  json: true,
-                  headers: {
-                    'X-Parse-Application-Id': 'test',
-                    'X-Parse-REST-API-Key': 'rest',
-                    'X-Parse-Session-Token': session2,
-                  }
-                }, (error, response, body) => {
-                  expect(body.result).toEqual('second data');
-                  done();
-                })
-              });
-            });
-          });
-        });
-      });
+      })
+    })
+    .then(body => {
+      session2 = body.sessionToken;
+
+      //Ensure both session tokens are in the cache
+      return Parse.Cloud.run('checkStaleUser')
+    })
+    .then(() => rp({
+      method: 'POST',
+      uri: 'http://localhost:8378/1/functions/checkStaleUser',
+      json: true,
+      headers: {
+        'X-Parse-Application-Id': 'test',
+        'X-Parse-REST-API-Key': 'rest',
+        'X-Parse-Session-Token': session2,
+      }
+    }))
+    .then(() => Parse.Promise.all([cacheAdapter.get('test:user:' + session1), cacheAdapter.get('test:user:' + session2)]))
+    .then(cachedVals => {
+      expect(cachedVals[0].objectId).toEqual(user.id);
+      expect(cachedVals[1].objectId).toEqual(user.id);
+
+      //Change with session 1 and then read with session 2.
+      user.set('data', 'second data');
+      return user.save()
+    })
+    .then(() => rp({
+      method: 'POST',
+      uri: 'http://localhost:8378/1/functions/checkStaleUser',
+      json: true,
+      headers: {
+        'X-Parse-Application-Id': 'test',
+        'X-Parse-REST-API-Key': 'rest',
+        'X-Parse-Session-Token': session2,
+      }
+    }))
+    .then(body => {
+      expect(body.result).toEqual('second data');
+      done();
+    })
+    .catch(error => {
+      fail(JSON.stringify(error));
+      done();
     });
   });
 

diff --git a/spec/DatabaseAdapter.spec.js b/spec/DatabaseAdapter.spec.js
diff --git a/spec/DatabaseController.spec.js b/spec/DatabaseController.spec.js
diff --git a/spec/FileLoggerAdapter.spec.js b/spec/FileLoggerAdapter.spec.js
@@ -52,9 +52,9 @@ describe('error logs', () => {
 describe('verbose logs', () => {
 
   it("mask sensitive information in _User class", (done) => {
-    let customConfig = Object.assign({}, defaultConfiguration, {verbose: true});
-    setServerConfiguration(customConfig);
-    createTestUser().then(() => {
+    reconfigureServer({ verbose: true })
+    .then(() => createTestUser())
+    .then(() => {
       let fileLoggerAdapter = new FileLoggerAdapter();
       return fileLoggerAdapter.query({
         from: new Date(Date.now() - 500),

diff --git a/spec/Parse.Push.spec.js b/spec/Parse.Push.spec.js
@@ -28,26 +28,27 @@ describe('Parse.Push', () => {
       }
     }
 
-    setServerConfiguration({
+    return reconfigureServer({
       appId: Parse.applicationId,
       masterKey: Parse.masterKey,
       serverURL: Parse.serverURL,
       push: {
         adapter: pushAdapter
       }
+    })
+    .then(() => {
+      var installations = [];
+      while(installations.length != 10) {
+        var installation = new Parse.Object("_Installation");
+        installation.set("installationId", "installation_"+installations.length);
+        installation.set("deviceToken","device_token_"+installations.length)
+        installation.set("badge", installations.length);
+        installation.set("originalBadge", installations.length);
+        installation.set("deviceType", "ios");
+        installations.push(installation);
+      }
+      return Parse.Object.saveAll(installations);
     });
-
-    var installations = [];
-    while(installations.length != 10) {
-      var installation = new Parse.Object("_Installation");
-      installation.set("installationId", "installation_"+installations.length);
-      installation.set("deviceToken","device_token_"+installations.length)
-      installation.set("badge", installations.length);
-      installation.set("originalBadge", installations.length);
-      installation.set("deviceType", "ios");
-      installations.push(installation);
-    }
-    return Parse.Object.saveAll(installations);
   }
 
   it('should properly send push', (done) => {
@@ -110,7 +111,7 @@ describe('Parse.Push', () => {
           'X-Parse-Application-Id': 'test',
         },
       }, (error, response, body) => {
-        expect(body.results.length).toEqual(0);
+        expect(body.error).toEqual('unauthorized');
         done();
       });
     });