@superhero/core 4.0.0-beta.5 → 4.0.0-beta.7

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Erik Landvall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.js

@@ -1,9 +1,11 @@
 import os           from 'node:os'
 import cluster      from 'node:cluster'
 import EventEmitter from 'node:events'
+import path         from 'node:path'
 import bootstrap    from '@superhero/bootstrap'
 import Config       from '@superhero/config'
 import Locate       from '@superhero/locator'
+import Log          from '@superhero/log'
 
 export default class Core
 {
@@ -21,27 +23,6 @@ export default class Core
     Core.#setupDestructor(this)
   }
 
-  static log(template, ...args)
-  {
-    const
-      dim   = '\x1b[1m\x1b[90m\x1b[2m',
-      color = '\x1b[90m',
-      mark  = '\x1b[2m\x1b[96m',
-      reset = '\x1b[0m',
-      label = process.env.CORE_CLUSTER_WORKER
-            ? `[CORE:${process.env.CORE_CLUSTER_WORKER}]`
-            : '[CORE]',
-      icon  = ' ⇢ ',
-      write = console._stdout.write.bind(console._stdout),
-      build = template.reduce((result, part, i) => 
-      {
-        const arg = args[i - 1] ?? ''
-        return result + mark + arg + reset + color + part
-      })
-
-    return write(reset + dim + label + icon + reset + color + build + reset + '\n')
-  }
-
   #branch
   #workers  = {}
   #basePath = false
