@superhero/core 1.8.5 → 4.0.0-beta.1

package/index.test.js

@@ -0,0 +1,94 @@
+import assert from 'node:assert'
+import fs     from 'node:fs/promises'
+import Core   from '@superhero/core'
+import { before, after, suite, test } from 'node:test'
+
+suite('@superhero/core', () =>
+{
+  const
+    testDir       = './test',
+    fooDir        = `${testDir}/foo`,
+    fooService    = `${fooDir}/service.js`,
+    fooConfig     = `${fooDir}/config.json`,
+    fooConfigDev  = `${fooDir}/config-dev.json`
+
+  before(async () =>
+  {
+    // Create test directories
+    await fs.mkdir(fooDir, { recursive: true })
+
+    // Create mock service files
+    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(fooConfigDev,  JSON.stringify({ foo: { bar: 'qux' } }))
+
+    // Disable console output for the tests
+    // Object.defineProperties(console, 
+    // {
+    //   info: { value: () => null },
+    //   warn: { value: () => null }
+    // })
+  })
+
+  after(async () => 
+  {
+    await fs.rm(testDir, { recursive: true, force: true })
+  })
+
+  let core
+
+  test('Plain core bootstrap', async () =>
+  {
+    core = new Core()
+
+    await assert.doesNotReject(
+      core.bootstrap(),
+      'Should bootstrap without errors')
+  })
+
+  test('Bootstraps a service successfully', async () =>
+  {
+    core = new Core()
+    await core.add(fooConfig)
+
+    await assert.doesNotReject(
+      core.bootstrap(),
+      'Should bootstrap without errors')
+
+    const foo = core.locate('foo')
+
+    assert.ok(foo, 'Should have located the foo service')
+    assert.strictEqual(foo.bar, 'baz', 'Should have passed the correct configuration to the service')
+  })
+
+  test('Bootstraps a service with a branch variable', async () =>
+  {
+    const branch = 'dev'
+    core = new Core(branch)
+    await core.add(fooConfig)
+
+    await assert.doesNotReject(
+      core.bootstrap(),
+      'Should bootstrap without errors')
+
+    const foo = core.locate('foo')
+
+    assert.ok(foo, 'Should have located the foo service')
+    assert.strictEqual(foo.bar, 'qux', 'Should have passed the correct configuration to the service')
+  })
+
+  test('Can cluster the core and bootstrap a service', async () =>
+  {
+    core = new Core()
+    await core.cluster(4)
+    await core.add(fooConfig)
+
+    await assert.doesNotReject(
+      core.bootstrap(),
+      'Should bootstrap without errors')
+
+    await core.destruct()
+  })
+})

package/package.json

