Merge pull request #12 from which-ecosystem/logging

Logging and exception handling

Author: eug-vs

hooks/handleErrors.ts

@@ -0,0 +1,11 @@
+import { HookContext } from '@feathersjs/feathers';
+import logger from '../logger';
+
+
+export default async (context: HookContext): Promise<HookContext> => {
+  context.result = context.error.message;
+  context.statusCode = context.error.code;
+  logger.error(context.error);
+  return context;
+};
+

hooks/logging.ts

@@ -0,0 +1,14 @@
+import { HookContext } from '@feathersjs/feathers';
+import logger from '../logger';
+
+export default async (context: HookContext): Promise<HookContext> => {
+  if (context.params.provider) {
+    const { method, path, id } = context;
+    const message = `${method.toUpperCase()}: /${path}/${id || ''}`;
+    const username = context.params.user?.username || 'anonymous';
+
+    logger.log(`${message} ${username}`);
+  }
+  return context;
+};
+

hooks/requireAuth.ts

@@ -1,7 +1,10 @@
+import { NotAuthenticated } from '@feathersjs/errors';
 import { HookContext } from '@feathersjs/feathers';
 
 export default async (context: HookContext): Promise<HookContext> => {
-  if (!context.params.user) throw new Error('This endpoint requires auth!');
+  if (!context.params.authenticated) {
+    throw new NotAuthenticated('This endpoint requires auth!');
+  }
   return context;
 };
 

logger.ts

@@ -0,0 +1,22 @@
+type Stream = 'log' | 'error' | 'debug';
+
+interface ErrorWithCode extends Error {
+  code?: number
+}
+
+const dateOpts = { timeStyle: 'medium', dateStyle: 'short' };
+// eslint-disable-next-line
+// @ts-ignore
+const timestamp = (): string => new Date().toLocaleString('en', dateOpts);
+
+
+const logWithTimestamp = (stream: Stream, message: string): void => {
+  console[stream](`[${timestamp()}] ${message}`);
+};
+
+export default {
+  log: (message: string): void => logWithTimestamp('log', message),
+  debug: (message: string): void => logWithTimestamp('debug', message),
+  error: (err: ErrorWithCode): void => logWithTimestamp('error', `${err.code || ''} ${err.name}: ${err.message}`)
+};
+

package-lock.json

@@ -13,6 +13,7 @@
     "@feathersjs/authentication": "^4.5.3",
     "@feathersjs/authentication-local": "^4.5.4",
     "@feathersjs/configuration": "^4.5.3",
+    "@feathersjs/errors": "^4.5.3",
     "@feathersjs/express": "^4.5.4",
     "@feathersjs/feathers": "^4.5.3",
     "@feathersjs/socketio": "^4.5.4",
@@ -22,7 +23,7 @@
     "feathers-mongoose": "^8.3.0",
     "lodash": "^4.17.15",
     "mongoose": "^5.9.18",
-    "which-types": "^1.4.0"
+    "which-types": "^1.4.1"
   },
   "repository": {
     "type": "git",

package.json

@@ -6,6 +6,8 @@ import Votes from './votes/votes.service';
 import Auth from './auth/auth.service';
 
 import tryAuthenticate from '../hooks/tryAuthenticate';
+import logging from '../hooks/logging';
+import handleErrors from '../hooks/handleErrors';
 
 export default (app: Application): void => {
   app.configure(Auth);
@@ -16,7 +18,10 @@ export default (app: Application): void => {
 
   app.hooks({
     before: {
-      all: tryAuthenticate
+      all: [tryAuthenticate, logging]
+    },
+    error: {
+      all: handleErrors
     }
   });
 };