@toa.io/norm 1.0.0-alpha.29 → 1.0.0-alpha.291

package/src/.context/validate.js

@@ -1,19 +1,13 @@
-'use strict'
+import { resolve } from 'node:path'
 
-const { resolve } = require('node:path')
+import { readFileSync } from 'node:fs'
+import { yaml } from '@toa.io/generic'
+import * as schemas from '@toa.io/schemas'
 
-const { load } = require('@toa.io/yaml')
-const { Schema } = require('@toa.io/schema')
+const path = resolve(import.meta.dirname, 'schema.yaml')
+const object = yaml.load(readFileSync(path, 'utf8'))
+const schema = schemas.schema(object)
 
-const path = resolve(__dirname, 'schema.yaml')
-const object = load.sync(path)
-const schema = new Schema(object)
-
-/**
- * @param {toa.norm.context.Declaration} context
- */
-const validate = (context) => {
+export const validate = (context) => {
   schema.validate(context)
 }
-
-exports.validate = validate

package/src/component.js

@@ -1,49 +1,57 @@
-'use strict'
+import { join } from 'node:path'
 
-const { join } = require('node:path')
+import { readFile } from 'node:fs/promises'
+import { yaml as jsyaml } from '@toa.io/generic'
+import { find } from '@toa.io/generic'
+import { Locator } from '@toa.io/core'
 
-const { load: yaml } = require('@toa.io/yaml')
-const { directory: { find } } = require('@toa.io/filesystem')
-const { Locator } = require('@toa.io/core')
-
-const {
+import {
   expand,
   merge,
+  migrations,
   validate,
   collapse,
   dereference,
   defaults,
   normalize,
   extensions
-} = require('./.component')
+} from './.component/index.js'
 
-const component = async (path) => {
+export const component = async (path) => {
   const manifest = await load(path)
 
-  normalize(manifest)
-  validate(manifest)
-  extensions(manifest)
+  await normalize(manifest, path)
+  await validate(manifest)
+  await extensions(manifest)
 
   manifest.locator = new Locator(manifest.name, manifest.namespace)
 
   return manifest
 }
 
-const load = async (path, base) => {
+const load = async (path, base, proto = false) => {
   if (base !== undefined) path = find(path, base, MANIFEST)
 
   const file = join(path, MANIFEST)
-  const manifest = /** @type {toa.norm.Component} */ await yaml(file) ?? {}
+  const manifest = (await read(file)) ?? {}
 
   manifest.path = path
 
-  defaults(manifest)
+  const anonymous = manifest.name === undefined
+
+  defaults(manifest, proto)
   await expand(manifest)
 
   await merge(path, manifest)
+  await migrations(path, manifest)
+
+  // an inherited migration is recorded under the prototype's name, and a generated one is not
+  // the same on the next machine
+  if (proto && anonymous && manifest.entity?.migrations !== undefined)
+    throw new Error(`Prototype at '${path}' declares migrations, so it has to be named`)
 
   if (manifest.prototype !== null) {
-    const prototype = await load(manifest.prototype, path)
+    const prototype = await load(manifest.prototype, path, true)
 
     collapse(manifest, prototype)
   }
@@ -56,4 +64,15 @@ const load = async (path, base) => {
 
 const MANIFEST = 'manifest.toa.yaml'
 
-exports.component = component
+/**
+ * Reads a YAML file, resolving anchors into distinct objects so that
+ * mutating one node cannot reach another.
+ *
+ * @param {string} path
+ * @return {Promise<object>}
+ */
+async function read(path) {
+  const object = jsyaml.load(await readFile(path, 'utf8'))
+
+  return jsyaml.load(jsyaml.dump(object, { noRefs: true, lineWidth: -1 }))
+}

package/src/context.js

@@ -1,25 +1,23 @@
-'use strict'
+import { resolve } from 'node:path'
+import { convolve, environment as variables } from '@toa.io/generic'
+import glob from 'fast-glob'
+import { readFile } from 'node:fs/promises'
+import { yaml as jsyaml } from '@toa.io/generic'
 
-const { resolve } = require('node:path')
-const { convolve } = require('@toa.io/generic')
-const { directory: { glob } } = require('@toa.io/filesystem')
-const { load } = require('@toa.io/yaml')
+import { component } from './component.js'
 
-const { component } = require('./component')
-
-const {
+import {
   dependencies,
   normalize,
   complete,
   dereference,
   expand,
   validate
-} = require('./.context')
+} from './.context/index.js'
 
-const context = async (root, environment = process.env.TOA_ENV) => {
+export const context = async (root, environment = variables.get('TOA_ENV')) => {
   const path = resolve(root, CONTEXT)
-  const context = /** @type {toa.norm.Context} */ await load(path)
-  const pattern = resolve(root, context.packages)
+  const context = /** @type {toa.norm.Context} */ await read(path)
 
   context.environment = environment
 
@@ -29,7 +27,7 @@ const context = async (root, environment = process.env.TOA_ENV) => {
 
   validate(context)
 
-  const paths = await glob(pattern)
+  const paths = await glob(resolve(root, COMPONENTS), GLOB)
 
   context.components = await Promise.all(paths.map(component))
   context.dependencies = await dependencies(context)
@@ -41,5 +39,19 @@ const context = async (root, environment = process.env.TOA_ENV) => {
 }
 
 const CONTEXT = 'context.toa.yaml'
+const COMPONENTS = 'components/*'
+
+const GLOB = { onlyDirectories: true, absolute: true }
 
-exports.context = context
+/**
+ * Reads a YAML file, resolving anchors into distinct objects so that
+ * mutating one node cannot reach another.
+ *
+ * @param {string} path
+ * @return {Promise<object>}
+ */
+async function read(path) {
+  const object = jsyaml.load(await readFile(path, 'utf8'))
+
+  return jsyaml.load(jsyaml.dump(object, { noRefs: true, lineWidth: -1 }))
+}

package/src/entity.js

@@ -0,0 +1,15 @@
+/**
+ * What a component declares about its records is a property map and a list of the properties a
+ * whole one has. A validator wants a schema, so it is assembled here rather than declared: one
+ * that a stored record must fit, and one for a changeset, which is whatever subset of the same
+ * properties an assignment writes.
+ */
+export const schema = (entity) =>
+  entity.required === undefined
+    ? changeset(entity)
+    : { type: 'object', properties: entity.properties, required: entity.required }
+
+export const changeset = (entity) => ({
+  type: 'object',
+  properties: entity.properties
+})

package/src/index.js

@@ -1,9 +1,4 @@
-'use strict'
-
-const { context } = require('./context')
-const { component } = require('./component')
-
-exports.shortcuts = require('./shortcuts')
-
-exports.context = context
-exports.component = component
+export { context } from './context.js'
+export { component } from './component.js'
+export * as shortcuts from './shortcuts.js'
+export * as entity from './entity.js'

package/src/shortcuts.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const { empty, merge } = require('@toa.io/generic')
+import { empty, merge } from '@toa.io/generic'
 
 /**
  * Resolves shortcuts
@@ -8,7 +6,7 @@ const { empty, merge } = require('@toa.io/generic')
  * @param {string} token
  * @returns {string}
  */
-const resolve = (token) => {
+export const resolve = (token) => {
   if (token in SHORTCUTS) return SHORTCUTS[token]
   else return token
 }
@@ -20,7 +18,7 @@ const resolve = (token) => {
  * @param {Object} object
  * @param {string} [group]
  */
-const recognize = (shortcuts, object, group) => {
+export const recognize = (shortcuts, object, group) => {
   if (object === undefined) return
 
   const target = group === undefined ? object : {}
@@ -38,21 +36,18 @@ const recognize = (shortcuts, object, group) => {
   if (group !== undefined && !empty(target)) object[group] = merge(object[group], target)
 }
 
-const SHORTCUTS = {
+export const SHORTCUTS = {
   amqp: '@toa.io/bindings.amqp',
   node: '@toa.io/bridges.node',
   bash: '@toa.io/bridges.bash',
   mongodb: '@toa.io/storages.mongodb',
-  sql: '@toa.io/storages.sql',
   queues: '@toa.io/storages.queues',
   exposition: '@toa.io/extensions.exposition',
   realtime: '@toa.io/extensions.realtime',
   configuration: '@toa.io/extensions.configuration',
-  origins: '@toa.io/extensions.origins',
   stash: '@toa.io/extensions.stash',
-  storages: '@toa.io/extensions.storages'
+  storages: '@toa.io/extensions.storages',
+  telemetry: '@toa.io/extensions.telemetry',
+  cadence: '@toa.io/extensions.cadence',
+  introspection: '@toa.io/extensions.introspection'
 }
-
-exports.recognize = recognize
-exports.resolve = resolve
-exports.SHORTCUTS = SHORTCUTS

package/test/component/collapse.fixtures.js

@@ -1,55 +1,47 @@
-'use strict'
-
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
 const entity = {
   manifest: {
     entity: {
-      schema: {
-        properties: {
-          foo: {
-            type: 'string'
-          },
-          bar: {
-            type: 'integer'
-          }
+      properties: {
+        foo: {
+          type: 'string'
         },
-        required: ['foo']
-      }
+        bar: {
+          type: 'integer'
+        }
+      },
+      required: ['foo']
     }
   },
   prototype: {
     entity: {
-      schema: {
-        properties: {
-          foo: {
-            default: 'ok'
-          },
-          baz: {
-            type: 'boolean'
-          }
+      properties: {
+        foo: {
+          minLength: 1
         },
-        required: ['baz']
-      }
+        baz: {
+          type: 'boolean'
+        }
+      },
+      required: ['baz']
     }
   },
   result: {
     entity: {
-      schema: {
-        properties: {
-          foo: {
-            type: 'string',
-            default: 'ok'
-          },
-          bar: {
-            type: 'integer'
-          },
-          baz: {
-            type: 'boolean'
-          }
+      properties: {
+        foo: {
+          type: 'string',
+          minLength: 1
         },
-        required: ['foo', 'baz']
-      }
+        bar: {
+          type: 'integer'
+        },
+        baz: {
+          type: 'boolean'
+        }
+      },
+      required: ['foo', 'baz']
     }
   }
 }
@@ -88,7 +80,6 @@ const operations = {
   result: {
     prototype: {
       prototype: null,
-      path: expect.any(String),
       operations: {
         add: {
           bridge: 'a'
@@ -131,4 +122,4 @@ const remotes = {
   }
 }
 
-exports.samples = { entity, operations, remotes }
+export const samples = { entity, operations, remotes }

package/test/component/collapse.test.js

@@ -1,9 +1,10 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const clone = require('clone-deep')
+import clone from 'clone-deep'
 
-const fixtures = require('./collapse.fixtures')
-const { collapse } = require('../../src/.component')
+import * as fixtures from './collapse.fixtures.js'
+import { collapse } from '../../src/.component/index.js'
 
 let samples
 
@@ -18,7 +19,7 @@ it('should ignore locator', () => {
 
   collapse(manifest, prototype)
 
-  expect(manifest).toStrictEqual(source)
+  assert.deepStrictEqual(manifest, source)
 })
 
 it('should remove prototype property', () => {
@@ -26,7 +27,7 @@ it('should remove prototype property', () => {
 
   collapse(manifest, {})
 
-  expect(manifest).toStrictEqual({})
+  assert.deepStrictEqual(manifest, {})
 })
 
 describe('entity', () => {
@@ -34,7 +35,80 @@ describe('entity', () => {
     const manifest = clone(samples.entity.manifest)
 
     collapse(manifest, samples.entity.prototype)
-    expect(manifest).toStrictEqual(samples.entity.result)
+    assert.deepStrictEqual(manifest, samples.entity.result)
+  })
+
+  it('should let a component state its own id', () => {
+    const prototype = { entity: { properties: { id: { type: 'string' }, VERSION: {} } } }
+    const manifest = { name: 'pot', entity: { properties: { id: { type: 'number' } } } }
+
+    collapse(manifest, prototype)
+
+    assert.strictEqual(manifest.entity.custom, true)
+    assert.deepStrictEqual(manifest.entity.properties.id, { type: 'number' })
+  })
+
+  it('should refuse a component that states a property the runtime writes', () => {
+    const prototype = { entity: { properties: { DELETED: { type: 'integer' } } } }
+    const manifest = {
+      name: 'pot',
+      entity: { properties: { DELETED: { type: 'integer' } } }
+    }
+
+    assert.throws(
+      () => collapse(manifest, prototype),
+      /System property 'DELETED' cannot be overridden/
+    )
+  })
+
+  it('should inherit migrations ahead of its own, under the prototype name', () => {
+    const manifest = { entity: { migrations: [{ id: '0002', steps: [] }] } }
+    const prototype = {
+      name: 'base',
+      entity: { migrations: [{ id: '0001', steps: [] }] }
+    }
+
+    collapse(manifest, prototype)
+
+    assert.deepStrictEqual(manifest.entity.migrations, [
+      { id: 'base:0001', steps: [], prototype: 'base' },
+      { id: '0002', steps: [] }
+    ])
+  })
+
+  it('should pass on what the prototype inherited as it is', () => {
+    const manifest = { entity: { migrations: [{ id: '0002', steps: [] }] } }
+    const prototype = {
+      name: 'base',
+      entity: {
+        migrations: [
+          { id: 'system:0001', steps: [], prototype: 'system' },
+          { id: '0001', steps: [] }
+        ]
+      }
+    }
+
+    collapse(manifest, prototype)
+
+    assert.deepStrictEqual(
+      manifest.entity.migrations.map(({ id }) => id),
+      ['system:0001', 'base:0001', '0002']
+    )
+  })
+
+  it('should inherit migrations into a component that declares none', () => {
+    const manifest = {}
+    const prototype = {
+      name: 'base',
+      entity: { migrations: [{ id: '0001', steps: [] }] }
+    }
+
+    collapse(manifest, prototype)
+
+    assert.deepStrictEqual(
+      manifest.entity.migrations.map(({ id }) => id),
+      ['base:0001']
+    )
   })
 })
 
@@ -44,12 +118,12 @@ it('should ignore bindings', () => {
   const manifest = clone(source)
 
   collapse(manifest, prototype)
-  expect(manifest).toStrictEqual(source)
+  assert.deepStrictEqual(manifest, source)
 
   delete manifest.bindings
 
   collapse(manifest, prototype)
-  expect(manifest).toStrictEqual({})
+  assert.deepStrictEqual(manifest, {})
 })
 
 it('should merge operations', () => {
@@ -57,5 +131,11 @@ it('should merge operations', () => {
   const prototype = clone(samples.operations.prototype)
 
   collapse(manifest, prototype, '/somewhere')
-  expect(manifest).toStrictEqual(samples.operations.result)
+
+  // the prototype's path is generated, so it is checked apart from the shape
+  assert.strictEqual(typeof manifest.prototype.path, 'string')
+
+  const { path, ...rest } = manifest.prototype
+
+  assert.deepStrictEqual({ ...manifest, prototype: rest }, samples.operations.result)
 })

package/test/component/dependencies.test.js

@@ -1,38 +1,40 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { resolve } = require('node:path')
-const { dependencies } = require('../../src/.component')
+import { resolve } from 'node:path'
+import { dependencies } from '../../src/.component/index.js'
 
-const NORM = resolve(__dirname, '../../')
+const NORM = resolve(import.meta.dirname, '../../')
 
 it('should be', async () => {
-  expect(dependencies).toBeInstanceOf(Function)
+  assert.ok(dependencies instanceof Function)
 })
 
 /** @type {toa.norm.Component} */
 let component
 
 beforeEach(() => {
-  component = /** @type {toa.norm.Component} */ { path: __dirname }
+  component = /** @type {toa.norm.Component} */ { path: import.meta.dirname }
 })
 
-describe.each(/** @type {[string, string][]} */ [
+for (const [_, reference] of [
   ['package id', '@toa.io/norm'],
   ['relative path', '../../']
-])('%s', (_, reference) => {
-  it('should resolve storage', async () => {
-    component.entity = { storage: reference, schema: {} }
+])
+  describe(`${_}`, () => {
+    it('should resolve storage', async () => {
+      component.entity = { storage: reference, schema: {} }
 
-    dependencies(component)
+      dependencies(component)
 
-    expect(component.entity.storage).toStrictEqual(NORM)
+      assert.deepStrictEqual(component.entity.storage, NORM)
+    })
   })
-})
 
 it('should resolve toa packages', async () => {
   component.entity = { storage: '@toa.io/core', schema: {} }
 
   dependencies(component)
 
-  expect(component.entity.storage).toBeDefined()
+  assert.notStrictEqual(component.entity.storage, undefined)
 })

package/test/component/dereference.fixtures.js

@@ -1,16 +1,12 @@
-'use strict'
-
-const source = {
+export const source = {
   entity: {
-    schema: {
-      properties: {
-        foo: {
-          type: 'string'
-        },
-        bar: {
-          type: 'string',
-          default: '.foo'
-        }
+    properties: {
+      foo: {
+        type: 'string'
+      },
+      bar: {
+        type: 'string',
+        default: '.foo'
       }
     }
   },
@@ -66,16 +62,14 @@ const source = {
   }
 }
 
-const target = {
+export const target = {
   entity: {
-    schema: {
-      properties: {
-        foo: {
-          type: 'string'
-        },
-        bar: {
-          type: 'string'
-        }
+    properties: {
+      foo: {
+        type: 'string'
+      },
+      bar: {
+        type: 'string'
       }
     }
   },
@@ -160,6 +154,3 @@ const target = {
     }
   }
 }
-
-exports.source = source
-exports.target = target

package/test/component/dereference.test.js

@@ -1,9 +1,10 @@
-'use strict'
+import { it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const clone = require('clone-deep')
+import clone from 'clone-deep'
 
-const { dereference } = require('../../src/.component')
-const fixtures = require('./dereference.fixtures')
+import { dereference } from '../../src/.component/index.js'
+import * as fixtures from './dereference.fixtures.js'
 
 let source
 
@@ -14,18 +15,27 @@ beforeEach(() => {
 it('should dereference', () => {
   dereference(source)
 
-  expect(source).toStrictEqual(fixtures.target)
+  assert.deepStrictEqual(source, fixtures.target)
 })
 
 it('should throw on invalid schema reference', () => {
   source.operations.transit.output.properties.baz = { type: 'string', default: '.' }
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(
+    () => dereference(source),
+    (error) => /is not defined/.test(error.message)
+  )
 
   source.operations.transit.output.properties.baz = { type: 'string', default: '.baz' }
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(
+    () => dereference(source),
+    (error) => /is not defined/.test(error.message)
+  )
 })
 
 it('should throw on invalid forwarding', () => {
   source.operations.create.forward = 'foo'
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.throws(
+    () => dereference(source),
+    (error) => /is not defined/.test(error.message)
+  )
 })

package/test/component/dummies/extension/index.js

@@ -1,9 +1,5 @@
-'use strict'
-
-const manifest = (declaration) => {
+export const manifest = (declaration) => {
   if (declaration.ok !== true) return
 
   return declaration
 }
-
-exports.manifest = manifest

package/test/component/dummies/migrations/conflicting/migrations/0001-one.yaml

@@ -0,0 +1,2 @@
+- delete:
+    filter: {}