user tests and optimization

Author: visualjerk

README.md

@@ -81,9 +81,10 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
    We are using [Thumbor](https://github.com/thumbor/thumbor) as a Thumbnail Microservice.
    You can install it locally if you like but this is totally optional.
    
-   - At first you have to [install](http://thumbor.readthedocs.io/en/latest/installing.html) it locally.
-   - After installation start it via the console with `thumbor`
-   - Set the `thumbor.url` in `config/local.json` to `http://localhost:8888` if not defined differently. The `thumbor.key` does not necessarily have to be defined, it just makes the URL more secure.
+   **Install OR use docker**
+   
+   - At first you have to [install](http://thumbor.readthedocs.io/en/latest/installing.html) it locally and start it in the console with `thumbor` **OR** run it with docker `docker run -p 8000:8000 apsl/thumbor`
+   - Set the `thumbor.url` in `config/local.json` to `http://localhost:8888` (with docker `http://localhost:8000`) if not defined differently. The `thumbor.key` does not necessarily have to be defined, it just makes the URL more secure.
    
    > Do not forget to always start it if you choose that setup or otherwise you will not see any pictures at all.
 

server/hooks/is-single-item.js

@@ -1,6 +1,6 @@
 // Check if the query is for a single item
 module.exports = () => hook => {
-  if (hook && hook.params && hook.params.query && hook.params.query.$limit === 1) {
+  if (hook && hook.params && hook.params.query && (hook.params.query.$limit === 1 || hook.params.query.slug)) {
     return true;
   } else {
     return false;

server/logger.js

@@ -22,6 +22,6 @@ logger.add(new transports.Console({
       return `${levelColors[info.level]}${date.toLocaleTimeString()} | ${info.level}: ${JSON.stringify(info.message)}\u001b[39m`;
     })
   ),
-  level: env === 'development' ? 'debug' : 'warn'
+  level: env === 'development' || 'test' ? 'debug' : 'warn'
 }));
 module.exports = logger;

server/services/users/users.hooks.js

@@ -8,6 +8,8 @@ const restrictUserRole = require('./hooks/restrict-user-role');
 const createAdmin = require('./hooks/create-admin');
 const createSlug = require('../../hooks/create-slug');
 const thumbnails = require('../../hooks/thumbnails');
+const isModerator = require('../../hooks/is-moderator-boolean');
+const isSingleItem = require('../../hooks/is-single-item');
 const inviteCode = require('./hooks/invite-code')();
 const search = require('feathers-mongodb-fuzzy-search');
 const isOwnEntry = require('./hooks/is-own-entry');
@@ -155,16 +157,24 @@ module.exports = {
 
   after: {
     all: [
-      populate({ schema: badgesSchema }),
-      populate({ schema: candosSchema }),
-      populate({ schema: userSettingsSchema }),
       cleanupBasicData
     ],
     find: [
+      when(isModerator(),
+        populate({ schema: userSettingsSchema })
+      ),
+      when(isSingleItem(),
+        populate({ schema: badgesSchema }),
+        populate({ schema: candosSchema }),
+        populate({ schema: userSettingsSchema })
+      ),
       thumbnails(thumbnailOptions),
       cleanupPersonalData
     ],
     get: [
+      populate({ schema: badgesSchema }),
+      populate({ schema: candosSchema }),
+      populate({ schema: userSettingsSchema }),
       thumbnails(thumbnailOptions),
       // remove personal data if its not the current authenticated user
       iff(isOwnEntry(false),

test/assets/users.js

@@ -0,0 +1,22 @@
+const adminData = {
+  email: '[email protected]',
+  password: '1234',
+  name: 'Peter',
+  timezone: 'Europe/Berlin',
+  badgeIds: [],
+  role: 'admin'
+};
+
+const userData = {
+  email: '[email protected]',
+  password: '1234',
+  name: 'John',
+  timezone: 'Europe/Berlin',
+  badgeIds: [],
+  role: 'user'
+};
+
+module.exports = {
+  adminData,
+  userData
+};

test/services/users.test.js

@@ -1,10 +1,132 @@
 const assert = require('assert');
 const app = require('../../server/app');
+const service = app.service('users');
+const { userData, adminData } = require('../assets/users');
 
 describe('\'users\' service', () => {
-  it('registered the service', () => {
-    const service = app.service('users');
+  let admin;
+  let adminParams;
+  let user;
+  let userParams;
+
+  before(function(done) {
+    this.server = app.listen(3031);
+    this.server.once('listening', () => done());
+  });
+
+  after(function(done) {
+    this.server.close(done);
+  });
+
+  beforeEach(async () => {
+    await app.get('mongooseClient').connection.dropDatabase();
+    admin = await service.create(adminData);
+    adminParams = {
+      user: admin
+    };
+    user = await service.create(userData);
+    userParams = {
+      user: user
+    };
+  });
 
+  afterEach(async () => {
+    await app.get('mongooseClient').connection.dropDatabase();
+    admin = null;
+    adminParams = null;
+    user = null;
+    userParams = null;
+  });
+
+  it('registered the service', () => {
     assert.ok(service, 'Registered the service');
   });
+
+  describe('users create', () => {
+    it('runs create', () => {
+      assert.ok(user, 'Created user');
+    });
+
+    it('does not generate slug', () => {
+      assert.strictEqual(user.slug, undefined);
+    });
+  });
+
+  describe('users patch', () => {
+    it('runs patch', async () => {
+      const result = await service.patch(user._id, {
+        name: 'Alice'
+      }, userParams);
+      assert.ok(result, 'Patched user');
+      assert.equal(result.name, 'Alice', 'Patched user name');
+    });
+
+    it('generates slug from name', async () => {
+      const result = await service.patch(user._id, {
+        name: 'Alice'
+      }, userParams);
+      assert.equal(result.slug, 'alice');
+    });
+  });
+
+  describe('users find', () => {
+    it('returns users', async () => {
+      const result = await service.find();
+      assert.ok(result.data[0]);
+    });
+
+    it('does not populate badges, candos and userSettings', async () => {
+      const result = await service.find(userParams);
+      assert.strictEqual(result.data[0].badges, undefined);
+      assert.strictEqual(result.data[0].candos, undefined);
+      assert.strictEqual(result.data[0].userSettings, undefined);
+    });
+
+    it('populates userSettings for admins', async () => {
+      const result = await service.find(adminParams);
+      assert.notStrictEqual(result.data[0].userSettings, undefined);
+    });
+  });
+
+  describe('users find by slug', () => {
+    let query;
+
+    // Slug is generated in first patch call
+    beforeEach(async () => {
+      const result = await service.patch(user._id, {
+        name: user.name
+      }, userParams);
+      user.slug = result.slug;
+      query = {
+        slug: user.slug
+      };
+    });
+
+    it('returns one user', async () => {
+      const result = await service.find({ query });
+      assert.ok(result.data[0], 'returns data');
+      assert.equal(result.data.length, 1), 'returns only one entry';
+    });
+
+    it('populates badges, candos and userSettings', async () => {
+      const result = await service.find({ query });
+      assert.notStrictEqual(result.data[0].badges, undefined, 'has badges');
+      assert.notStrictEqual(result.data[0].candos, undefined, 'has candos');
+      assert.notStrictEqual(result.data[0].userSettings, undefined, 'has userSettings');
+    });
+  });
+
+  describe('users get', () => {
+    it('returns user', async () => {
+      const result = await service.get(user._id);
+      assert.ok(result, 'returns data');
+    });
+
+    it('populates badges, candos and userSettings', async () => {
+      const result = await service.get(user._id);
+      assert.notStrictEqual(result.badges, undefined, 'has badges');
+      assert.notStrictEqual(result.candos, undefined, 'has candos');
+      assert.notStrictEqual(result.userSettings, undefined, 'has userSettings');
+    });
+  });
 });