@@ -1,41 +1,27 @@
 {
   "name": "@superhero/core",
-  "version": "1.8.5",
-  "description": "Framework built with the domain driven design pattern in mind",
-  "repository": "git@github.com:superhero/js.core.git",
+  "version": "4.0.0-beta.1",
+  "description": "Core functionalities for the superhero framework.",
   "main": "index.js",
   "license": "MIT",
-  "keywords": [
-    "framework",
-    "http",
-    "server",
-    "eventbus",
-    "ddd"
-  ],
-  "author": {
-    "name": "Erik Landvall",
-    "email": "erik@landvall.se",
-    "url": "http://erik.landvall.se"
-  },
-  "scripts": {
-    "doc-coverage": "nyc mocha './test/test.*.js' && nyc report --reporter=html --report-dir=./docs/coverage",
-    "doc-tests": "mocha './test/test.*.js' --reporter mochawesome --reporter-options reportDir=docs/tests,reportFilename=index,showHooks=always",
-    "test-coverage": "syntax-check && nyc mocha './test/test.*.js'",
-    "test": "mocha './test/test.*.js'"
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
   },
   "dependencies": {
-    "@superhero/request": "1.0.9",
-    "@superhero/debug": "1.1.11",
-    "cookies": "0.7.2"
+    "@superhero/bootstrap": "^4.0.0",
+    "@superhero/config": "^4.0.5",
+    "@superhero/locator": "^4.0.4"
   },
-  "devDependencies": {
-    "@superhero/syntax-check": "0.0.1",
-    "mocha": "5.1.0",
-    "mochawesome": "3.0.2",
-    "chai": "4.1.2",
-    "nyc": "11.7.1"
+  "scripts": {
+    "test": "node --trace-warnings --test --experimental-test-coverage"
+  },
+  "author": {
+    "name": "Erik Landvall",
+    "email": "erik@landvall.se"
   },
-  "engines": {
-    "node": ">=10.0.0"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/superhero/config"
   }
 }

package/worker.js

@@ -0,0 +1,12 @@
+import cluster from 'node:cluster'
+import Core    from '@superhero/core'
+
+// If the worker is a core cluster worker start the core and 
+// listen for control messages from the primary process.
+if(cluster.isWorker
+&& process.env.CORE_CLUSTER_WORKER)
+{
+  const core = new Core()
+  process.on('message', core.onEvent.bind(core))
+  process.send('ready')
+}

package/LICENCE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2018 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/bootstrap/config.js

@@ -1,7 +0,0 @@
-module.exports =
-{
-  locator:
-  {
-    'bootstrap' : __dirname
-  }
-}

package/bootstrap/index.js

@@ -1,19 +0,0 @@
-class Bootstrap
-{
-  constructor(locator)
-  {
-    this.locator = locator
-  }
-
-  async bootstrap()
-  {
-    const configuration = this.locator.locate('configuration')
-    for(const key in configuration.config.bootstrap)
-    {
-      const bootstrap = this.locator.locate(configuration.config.bootstrap[key])
-      await bootstrap.bootstrap()
-    }
-  }
-}
-
-module.exports = Bootstrap

package/bootstrap/locator.js

@@ -1,16 +0,0 @@
-const Bootstrap = require('.')
-
-class BootstrapLocator
-{
-  constructor(locator)
-  {
-    this.locator = locator
-  }
-
-  locate()
-  {
-    return new Bootstrap(this.locator)
-  }
-}
-
-module.exports = BootstrapLocator

package/cli/config.js

@@ -1,7 +0,0 @@
-module.exports =
-{
-  locator:
-  {
-    'cli' : __dirname
-  }
-}

package/cli/index.js

@@ -1,49 +0,0 @@
-class Cli
-{
-  /**
-   * @param {readline} readline
-   * @param {string} prompt
-   */
-  constructor(readline, prompt)
-  {
-    this.readline = readline
-    this.prompt   = prompt
-  }
-
-  /**
-   * @param {string} question
-   * @param {function} completer @see https://nodejs.org/api/readline.html#readline_use_of_the_completer_function
-   */
-  question(question, completer)
-  {
-    return new Promise((accept, reject) =>
-    {
-      const rl = this.readline.createInterface(
-      {
-        prompt    : this.prompt,
-        input     : process.stdin,
-        output    : process.stdout,
-        completer
-      })
-
-      rl.question(question, (input) =>
-      {
-        rl.close()
-        accept(input)
-      })
-    })
-  }
-
-  /**
-   * @param {string|Buffer|Uint8Array|any}  chunk     not null...
-   * @param {string}                        encoding  utf8
-   */
-  write(chunk, encoding = 'utf8')
-  {
-    return new Promise((accept) =>
-         process.stdout.write(chunk, encoding, () => accept())
-      || process.stdout.emit('drain'))
-  }
-}
-
-module.exports = Cli

package/cli/locator.js

@@ -1,17 +0,0 @@
-const
-Cli       = require('.'),
-readline  = require('readline')
-
-class CliLocator
-{
-  locate()
-  {
-    const
-    configuration = this.locator.locate('configuration'),
-    prompt        = configuration.find('cli.prompt')
-
-    return new Cli(readline, prompt)
-  }
-}
-
-module.exports = CliLocator

package/composer/bootstrap/error/schema-not-resolvable.js

@@ -1,10 +0,0 @@
-class SchemaNotResolvableError extends ReferenceError
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_SCHEMA_NOT_RESOLVABLE'
-  }
-}
-
-module.exports = SchemaNotResolvableError

package/composer/bootstrap/index.js

