feat(atlas): log validation errors via atlas.log 🔎

This should dramatically improve developer ergonomics by making it easier to track down component validation errors. Previously it was very difficult to understand why exactly and where from a validation error was thrown. Now all the relevant information will be printed to the console (or other configured Pino output). 💪

Fixes #66

Author: robertrossmann

packages/atlas/src/private/component-container.mjs

@@ -82,12 +82,20 @@ class ComponentContainer {
     const config = defaults(info.config, this.Component.defaults)
 
     if (!info.validator.validate(info.Component.config, config)) {
-      throw new ValidationError(info.validator.errors, {
+      const err = new ValidationError(info.validator.errors, {
         type: this.type,
         alias: this.alias,
         schema: info.Component.config,
         config,
       })
+
+      // For better developer ergonomics, also log the error for easy discoverability
+      atlas.log.error({
+        err,
+        errors: err.errors,
+        context: err.context,
+      }, 'component validation error')
+      throw err
     }
 
     atlas.log.trace({

packages/atlas/test/action.test.mjs

@@ -109,9 +109,10 @@ describe('Atlas::action()', () => {
     }).to.throw(FrameworkError, /Unneeded aliases for component dummy/u)
   })
 
-  it('throws when user config fails component config schema', () => {
+  it('throws when user config fails component config schema', function() {
     options.config.actions.dummy = { lol: true }
     atlas = new Atlas(options)
+    this.sandbox.stub(atlas.log, 'error')
 
     const action = sinon.spy()
     action.config = {

packages/atlas/test/hook.test.mjs

@@ -145,9 +145,10 @@ describe('Atlas::hook()', () => {
     }).to.throw(FrameworkError, /Missing aliases for component dummy/u)
   })
 
-  it('throws when user config fails component config schema', () => {
+  it('throws when user config fails component config schema', function() {
     options.config.hooks.dummy = { lol: true }
     atlas = new Atlas(options)
+    this.sandbox.stub(atlas.log, 'error')
 
     const hook = sinon.spy()
     hook.config = {

packages/atlas/test/service.test.mjs

@@ -108,9 +108,10 @@ describe('Atlas::service()', () => {
     }).to.throw(FrameworkError, /Unneeded aliases for component dummy/u)
   })
 
-  it('throws when user config fails component config schema', () => {
+  it('throws when user config fails component config schema', function() {
     options.config.services.dummy = { lol: true }
     atlas = new Atlas(options)
+    this.sandbox.stub(atlas.log, 'error')
 
     const service = sinon.spy()
     service.config = {

packages/braintree/test/service/api.test.mjs

@@ -15,8 +15,9 @@ describe('Service: Braintree', () => {
     expect(Braintree.config).to.be.an('object')
   })
 
-  it('throws on invalid config', () => {
+  it('throws on invalid config', function() {
     const atlas = new Atlas({ root: __dirname })
+    this.sandbox.stub(atlas.log, 'error')
 
     expect(() =>
       atlas.service('braintree', Braintree)).to.throw(errors.ValidationError)

packages/nodemailer/test/service/api.test.mjs

@@ -15,8 +15,9 @@ describe('Service: Nodemailer', () => {
     expect(Nodemailer.config).to.be.an('object')
   })
 
-  it('throws on invalid config', () => {
+  it('throws on invalid config', function() {
     const atlas = new Atlas({ root: __dirname })
+    this.sandbox.stub(atlas.log, 'error')
 
     expect(() =>
       atlas.service('nodemailer', Nodemailer)).to.throw(errors.ValidationError)

packages/objection/test/service/api.test.mjs

@@ -15,8 +15,9 @@ describe('Service: Objection', () => {
     expect(Objection.config).to.be.an('object')
   })
 
-  it('throws on invalid config', () => {
+  it('throws on invalid config', function() {
     const atlas = new Atlas({ root: __dirname })
+    this.sandbox.stub(atlas.log, 'error')
 
     expect(() =>
       atlas.service('objection', Objection)).to.throw(errors.ValidationError)