Merge pull request #87 from Human-Connection/upgrade-to-feathers-v3

[WIP] Upgrade to feathers v3

Author: appinteractive

package.json

@@ -52,6 +52,14 @@
     "concurrently": "concurrently --kill-others --success first"
   },
   "dependencies": {
+    "@feathersjs/authentication": "^2.1.7",
+    "@feathersjs/authentication-jwt": "^2.0.1",
+    "@feathersjs/authentication-local": "^1.2.1",
+    "@feathersjs/configuration": "^1.0.2",
+    "@feathersjs/errors": "^3.3.0",
+    "@feathersjs/express": "^1.2.3",
+    "@feathersjs/feathers": "^3.1.7",
+    "@feathersjs/socketio": "^3.2.2",
     "body-parser": "~1.18.3",
     "cheerio": "^1.0.0-rc.2",
     "compression": "~1.7.2",
@@ -60,27 +68,18 @@
     "crypto-js": "^3.1.9-1",
     "dauria": "~2.0.0",
     "email-templates": "2.6.0",
-    "feathers": "~2.2.4",
-    "feathers-authentication": "~1.3.1",
-    "feathers-authentication-hooks": "~0.1.6",
-    "feathers-authentication-jwt": "~0.3.2",
-    "feathers-authentication-local": "~0.4.4",
-    "feathers-authentication-management": "~1.0.3",
-    "feathers-blob": "~1.3.1",
-    "feathers-configuration": "~0.4.2",
-    "feathers-errors": "~2.9.2",
-    "feathers-hooks": "~2.1.2",
-    "feathers-hooks-common": "~3.10.0",
-    "feathers-logger": "0.2.3",
+    "feathers-authentication-hooks": "~0.3.0",
+    "feathers-authentication-management": "~2.0.0",
+    "feathers-blob": "~2.0.1",
+    "feathers-hooks-common": "~4.14.0",
+    "feathers-logger": "0.3.2",
     "feathers-mailer": "~2.0.0",
-    "feathers-memory": "~1.3.1",
-    "feathers-mongodb": "~3.0.0",
+    "feathers-memory": "~2.1.3",
+    "feathers-mongodb": "~3.2.0",
     "feathers-mongodb-fuzzy-search": "~1.1.1",
-    "feathers-mongoose": "~5.1.2",
+    "feathers-mongoose": "~6.1.2",
     "feathers-profiler": "^0.1.5",
-    "feathers-rest": "~1.8.1",
     "feathers-seeder": "~1.0.10",
-    "feathers-socketio": "~2.0.1",
     "fs-blob-store": "~5.2.1",
     "fs-extra": "~4.0.2",
     "handlebars": "~4.0.11",
@@ -112,6 +111,7 @@
     "istanbul": "1.1.0-alpha.1",
     "mocha": "~5.2.0",
     "nodemon": "~1.17.4",
+    "nyc": "^12.0.2",
     "wait-on": "~2.1.0"
   }
 }

server/app.js

@@ -5,12 +5,13 @@ const cors = require('cors');
 // const helmet = require('helmet');
 const bodyParser = require('body-parser');
 
-const feathers = require('feathers');
-const configuration = require('feathers-configuration');
-const hooks = require('feathers-hooks');
-const rest = require('feathers-rest');
-const socketio = require('feathers-socketio');
+const feathers = require('@feathersjs/feathers');
+const express = require('@feathersjs/express');
+const configuration = require('@feathersjs/configuration');
+const rest = require('@feathersjs/express/rest');
+const socketio = require('@feathersjs/socketio');
 const seeder = require('./seeder');
+const channels = require('./channels');
 
 const middleware = require('./middleware');
 const services = require('./services');
@@ -21,7 +22,7 @@ const Raven = require('raven');
 const logger = require('./logger');
 const { profiler }  = require('feathers-profiler');
 
-const app = feathers();
+const app = express(feathers());
 
 app.configure(require('feathers-logger')(logger));
 
@@ -49,10 +50,8 @@ app.use(bodyParser.json());
 app.use(bodyParser.urlencoded({ extended: true }));
 app.use(favicon(path.join(app.get('public'), 'favicon.ico')));
 // Host the public folder
-app.use('/', feathers.static(app.get('public')));
+app.use('/', express.static(app.get('public')));
 
-// Set up Plugins and providers
-app.configure(hooks());
 app.configure(mongoose);
 app.configure(rest());
 
@@ -65,6 +64,7 @@ app.configure(authentication);
 
 // Set up our services (see `services/index.js`)
 app.configure(services);
