Merge pull request #10 from fabrix-app/v1.1

V1.1

Author: scott-wyatt

lib/Core.ts

@@ -11,6 +11,7 @@ import {
   NamespaceConflictError,
   PackageNotDefinedError,
   TimeoutError,
+  SanityError,
   SpoolError,
   ValidationError
 } from './errors'
@@ -39,6 +40,7 @@ export const Errors = {
   NamespaceConflictError,
   PackageNotDefinedError,
   TimeoutError,
+  SanityError,
   SpoolError,
   ValidationError
 }

lib/common/Model.ts

@@ -11,6 +11,7 @@ import { FabrixGeneric } from './Generic'
 export class FabrixModel extends FabrixGeneric {
   private _app: FabrixApp
   private _datastore: any
+  private _instance: any
   private _config: {[key: string]: any}
   private _schema: any
   private _resolver: any
@@ -76,16 +77,26 @@ export class FabrixModel extends FabrixGeneric {
   }
 
   get datastore() {
-    // if (!this._datastore) {
-    //   this.app.log.warn(`${this.name} did not receive an instance of the datastore`)
-    // }
+    if (!this._datastore) {
+      // This will throw an error if the logger is not set yet
+      // this.app.log.warn(`${this.name} did not receive an instance of the datastore`)
+    }
     return this._datastore
   }
 
   set datastore(datastore) {
     this._datastore = datastore
   }
 
+  get instance() {
+    if (!this._resolver) {
+      return
+      // This will throw an error if the logger is not set yet
+      // this.app.log.warn(`${this.name} did not receive an instance from the datastore`)
+    }
+    return this._resolver.instance
+  }
+
   /**
    * Return the config of this model
    */

lib/common/Resolver.ts

@@ -17,6 +17,10 @@ export class FabrixResolver {
     this.app.emit(`resolver:${this.model.name}:constructed`, this)
   }
 
+  get instance(): any {
+    return
+  }
+
   /**
    * Return the parent model
    */

lib/errors/SanityError.ts

@@ -0,0 +1,30 @@
+/**
+ * Generic Sanity error; commonly used to wrap joi errors, but can be
+ * used for any Sanity-related exception.
+ */
+export class SanityError extends Error {
+  constructor (msg: string, details?: any[]) {
+    super(msg + '\n' + SanityError.humanizeMessage(details))
+  }
+
+  get name () {
+    return 'SanityError'
+  }
+
+  /**
+   * Humanize a list of error details
+   *
+   * @param details a "joi-style details" list
+   * @param details.message
+   * @param details.path
+   * @param details.type
+   * @param details.context
+   * @return String
+   */
+  static humanizeMessage (details?: any[]) {
+    const preamble = 'The following configuration values are invalid: '
+    const paths = (details || [ ]).map(d => d.path.join('.'))
+
+    return preamble + paths.join(', ')
+  }
+}

lib/errors/index.ts

@@ -5,6 +5,7 @@ export { GraphCompletenessError } from './GraphCompletenessError'
 export { IllegalAccessError } from './IllegalAccessError'
 export { NamespaceConflictError } from './NamespaceConflictError'
 export { PackageNotDefinedError } from './PackageNotDefinedError'
-export { TimeoutError } from './TimeoutError'
+export { SanityError } from './SanityError'
 export { SpoolError } from './SpoolError'
+export { TimeoutError } from './TimeoutError'
 export { ValidationError } from './ValidationError'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabrix/fabrix",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Strongly Typed Modern Web Application Framework for Node.js",
   "keywords": [
     "framework",

package.json

@@ -15,6 +15,7 @@ describe('lib.Errors', () => {
     assert(global.NamespaceConflictError)
     assert(global.ValidationError)
     assert(global.SpoolError)
+    assert(global.SanityError)
   })
 
   describe('ConfigNotDefinedError', () => {
@@ -92,6 +93,32 @@ describe('lib.Errors', () => {
 
     })
   })
+  describe('SanityError', () => {
+    it('#name', () => {
+      const err = new SanityError()
+      // err.constructor.humanizeMessage([])
+      assert.equal(err.name, 'SanityError')
+    })
+    describe('#message', () => {
+      it('should specify missing/undefined spools', () => {
+        const testConfig = {
+          main: {
+            spools: [
+              undefined
+            ]
+          }
+        }
+
+        try {
+          new lib.Configuration(testConfig)
+        }
+        catch (e) {
+          assert(/The following configuration values are invalid/.test(e.message))
+          assert(/main.spools\.0/.test(e.message))
+        }
+      })
+    })
+  })
   describe('SpoolError', () => {
     it('#name', () => {
       const err = new SpoolError()