@@ -1,62 +0,0 @@
-const SchemaNotResolvable = require('./error/schema-not-resolvable')
-
-class ComposerBootstrap
-{
-  constructor(locator, configuration, path)
-  {
-    this.locator        = locator
-    this.configuration  = configuration
-    this.path           = path
-  }
-
-  bootstrap()
-  {
-    const
-    composer    = this.locator.locate('composer'),
-    schemas     = this.configuration.find('composer.schema'),
-    filters     = this.configuration.find('composer.filter'),
-    validators  = this.configuration.find('composer.validator')
-
-    this.addSchemasToComposer(composer, schemas)
-    this.addFiltersToComposer(composer, filters)
-    this.addValidatorsToComposer(composer, validators)
-  }
-
-  addSchemasToComposer(composer, schemas)
-  {
-    if(schemas)
-      for(const schemaName in schemas)
-        if(this.path.isResolvable(schemas[schemaName]))
-        {
-          const schema = require(schemas[schemaName])
-          composer.addSchema(schemaName, schema)
-        }
-        else
-        {
-          const msg = `Could not resolve path for schema: "${schemaName}", path: "${schemas[schemaName]}"`
-          throw new SchemaNotResolvable(msg)
-        }
-  }
-
-  addFiltersToComposer(composer, filters)
-  {
-    if(filters)
-      for(const filterName in filters)
-      {
-        const filter = this.locator.locate(filters[filterName])
-        composer.addFilter(filterName, filter)
-      }
-  }
-
-  addValidatorsToComposer(composer, validators)
-  {
-    if(validators)
-      for(const validatorName in validators)
-      {
-        const validator = this.locator.locate(validators[validatorName])
-        composer.addValidator(validatorName, validator)
-      }
-  }
-}
-
-module.exports = ComposerBootstrap

package/composer/bootstrap/locator.js

@@ -1,20 +0,0 @@
-const ComposerBootstrap = require('.')
-
-class ComposerBootstrapLocator
-{
-  constructor(locator)
-  {
-    this.locator = locator
-  }
-
-  locate()
-  {
-    const
-    configuration = this.locator.locate('configuration'),
-    path          = this.locator.locate('path')
-
-    return new ComposerBootstrap(this.locator, configuration, path)
-  }
-}
-
-module.exports = ComposerBootstrapLocator

package/composer/config.js

@@ -1,49 +0,0 @@
-module.exports =
-{
-  bootstrap:
-  {
-    'composer' : 'composer/bootstrap'
-  },
-  composer:
-  {
-    filter:
-    {
-      'boolean'   : 'composer/filter/boolean',
-      'decimal'   : 'composer/filter/decimal',
-      'integer'   : 'composer/filter/integer',
-      'json'      : 'composer/filter/json',
-      'schema'    : 'composer/filter/schema',
-      'string'    : 'composer/filter/string',
-      'timestamp' : 'composer/filter/timestamp'
-    },
-    validator:
-    {
-      'boolean'   : 'composer/validator/boolean',
-      'decimal'   : 'composer/validator/decimal',
-      'integer'   : 'composer/validator/integer',
-      'json'      : 'composer/validator/json',
-      'schema'    : 'composer/validator/schema',
-      'string'    : 'composer/validator/string',
-      'timestamp' : 'composer/validator/timestamp'
-    }
-  },
-  locator:
-  {
-    'composer'                      : __dirname,
-    'composer/bootstrap'            : __dirname + '/bootstrap',
-    'composer/filter/boolean'       : __dirname + '/filter/boolean',
-    'composer/filter/decimal'       : __dirname + '/filter/decimal',
-    'composer/filter/integer'       : __dirname + '/filter/integer',
-    'composer/filter/json'          : __dirname + '/filter/json',
-    'composer/filter/schema'        : __dirname + '/filter/schema',
-    'composer/filter/string'        : __dirname + '/filter/string',
-    'composer/filter/timestamp'     : __dirname + '/filter/timestamp',
-    'composer/validator/boolean'    : __dirname + '/validator/boolean',
-    'composer/validator/decimal'    : __dirname + '/validator/decimal',
-    'composer/validator/integer'    : __dirname + '/validator/integer',
-    'composer/validator/json'       : __dirname + '/validator/json',
-    'composer/validator/schema'     : __dirname + '/validator/schema',
-    'composer/validator/string'     : __dirname + '/validator/string',
-    'composer/validator/timestamp'  : __dirname + '/validator/timestamp'
-  }
-}