+app.configure(channels);
 
 if (process.env.NODE_ENV !== 'production') {
   app.configure(profiler({

server/authentication.js

@@ -1,6 +1,6 @@
-const authentication = require('feathers-authentication');
-const jwt = require('feathers-authentication-jwt');
-const local = require('feathers-authentication-local');
+const authentication = require('@feathersjs/authentication');
+const jwt = require('@feathersjs/authentication-jwt');
+const local = require('@feathersjs/authentication-local');
 const { lowerCase } = require('feathers-hooks-common');
 
 module.exports = function () {

server/channels.js

@@ -0,0 +1,86 @@
+module.exports = function (app) {
+  if (typeof app.channel !== 'function') {
+    // If no real-time functionality has been configured just return
+    return;
+  }
+
+  app.on('connection', connection => {
+    // On a new real-time connection, add it to the anonymous channel
+    app.channel('anonymous').join(connection);
+  });
+
+  app.on('login', (authResult, { connection }) => {
+    // connection can be undefined if there is no
+    // real-time connection, e.g. when logging in via REST
+    if (connection) {
+      // Obtain the logged in user from the connection
+      const user = connection.user;
+
+      // The connection is no longer anonymous, remove it
+      app.channel('anonymous').leave(connection);
+
+      // Add it to the authenticated user channel
+      app.channel('authenticated').join(connection);
+
+      if (user.role === 'moderator') { app.channel('moderators').join(connection); }
+      if (user.role === 'admin') { app.channel('admins').join(connection); }
+
+      // Channels can be named anything and joined on any condition
+
+      // E.g. to send real-time events only to admins use
+      // if(user.isAdmin) { app.channel('admins').join(connection); }
+
+      // If the user has joined e.g. chat rooms
+      // if(Array.isArray(user.rooms)) user.rooms.forEach(room => app.channel(`rooms/${room.id}`).join(channel));
+
+      // Easily organize users by email and userid for things like messaging
+      // app.channel(`emails/${user.email}`).join(channel);
+      // app.channel(`userIds/$(user.id}`).join(channel);
+    }
+  });
+
+  // app.publish((data, hook) => { // eslint-disable-line no-unused-vars
+  //   // Here you can add event publishers to channels set up in `channels.js`
+  //   // To publish only for a specific event use `app.publish(eventname, () => {})`
+  //   // e.g. to publish all service events to all authenticated users use
+  //   return app.channel('authenticated');
+  // });
+
+  app.service('contributions').publish('patched', () => app.channel('authenticated'));
+
+  app.service('categories').publish(() => app.channel('anonymous', 'authenticated'));
+  app.service('comments').publish(() => app.channel('authenticated'));
+  app.service('follows').publish(() => app.channel('authenticated'));
+  app.service('users-candos').publish(() => app.channel('authenticated'));
+  app.service('notifications').publish(() => app.channel('authenticated'));
+  app.service('system-notifications').publish(() => app.channel('authenticated'));
+
+  app.service('users').publish(() => app.channel('admins'));
+  app.service('organizations').publish(() => app.channel('admins', 'moderators'));
+
+  // app.service('contributions').publish((data) => {
+  //   return [
+  //     // app.channel('anonymous'),
+  //     // app.channel('authenticated')
+  //     app.channel(`contributions/${data._id}`)
+  //   ];
+  // });
+  // app.service('contributions').publish((data) => {
+  //   return app.channel(`contributions/${data.slug}`);
+  // });
+  // app.service('comments').publish((data) => {
+  //   return app.channel(`contributions/${data.slug}`);
+  // });
+
+  // Here you can also add service specific event publishers
+  // e..g the publish the `users` service `created` event to the `admins` channel
+  // app.service('users').publish('created', () => app.channel('admins'));
+
+  // With the userid and email organization from above you can easily select involved users
+  // app.service('messages').publish(() => {
+  //   return [
+  //     app.channel(`userIds/${data.createdBy}`),
+  //     app.channel(`emails/${data.recipientEmail}`)
+  //   ];
+  // });
+};

server/hooks/exclude-disabled.js

@@ -1,5 +1,5 @@
 // Exclude items with isEnabled = false
-const errors = require('feathers-errors');
+const errors = require('@feathersjs/errors');
 
 module.exports = function excludeDisabled() {
   return function (hook) {

server/hooks/is-admin.js

@@ -1,5 +1,5 @@
 // Check if user is admin
-const errors = require('feathers-errors');
+const errors = require('@feathersjs/errors');
 
 module.exports = () => hook => {
   if(!hook.params || !hook.params.user || hook.params.user.role !== 'admin') {

server/hooks/is-enabled.js

@@ -2,7 +2,7 @@
 // For more information on hooks see: http://docs.feathersjs.com/api/hooks.html
 
 const _ = require('lodash');
-const errors = require('feathers-errors');
+const errors = require('@feathersjs/errors');
 
 module.exports = function isEnabled(options = {}) { // eslint-disable-line no-unused-vars
   return function (hook) {

server/hooks/is-moderator.js

@@ -1,5 +1,5 @@
 // Check if user is moderator
-const errors = require('feathers-errors');
+const errors = require('@feathersjs/errors');
 
 module.exports = () => hook => {
   if(!hook.params || !hook.params.user || !['admin','moderator'].includes(hook.params.user.role)) {

server/hooks/restrictToOwnerOrModerator.js

@@ -1,5 +1,5 @@
 const { getByDot } = require('feathers-hooks-common');
-const errors = require('feathers-errors');
+const errors = require('@feathersjs/errors');
 
 module.exports = function restrictToOwnerOrModerator (query = {}) { // eslint-disable-line no-unused-vars
   return function (hook) {

server/middleware/index.js

@@ -1,4 +1,4 @@
-const handler = require('feathers-errors/handler');
+const handler = require('@feathersjs/express/errors');
 const notFound = require('feathers-errors/not-found');
 
 module.exports = function () {