aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/app.hooks.js34
-rw-r--r--src/app.js57
-rw-r--r--src/authentication.js27
-rw-r--r--src/channels.js61
-rw-r--r--src/hooks/log.js24
-rw-r--r--src/hooks/populate-user.js9
-rw-r--r--src/hooks/process-post.js35
-rw-r--r--src/index.js13
-rw-r--r--src/logger.js16
-rw-r--r--src/middleware/index.js5
-rw-r--r--src/models/posts.model.js28
-rw-r--r--src/models/users.model.js36
-rw-r--r--src/sequelize.js70
-rw-r--r--src/services/index.js7
-rw-r--r--src/services/posts/posts.hooks.js33
-rw-r--r--src/services/posts/posts.service.js22
-rw-r--r--src/services/users/users.hooks.js41
-rw-r--r--src/services/users/users.service.js22
18 files changed, 540 insertions, 0 deletions
diff --git a/src/app.hooks.js b/src/app.hooks.js
new file mode 100644
index 0000000..20ce4bf
--- /dev/null
+++ b/src/app.hooks.js
@@ -0,0 +1,34 @@
+// Application hooks that run for every service
+const log = require('./hooks/log');
+
+module.exports = {
+ before: {
+ all: [ log() ],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ },
+
+ after: {
+ all: [ log() ],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ },
+
+ error: {
+ all: [ log() ],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ }
+};
diff --git a/src/app.js b/src/app.js
new file mode 100644
index 0000000..38dc6dc
--- /dev/null
+++ b/src/app.js
@@ -0,0 +1,57 @@
+const path = require('path');
+const favicon = require('serve-favicon');
+const compress = require('compression');
+const helmet = require('helmet');
+const cors = require('cors');
+const logger = require('./logger');
+
+const feathers = require('@feathersjs/feathers');
+const configuration = require('@feathersjs/configuration');
+const express = require('@feathersjs/express');
+const socketio = require('@feathersjs/socketio');
+
+
+const middleware = require('./middleware');
+const services = require('./services');
+const appHooks = require('./app.hooks');
+const channels = require('./channels');
+
+const sequelize = require('./sequelize');
+
+const authentication = require('./authentication');
+
+const app = express(feathers());
+
+// Load app configuration
+app.configure(configuration());
+// Enable security, CORS, compression, favicon and body parsing
+app.use(helmet());
+app.use(cors());
+app.use(compress());
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+app.use(favicon(path.join(app.get('public'), 'favicon.ico')));
+// Host the public folder
+app.use('/', express.static(app.get('public')));
+
+// Set up Plugins and providers
+app.configure(express.rest());
+app.configure(socketio());
+
+app.configure(sequelize);
+
+// Configure other middleware (see `middleware/index.js`)
+app.configure(middleware);
+app.configure(authentication);
+// Set up our services (see `services/index.js`)
+app.configure(services);
+// Set up event channels (see channels.js)
+app.configure(channels);
+
+// Configure a middleware for 404s and the error handler
+app.use(express.notFound());
+app.use(express.errorHandler({ logger }));
+
+app.hooks(appHooks);
+
+module.exports = app;
diff --git a/src/authentication.js b/src/authentication.js
new file mode 100644
index 0000000..3312a46
--- /dev/null
+++ b/src/authentication.js
@@ -0,0 +1,27 @@
+const authentication = require('@feathersjs/authentication');
+const jwt = require('@feathersjs/authentication-jwt');
+const local = require('@feathersjs/authentication-local');
+
+
+module.exports = function (app) {
+ const config = app.get('authentication');
+
+ // Set up authentication with the secret
+ app.configure(authentication(config));
+ app.configure(jwt());
+ app.configure(local());
+
+ // The `authentication` service is used to create a JWT.
+ // The before `create` hook registers strategies that can be used
+ // to create a new valid JWT (e.g. local or oauth2)
+ app.service('authentication').hooks({
+ before: {
+ create: [
+ authentication.hooks.authenticate(config.strategies)
+ ],
+ remove: [
+ authentication.hooks.authenticate('jwt')
+ ]
+ }
+ });
+};
diff --git a/src/channels.js b/src/channels.js
new file mode 100644
index 0000000..fb88a0f
--- /dev/null
+++ b/src/channels.js
@@ -0,0 +1,61 @@
+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);
+
+ // 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);
+ }
+ });
+
+ // eslint-disable-next-line no-unused-vars
+ app.publish((data, hook) => {
+ // Here you can add event publishers to channels set up in `channels.js`
+ // To publish only for a specific event use `app.publish(eventname, () => {})`
+
+ console.log('Publishing all events to all authenticated users. See `channels.js` and https://docs.feathersjs.com/api/channels.html for more information.'); // eslint-disable-line
+
+ // e.g. to publish all service events to all authenticated users use
+ return app.channel('authenticated');
+ });
+
+ // 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}`)
+ // ];
+ // });
+};
diff --git a/src/hooks/log.js b/src/hooks/log.js
new file mode 100644
index 0000000..37e9403
--- /dev/null
+++ b/src/hooks/log.js
@@ -0,0 +1,24 @@
+// A hook that logs service method before, after and error
+// See https://github.com/winstonjs/winston for documentation
+// about the logger.
+const logger = require('../logger');
+const util = require('util');
+
+// To see more detailed messages, uncomment the following line:
+// logger.level = 'debug';
+
+module.exports = function () {
+ return context => {
+ // This debugs the service call and a stringified version of the hook context
+ // You can customize the message (and logger) to your needs
+ logger.debug(`${context.type} app.service('${context.path}').${context.method}()`);
+
+ if(typeof context.toJSON === 'function' && logger.level === 'debug') {
+ logger.debug('Hook Context', util.inspect(context, {colors: false}));
+ }
+
+ if(context.error && !context.result) {
+ logger.error(context.error.stack);
+ }
+ };
+};
diff --git a/src/hooks/populate-user.js b/src/hooks/populate-user.js
new file mode 100644
index 0000000..dfa58cf
--- /dev/null
+++ b/src/hooks/populate-user.js
@@ -0,0 +1,9 @@
+// Use this hook to manipulate incoming or outgoing data.
+// For more information on hooks see: http://docs.feathersjs.com/api/hooks.html
+
+// eslint-disable-next-line no-unused-vars
+module.exports = function (options = {}) {
+ return async context => {
+ return context;
+ };
+};
diff --git a/src/hooks/process-post.js b/src/hooks/process-post.js
new file mode 100644
index 0000000..d23f451
--- /dev/null
+++ b/src/hooks/process-post.js
@@ -0,0 +1,35 @@
+// Use this hook to manipulate incoming or outgoing data.
+// For more information on hooks see: http://docs.feathersjs.com/api/hooks.html
+
+// eslint-disable-next-line no-unused-vars
+module.exports = function (options = {}) {
+ return async context => {
+ return async context => {
+ const {data} = context;
+
+ // Throw an error if we didn't get a text
+ if (!data.text) {
+ throw new Error('A post must have a text');
+ }
+
+ // The authenticated user
+ const user = context.params.user;
+ // The actual message text
+ const text = context.data.text
+ // Posts can't be longer than 400 characters
+ .substring(0, 400);
+
+ // Override the original data (so that people can't submit additional stuff)
+ context.data = {
+ text,
+ // Set the user id
+ userId: user._id,
+ // Add the current date
+ createdAt: new Date().getTime()
+ };
+
+ // Best practise, hooks should always return the context
+ return context;
+ };
+ };
+};
diff --git a/src/index.js b/src/index.js
new file mode 100644
index 0000000..d68605b
--- /dev/null
+++ b/src/index.js
@@ -0,0 +1,13 @@
+/* eslint-disable no-console */
+const logger = require('./logger');
+const app = require('./app');
+const port = app.get('port');
+const server = app.listen(port);
+
+process.on('unhandledRejection', (reason, p) =>
+ logger.error('Unhandled Rejection at: Promise ', p, reason)
+);
+
+server.on('listening', () =>
+ logger.info('Feathers application started on http://%s:%d', app.get('host'), port)
+);
diff --git a/src/logger.js b/src/logger.js
new file mode 100644
index 0000000..b9aba0d
--- /dev/null
+++ b/src/logger.js
@@ -0,0 +1,16 @@
+const { createLogger, format, transports } = require('winston');
+
+// Configure the Winston logger. For the complete documentation see https://github.com/winstonjs/winston
+const logger = createLogger({
+ // To see more detailed errors, change this to 'debug'
+ level: 'info',
+ format: format.combine(
+ format.splat(),
+ format.simple()
+ ),
+ transports: [
+ new transports.Console()
+ ],
+});
+
+module.exports = logger;
diff --git a/src/middleware/index.js b/src/middleware/index.js
new file mode 100644
index 0000000..49ad533
--- /dev/null
+++ b/src/middleware/index.js
@@ -0,0 +1,5 @@
+// eslint-disable-next-line no-unused-vars
+module.exports = function (app) {
+ // Add your custom middleware here. Remember that
+ // in Express, the order matters.
+};
diff --git a/src/models/posts.model.js b/src/models/posts.model.js
new file mode 100644
index 0000000..e46117c
--- /dev/null
+++ b/src/models/posts.model.js
@@ -0,0 +1,28 @@
+// See http://docs.sequelizejs.com/en/latest/docs/models-definition/
+// for more of what you can do here.
+const Sequelize = require('sequelize');
+const DataTypes = Sequelize.DataTypes;
+
+module.exports = function (app) {
+ const sequelizeClient = app.get('sequelizeClient');
+ const posts = sequelizeClient.define('posts', {
+ text: {
+ type: DataTypes.STRING,
+ allowNull: false
+ }
+ }, {
+ hooks: {
+ beforeCount(options) {
+ options.raw = true;
+ }
+ }
+ });
+
+ // eslint-disable-next-line no-unused-vars
+ posts.associate = function (models) {
+ // Define associations here
+ // See http://docs.sequelizejs.com/en/latest/docs/associations/
+ };
+
+ return posts;
+};
diff --git a/src/models/users.model.js b/src/models/users.model.js
new file mode 100644
index 0000000..407e712
--- /dev/null
+++ b/src/models/users.model.js
@@ -0,0 +1,36 @@
+// See http://docs.sequelizejs.com/en/latest/docs/models-definition/
+// for more of what you can do here.
+const Sequelize = require('sequelize');
+const DataTypes = Sequelize.DataTypes;
+
+module.exports = function (app) {
+ const sequelizeClient = app.get('sequelizeClient');
+ const users = sequelizeClient.define('users', {
+
+ email: {
+ type: DataTypes.STRING(126),
+ allowNull: false,
+ unique: true
+ },
+ password: {
+ type: DataTypes.STRING(126),
+ allowNull: false
+ },
+
+
+ }, {
+ hooks: {
+ beforeCount(options) {
+ options.raw = true;
+ }
+ }
+ });
+
+ // eslint-disable-next-line no-unused-vars
+ users.associate = function (models) {
+ // Define associations here
+ // See http://docs.sequelizejs.com/en/latest/docs/associations/
+ };
+
+ return users;
+};
diff --git a/src/sequelize.js b/src/sequelize.js
new file mode 100644
index 0000000..5afa78a
--- /dev/null
+++ b/src/sequelize.js
@@ -0,0 +1,70 @@
+const Sequelize = require('sequelize');
+const { Op } = Sequelize;
+const operatorsAliases = {
+ $eq: Op.eq,
+ $ne: Op.ne,
+ $gte: Op.gte,
+ $gt: Op.gt,
+ $lte: Op.lte,
+ $lt: Op.lt,
+ $not: Op.not,
+ $in: Op.in,
+ $notIn: Op.notIn,
+ $is: Op.is,
+ $like: Op.like,
+ $notLike: Op.notLike,
+ $iLike: Op.iLike,
+ $notILike: Op.notILike,
+ $regexp: Op.regexp,
+ $notRegexp: Op.notRegexp,
+ $iRegexp: Op.iRegexp,
+ $notIRegexp: Op.notIRegexp,
+ $between: Op.between,
+ $notBetween: Op.notBetween,
+ $overlap: Op.overlap,
+ $contains: Op.contains,
+ $contained: Op.contained,
+ $adjacent: Op.adjacent,
+ $strictLeft: Op.strictLeft,
+ $strictRight: Op.strictRight,
+ $noExtendRight: Op.noExtendRight,
+ $noExtendLeft: Op.noExtendLeft,
+ $and: Op.and,
+ $or: Op.or,
+ $any: Op.any,
+ $all: Op.all,
+ $values: Op.values,
+ $col: Op.col
+};
+
+module.exports = function (app) {
+ const connectionString = app.get('mysql');
+ const sequelize = new Sequelize(connectionString, {
+ dialect: 'mysql',
+ logging: false,
+ operatorsAliases,
+ define: {
+ freezeTableName: true
+ }
+ });
+ const oldSetup = app.setup;
+
+ app.set('sequelizeClient', sequelize);
+
+ app.setup = function (...args) {
+ const result = oldSetup.apply(this, args);
+
+ // Set up data relationships
+ const models = sequelize.models;
+ Object.keys(models).forEach(name => {
+ if ('associate' in models[name]) {
+ models[name].associate(models);
+ }
+ });
+
+ // Sync to the database
+ sequelize.sync();
+
+ return result;
+ };
+};
diff --git a/src/services/index.js b/src/services/index.js
new file mode 100644
index 0000000..ccbb889
--- /dev/null
+++ b/src/services/index.js
@@ -0,0 +1,7 @@
+const posts = require('./posts/posts.service.js');
+const users = require('./users/users.service.js');
+// eslint-disable-next-line no-unused-vars
+module.exports = function (app) {
+ app.configure(posts);
+ app.configure(users);
+};
diff --git a/src/services/posts/posts.hooks.js b/src/services/posts/posts.hooks.js
new file mode 100644
index 0000000..39ac996
--- /dev/null
+++ b/src/services/posts/posts.hooks.js
@@ -0,0 +1,33 @@
+const {authenticate} = require('@feathersjs/authentication').hooks;
+
+module.exports = {
+ before: {
+ all: [authenticate('jwt')],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ },
+
+ after: {
+ all: [],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ },
+
+ error: {
+ all: [],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ }
+};
diff --git a/src/services/posts/posts.service.js b/src/services/posts/posts.service.js
new file mode 100644
index 0000000..cacde6e
--- /dev/null
+++ b/src/services/posts/posts.service.js
@@ -0,0 +1,22 @@
+// Initializes the `posts` service on path `/posts`
+const createService = require('feathers-sequelize');
+const createModel = require('../../models/posts.model');
+const hooks = require('./posts.hooks');
+
+module.exports = function (app) {
+ const Model = createModel(app);
+ const paginate = app.get('paginate');
+
+ const options = {
+ Model,
+ paginate
+ };
+
+ // Initialize our service with any options it requires
+ app.use('/posts', createService(options));
+
+ // Get our initialized service so that we can register hooks
+ const service = app.service('posts');
+
+ service.hooks(hooks);
+};
diff --git a/src/services/users/users.hooks.js b/src/services/users/users.hooks.js
new file mode 100644
index 0000000..613676b
--- /dev/null
+++ b/src/services/users/users.hooks.js
@@ -0,0 +1,41 @@
+const { authenticate } = require('@feathersjs/authentication').hooks;
+
+const {
+ hashPassword, protect
+} = require('@feathersjs/authentication-local').hooks;
+
+module.exports = {
+ before: {
+ all: [],
+ find: [ authenticate('jwt') ],
+ get: [ authenticate('jwt') ],
+ create: [ hashPassword() ],
+ update: [ hashPassword(), authenticate('jwt') ],
+ patch: [ hashPassword(), authenticate('jwt') ],
+ remove: [ authenticate('jwt') ]
+ },
+
+ after: {
+ all: [
+ // Make sure the password field is never sent to the client
+ // Always must be the last hook
+ protect('password')
+ ],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ },
+
+ error: {
+ all: [],
+ find: [],
+ get: [],
+ create: [],
+ update: [],
+ patch: [],
+ remove: []
+ }
+};
diff --git a/src/services/users/users.service.js b/src/services/users/users.service.js
new file mode 100644
index 0000000..3cb0535
--- /dev/null
+++ b/src/services/users/users.service.js
@@ -0,0 +1,22 @@
+// Initializes the `users` service on path `/users`
+const createService = require('feathers-sequelize');
+const createModel = require('../../models/users.model');
+const hooks = require('./users.hooks');
+
+module.exports = function (app) {
+ const Model = createModel(app);
+ const paginate = app.get('paginate');
+
+ const options = {
+ Model,
+ paginate
+ };
+
+ // Initialize our service with any options it requires
+ app.use('/users', createService(options));
+
+ // Get our initialized service so that we can register hooks
+ const service = app.service('users');
+
+ service.hooks(hooks);
+};