remove unnecesary warnings, fix bug with data not stringified, exposable debugger without chrome extension

Author: radenkovic

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+yarn-error.log

README.md

@@ -64,7 +64,9 @@ Service configuration options
 ```js
 app.configure(debuggerService({
   expireAfterSeconds: 900, // Expire item in storage after x seconds, default is 900 (optional)
-  filename: 'nedb.db' // set filename if you want to persist data (optional)
+  filename: 'nedb.db', // set filename if you want to persist data (optional)
+  ui: true // if you want to expose UI on publicUrl (default is false) and debug without chrome extension
+  publicUrl: '/debugger' // set custom url for debugger (default is /debugger), used only if ui: true
 }))
 ```
 

package.json

@@ -26,6 +26,7 @@
     "email": "[email protected]"
   },
   "devDependencies": {
+    "@feathersjs/express": "^4.x.x",
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-import-resolver-node": "^0.3.4",
@@ -35,7 +36,11 @@
     "prettier": "^2.0.5"
   },
   "dependencies": {
+    "feathers-debugger": "^1.x.x",
     "feathers-nedb": "^5.1.0",
     "nedb": "^1.8.0"
+  },
+  "peerDependencies": {
+    "@feathersjs/express": "^4.x.x"
   }
 }

src/index.js

@@ -2,8 +2,12 @@ const NeDB = require('nedb');
 const service = require('feathers-nedb');
 const traceHook = require('./trace');
 const hooks = require('./hooks');
+const path = require('path');
+const express = require('@feathersjs/express'); // eslint-disable-line
 
-const configureService = (options = {}) => (app) => {
+const configureService = (options = { ui: false, publicUrl: '/debugger' }) => (
+  app
+) => {
   // Create a NeDB instance
   const Model = new NeDB({
     filename: options.filename,
@@ -20,6 +24,16 @@ const configureService = (options = {}) => (app) => {
 
   app.use('/feathers-debugger', service({ Model }));
   app.service('feathers-debugger').hooks(hooks({ Model }));
+  // Expose UI on endpoint if ui: true
+  if (options.ui) {
+    const publicUrl = options.publicUrl || '/debugger';
+    const target = path.join(
+      __dirname,
+      '../node_modules/feathers-debugger/dist'
+    );
+    console.log('✨ Feathers Debugger exposed on:', publicUrl);
+    app.use(publicUrl, express.static(target));
+  }
 };
 
 module.exports = configureService;

src/trace.js

@@ -3,16 +3,18 @@ module.exports = (
 ) => async (ctx) => {
   const service = ctx.app.service('feathers-debugger');
 
-  // Error Message if service is not registered
+  // Skip the hook if service is not registered
   if (!service) {
-    return console.warn(
-      'WARN: Service feathers-debuger is not registered, feathers debugger tracing is disabled. Please check Feathers Debugger documentation on how to setup: https://github.com/radenkovic/feathers-debugger.'
-    );
+    return;
   }
   if (ctx.path === 'feathers-debugger') return;
 
   if (!ctx._req_ts) {
     ctx._req_ts = Date.now();
+    if (!ctx.params.provider) {
+      // Add artificial 1ms
+      ctx._req_ts += 1;
+    }
   } else {
     ctx._req_duration = Date.now() - ctx._req_ts;
   }
@@ -25,7 +27,7 @@ module.exports = (
     provider: ctx.params ? ctx.params.provider : undefined,
     ts: ctx._req_ts,
     duration: ctx._req_duration,
-    data: ctx.data,
+    data: JSON.stringify(ctx.data),
     error: ctx.error ? ctx.error.message : undefined,
     end: Date.now(),
   };