package/composer/error/filter-is-not-honering-contract.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class FilterIsNotHoneringContractError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_FILTER_IS_NOT_HONERING_CONTRACT'
-  }
-}
-
-module.exports = FilterIsNotHoneringContractError

package/composer/error/invalid-attribute.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class InvalidAttributeError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_COMPOSER_INVALID_ATTRIBUTE'
-  }
-}
-
-module.exports = InvalidAttributeError

package/composer/error/invalid-collection.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class InvalidCollectionError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_INVALID_COLLECTION'
-  }
-}
-
-module.exports = InvalidCollectionError

package/composer/error/invalid-schema.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class InvalidSchemaError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_COMPOSER_INVALID_SCHEMA'
-  }
-}
-
-module.exports = InvalidSchemaError

package/composer/error/schema-not-found.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class SchemaNotFoundError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_SCHEMA_NOT_FOUND'
-  }
-}
-
-module.exports = SchemaNotFoundError

package/composer/error/validator-is-not-honering-contract.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class ValidatorIsNotHoneringContractError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_VALIDATOR_IS_NOT_HONERING_CONTRACT'
-  }
-}
-
-module.exports = ValidatorIsNotHoneringContractError

package/composer/error/validator-not-found.js

@@ -1,13 +0,0 @@
-/**
- * @extends {Error}
- */
-class ValidatorNotFoundError extends Error
-{
-  constructor(...a)
-  {
-    super(...a)
-    this.code = 'E_VALIDATOR_NOT_FOUND'
-  }
-}
-
-module.exports = ValidatorNotFoundError

package/composer/filter/boolean/index.js

@@ -1,44 +0,0 @@
-/**
- * @implements {ComposerFilter}
- */
-class ComposerFilterBoolean
-{
-  filter(options, data)
-  {
-    return options.collection
-    ? this.filterCollection(data)
-    : this.filterSingle(data)
-  }
-
-  filterCollection(data)
-  {
-    if(!Array.isArray(data))
-      return data
-
-    const collection = []
-
-    for(const item of data)
-    {
-      const filtered = this.filterSingle(item)
-      collection.push(filtered)
-    }
-
-    return collection
-  }
-
-  filterSingle(data)
-  {
-    if(typeof data === 'string')
-    {
-      if(data.toLowerCase() === 'true')
-        return true
-
-      if(data.toLowerCase() === 'false')
-        return false
-    }
-
-    return data
-  }
-}
-
-module.exports = ComposerFilterBoolean

package/composer/filter/boolean/locator.js

@@ -1,11 +0,0 @@
-const ComposerFilterBoolean = require('.')
-
-class ComposerFilterBooleanLocator
-{
-  locate()
-  {
-    return new ComposerFilterBoolean
-  }
-}
-
-module.exports = ComposerFilterBooleanLocator

package/composer/filter/decimal/index.js

@@ -1,38 +0,0 @@
-/**
- * @implements {ComposerFilter}
- */
-class ComposerFilterDecimal
-{
-  filter(options, data)
-  {
-    return options.collection
-    ? this.filterCollection(data)
-    : this.filterSingle(data)
-  }
-
-  filterCollection(data)
-  {
-    if(!Array.isArray(data))
-      return data
-
-    const collection = []
-
-    for(const item of data)
-    {
-      const filtered = this.filterSingle(item)
-      collection.push(filtered)
-    }
-
-    return collection
-  }
-
-  filterSingle(data)
-  {
-    if(isNaN(data) === false)
-      return +data
-
-    return data
-  }
-}
-
-module.exports = ComposerFilterDecimal

package/composer/filter/decimal/locator.js

@@ -1,11 +0,0 @@
-const ComposerFilterDecimal = require('.')
-
-class ComposerFilterDecimalLocator
-{
-  locate()
-  {
-    return new ComposerFilterDecimal
-  }
-}
-
-module.exports = ComposerFilterDecimalLocator

package/composer/filter/index.js

@@ -1,10 +0,0 @@
-/**
- * @interface ComposerValidator
- */
-
-/**
- * @function ComposerFilter#filter
- * @param {Object} options
- * @param {*} data
- * @returns {void}
- */