[chore/feat] Add testing to extensions, add Sanity Lifecycle

Author: scott-wyatt

lib/Core.ts

@@ -305,6 +305,10 @@ export const Core = {
       app.log.silly(Templates.silly.initialized)
       app.log.info(Templates.info.initialized)
     })
+    app.once('spool:all:sane', () => {
+      app.log.silly(Templates.silly.sane)
+      app.log.info(Templates.info.sane)
+    })
     app.once('fabrix:ready', () => {
       app.log.info(Templates.info.ready(app))
       app.log.debug(Templates.debug.ready(app))
@@ -331,6 +335,7 @@ export const Core = {
     const validatedEvents = spools.map(spool => `spool:${spool.name}:validated`)
     const configuredEvents = spools.map(spool => `spool:${spool.name}:configured`)
     const initializedEvents = spools.map(spool => `spool:${spool.name}:initialized`)
+    const sanityEvents = spools.map(spool => `spool:${spool.name}:sane`)
 
     app.after(configuredEvents).then(async () => {
       await this.createDefaultPaths(app)
@@ -343,6 +348,11 @@ export const Core = {
     app.after(initializedEvents)
       .then(() => {
         app.emit('spool:all:initialized')
+      })
+
+    app.after(sanityEvents)
+      .then(() => {
+        app.emit('spool:all:sane')
         app.emit('fabrix:ready')
       })
   },
@@ -357,6 +367,14 @@ export const Core = {
   ) {
     const lifecycle = spool.lifecycle
 
+    app.after((lifecycle.sanity.listen).concat('spool:all:initialized'))
+      .then(() => app.log.debug('spool: sanity check', spool.name))
+      .then(() => spool.stage = 'sanity')
+      .then(() => spool.sanity())
+      .then(() => app.emit(`spool:${spool.name}:sane`))
+      .then(() => spool.stage = 'sane')
+      .catch(this.handlePromiseRejection)
+
     app.after((lifecycle.initialize.listen).concat('spool:all:configured'))
       .then(() => app.log.debug('spool: initializing', spool.name))
       .then(() => spool.stage = 'initializing')

lib/Templates.ts

@@ -10,6 +10,7 @@ export const Templates = {
     start: 'Spooling up...',
     stop: 'Spooling down...',
     initialized: 'All spools are loaded.',
+    sane: `Sanity check complete`,
     ready (app: FabrixApp) {
       const baseUrl = app.config.get('web.baseUrl') ||
           `http://${app.config.get('web.host') || 'localhost'}:${app.config.get('web.port') || '80'}`
@@ -54,6 +55,8 @@ export const Templates = {
       )
     },
 
+    sane: `Sanity checks keep us happy`,
+
     initialized: `
                                                  
  ,---.        ,--.          ,--.                 

lib/common/Spool.ts

@@ -56,6 +56,10 @@ export class Spool {
       initialize: {
         listen: [ ],
         emit: [ ]
+      },
+      sanity: {
+        listen: [ ],
+        emit: [ ]
       }
     }
   }
@@ -183,6 +187,15 @@ export class Spool {
 
   }
 
+  /**
+   * Check any configured or initialized state to prove that the Fabrix app in
+   * fact does have the values specified by the lifecylce. Spools that require
+   * runtime specifications should override this method
+   */
+  sanity (): any {
+
+  }
+
   /**
    * Unload this Spool. This method will instruct the spool to perform
    * any necessary cleanup with the expectation that the app will stop or reload

lib/common/interfaces/ILifecycle.ts

@@ -6,5 +6,9 @@ export interface ILifecycle {
   initialize: {
     listen: string[],
     emit: string[]
+  },
+  sanity: {
+    listen: string[],
+    emit: string[]
   }
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabrix/fabrix",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Strongly Typed Modern Web Application Framework for Node.js",
   "keywords": [
     "framework",
@@ -16,6 +16,8 @@
     "sails.js",
     "trails.js",
     "fabrix",
+    "fabrix.js",
+    "fabrix.ts",
     "typescript",
     "server",
     "graphql"

package.json

@@ -73,4 +73,39 @@ describe('lib.Core', () => {
       assert.throws(() => lib.Core.handlePromiseRejection(new Error('Promise Rejection Test')), Error)
     })
   })
+  describe('#mergeExtensions', () => {
+    const B = class B {
+      constructor() {
+        this.foo = 'bar'
+        this.extensions = {
+          foo: {
+            get: () => {
+              return this.foo
+            },
+            set: (newValue) => {
+              this.foo = newValue
+            },
+            enumerable: true,
+            configurable: true
+          }
+        }
+        return this
+      }
+    }
+
+    const A = class A {
+      constructor(b) {
+        lib.Core.mergeExtensions(this, b)
+      }
+    }
+
+    it('should merge extensions from a spool and place them in the app', () => {
+      const b = new B()
+      const a = new A(b)
+
+      assert.equal(a.foo, 'bar')
+      a.foo = 'baz'
+      assert.equal(a.foo, 'baz')
+    })
+  })
 })