@@ -51,7 +32,7 @@ export default class Core
   {
     get: (target, prop, receiver) =>
     {
-      // when pushing events to the eventlog, also send the events to all workers
+      // when pushing events to the eventlog, also sync the event to all workers
       if('push' === prop) return (...events) => 
       {
         setImmediate(() => 
@@ -68,6 +49,9 @@ export default class Core
     }
   })
 
+  // An exposed log instance taht the core instance uses that is open for modification.
+  static log = new Log({ label: process.env.CORE_CLUSTER_WORKER ? `[CORE:${process.env.CORE_CLUSTER_WORKER}]` : '[CORE]' })
+
   // Used for graceful termination, if multiple cores are instanciated.
   static #cores = new Map
 
@@ -100,14 +84,14 @@ export default class Core
   {
     if(Core.#destructorIsTriggered)
     {
-      Core.log`Redundant shutdown signal, waiting for the shutdown process to finalize…`
-      reason && console.error(reason)
+      Core.log.info`redundant shutdown signal ${signal} waiting for previous shutdown process to finalize…`
+      reason && Core.log.fail`${reason}`
       return
     }
 
     Core.#destructorIsTriggered = true
 
-    signal && Core.log`${signal} ⇢ Graceful shutdown initiated…`
+    signal && Core.log.info`${signal} ⇢ graceful shutdown initiated…`
 
     const
       destructCores   = [],
@@ -135,12 +119,12 @@ export default class Core
       const error = new Error('Failed to shutdown gracefully')
       error.code  = 'E_CORE_DESTRUCT_GRACEFUL'
       error.cause = destructRejects
-      console.error(error)
+      Core.log.fail`${error}`
       setImmediate(() => process.exit(1))
     }
     else if(reason)
     {
-      console.error(reason)
+      Core.log.fail`${reason}`
       setImmediate(() => process.exit(1))
     }
     else
@@ -292,15 +276,16 @@ export default class Core
     }
     else if(false === this.#isBooted)
     {
-      await this.#addDependencies()
+      await this.#confirmAndAddDependencies()
+      await this.#confirmAbsoluteServcieMapPaths()
 
       freeze && this.config.freeze()
-  
+
       const locatorMap = this.config.find('locator')
       locatorMap && await this.locate.eagerload(locatorMap)
   
       const bootstrapMap = this.config.find('bootstrap')
-      bootstrapMap && await bootstrap.bootstrap(bootstrapMap, this.config, this.locate)
+      bootstrapMap && await bootstrap(bootstrapMap, this.config, this.locate)
 
       this.#isBooted = true
     }
@@ -348,7 +333,7 @@ export default class Core
       this.#workers[forkId].once('exit', this.#reloadWorker.bind(this, forkId, forkBranch, forkVersion))
       this.#workers[forkId].sync = this.#createSynchoronizer(forkId)
 
-      Core.log`Cluster ${'CORE:' + forkId}`
+      Core.log.info`clustered ${'CORE:' + forkId}`
 
       try
       {
@@ -366,6 +351,44 @@ export default class Core
     return branch + forks
   }
 
+  /**
+   * Eagerload services by the configured locator service map.
+   * 
+   * Resolves the absolute path if any of the services to eagerload is refferencing 
+   * a relative path.
+   * 
+   * Resolves the absolute path by the config entry, through the config instance.
+   */
+  async #confirmAbsoluteServcieMapPaths()
+  {
+    const locatorMap = this.config.find('locator')
+
+    if(locatorMap)
+    {
+      const serviceMap = this.locate.normaliseServiceMap(locatorMap)
+
+      for(const entry in serviceMap)
+      {
+        const servicePath = serviceMap[entry]
+
+        if('string' === typeof servicePath)
+        {
+          if(servicePath.startsWith('.'))
+          {
+            const 
+              configPath    = 'locator/' + entry,
+              absolutePath  = this.config.findAbsoluteDirPathByConfigEntry(configPath, servicePath)
+            
+            if('string' === typeof absolutePath)
+            {
+              serviceMap[entry] = path.normalize(path.join(absolutePath, servicePath))
+            }
+          }
+        }
+      }
+    }
+  }
+
   #createSynchoronizer(id)
   {
     const 
@@ -497,7 +520,8 @@ export default class Core
   {
     const 
       failedToSynchronize = this.#workers[id].synchronizing,
-      signal_code = signal ? `${signal}:${code}` : code
+      signal_code         = signal ? `${signal}:${code}` : code,
+      label               = `CORE:${id}`
 
     this.#workers[id].removeAllListeners()
     this.#workers[id].kill()
@@ -505,24 +529,24 @@ export default class Core
 
     if(0 === code)
     {
-      Core.log`Worker ${id} finalized!`
+      Core.log.info`${label} ⇣ terminated`
     }
     else if('SIGTERM'  === signal
          || 'SIGINT'   === signal
          || 'SIGQUIT'  === signal)
     {
-      Core.log`Worker ${id} terminated [${signal_code}]`
+      Core.log.info`${label} ⇣ terminated ⇠ ${signal_code}`
     }
     else if(version >= this.config.find('core/cluster/restart/limit', 99))
     {
-      const error = new Error(`Worker ${id} has reached the restart limit`)
+      const error = new Error(`${label} has reached the restart limit`)
       error.code  = 'E_CORE_CLUSTER_RESTART_LIMIT'
-      error.cause = `Worker ${id} terminated after unexpected interruption [${signal_code}]`
+      error.cause = `${label} process crashed ${signal_code}`
       throw error
     }
     else if(failedToSynchronize)
     {
-      const error = new Error(`Worker ${id} failed to synchronize`)
+      const error = new Error(`${label} failed to synchronize`)
       error.code  = 'E_CORE_CLUSTER_SYNC_FAILED'
       throw error
     }
@@ -530,7 +554,7 @@ export default class Core
     {
       try
       {
-        Core.log`Restart worker ${id} after unexpected interruption [${signal_code}]`
+        Core.log.info`restarting ${label} ⇡ previous process crashed ⇠ ${signal_code}`
         await this.cluster(1, branch, version + 1)
       }
       catch(reason)
@@ -546,22 +570,18 @@ export default class Core
   async #addConfigPath(configPath)
   {
     await this.config.add(configPath)
-    Core.log`Assigned config ${configPath}`
+    Core.log.info`assigned config ${configPath}`
 
     if(this.branch)
     {
       try
       {
         await this.config.add(configPath, this.branch)
-        Core.log`Assigned config ${configPath + '-' + this.branch}`
+        Core.log.info`assigned config ${configPath + '-' + this.branch}`
       }
       catch(error)
       {
-        if(error.code === 'E_CONFIG_ADD')
-        {
-          Core.log`Failed to assign config ${configPath}-${this.branch} ⇢ ${error.message}`
-        }
-        else
+        if(error.code !== 'E_CONFIG_ADD')
         {
           throw error
         }
@@ -569,7 +589,7 @@ export default class Core
     }
   }
 
-  async #addDependencies()
+  async #confirmAndAddDependencies()
   {
     const loaded = []
 
@@ -589,21 +609,40 @@ export default class Core
 
   #findNotLodadedDependencies(loaded)
   {
-    const dependencies = this.config.find('dependency')
-
-    if(undefined === dependencies)
-    {
-      return []
-    }
+    const dependencies = this.config.find('core/dependencies', 
+                         this.config.find('core/dependency', []))
 
     if(false === Array.isArray(dependencies))
     {
-      const error = new TypeError(`Invalid dependency type: ${Object.prototype.toString.call(dependencies)}`)
+      const error = new TypeError(`Invalid dependencies type: ${Object.prototype.toString.call(dependencies)}`)
       error.code  = 'E_CORE_CONFIG_DEPENDENCY_INVALID_TYPE'
-      error.cause = 'Config dependency must be an array'
+      error.cause = 'Config core/dependencies must be an array'
       throw error
     }
 
+    for(let i = 0; i < dependencies.length; i++)
+    {
+      const dependency = dependencies[i]
+
+      if('string' === typeof dependency)
+      {
+        const error = new TypeError(`Invalid dependency type: ${Object.prototype.toString.call(dependency)}`)
+        error.code  = 'E_CORE_CONFIG_DEPENDENCY_INVALID_TYPE'
+        error.cause = 'The dependency values in config core/dependencies must be of type string'
+        throw error
+      }
+
+      if(dependency.startsWith('.'))
+      {
+        const absolutePath = this.config.findAbsoluteDirPathByConfigEntry('core/dependencies', [ dependency ])
+
+        if('string' === typeof absolutePath)
+        {
+          dependencies[i] = path.normalize(path.join(absolutePath, dependency))
+        }
+      }
+    }
+
     return dependencies.filter((dependency) => false === loaded.includes(dependency))
   }
 

package/index.test.js

@@ -1,8 +1,11 @@
 import assert from 'node:assert'
 import fs     from 'node:fs/promises'
 import Core   from '@superhero/core'
+import util   from 'node:util'
 import { before, after, suite, test } from 'node:test'
 
+util.inspect.defaultOptions.depth = 5
+
 suite('@superhero/core', () =>
 {
   const
@@ -21,7 +24,7 @@ suite('@superhero/core', () =>
     await fs.writeFile(fooService, 'export default class Foo { static locate() { return new Foo() } bootstrap(config) { this.bar = config.bar } }')
 
     // Create mock config files
-    await fs.writeFile(fooConfig,     JSON.stringify({ foo: { bar: 'baz' }, bootstrap: { foo: true }, locator: { 'foo': fooService } }))
+    await fs.writeFile(fooConfig,     JSON.stringify({ foo: { bar: 'baz' }, bootstrap: { foo: true }, locator: { foo: './service.js' } }))
     await fs.writeFile(fooConfigDev,  JSON.stringify({ foo: { bar: 'qux' } }))
 
     // Disable console output for the tests

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superhero/core",
-  "version": "4.0.0-beta.5",
+  "version": "4.0.0-beta.7",
   "description": "Core functionalities for the superhero framework.",
   "main": "index.js",
   "license": "MIT",
@@ -9,9 +9,10 @@
     ".": "./index.js"
   },
   "dependencies": {
-    "@superhero/bootstrap": "^4.0.1",
-    "@superhero/config": "^4.0.6",
-    "@superhero/locator": "^4.1.1"
+    "@superhero/bootstrap": "^4.1.0",
+    "@superhero/config": "^4.1.2",
+    "@superhero/locator": "^4.1.2",
+    "@superhero/log": "^4.0.0"
   },
   "scripts": {
     "test": "node --trace-warnings --test --experimental-test-coverage"