@toa.io/norm 1.0.0-alpha.31 → 1.0.0-alpha.310

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,8 @@
-'use strict'
-
-const source = {
+export const source = {
   entity: {
-    schema: {
-      properties: {
-        foo: {
-          type: 'string'
-        },
-        bar: {
-          type: 'string',
-          default: '.foo'
-        }
+    properties: {
+      foo: {
+        type: 'string'
       }
     }
   },
@@ -19,42 +11,14 @@ const source = {
       input: {
         properties: {
           foo: {
-            type: 'string',
-            default: '.'
-          },
-          bar: {
-            type: 'string',
-            default: '.foo'
-          },
-          baz1: {
-            type: 'array',
-            items: {
-              type: 'string',
-              default: '.foo'
-            }
-          },
-          baz2: {
-            type: 'array',
-            items: {
-              properties: {
-                foo: {
-                  type: 'string',
-                  default: '.'
-                },
-                bar: {
-                  type: 'string',
-                  default: '.foo'
-                }
-              }
-            }
+            type: 'string'
           }
         }
       },
       output: {
         properties: {
           bar: {
-            type: 'string',
-            default: '.foo'
+            type: 'string'
           }
         }
       }
@@ -66,16 +30,11 @@ const source = {
   }
 }
 
-const target = {
+export const target = {
   entity: {
-    schema: {
-      properties: {
-        foo: {
-          type: 'string'
-        },
-        bar: {
-          type: 'string'
-        }
+    properties: {
+      foo: {
+        type: 'string'
       }
     }
   },
@@ -85,28 +44,6 @@ const target = {
         properties: {
           foo: {
             type: 'string'
-          },
-          bar: {
-            type: 'string'
-          },
-          baz1: {
-            type: 'array',
-            items: {
-              type: 'string'
-            }
-          },
-          baz2: {
-            type: 'array',
-            items: {
-              properties: {
-                foo: {
-                  type: 'string'
-                },
-                bar: {
-                  type: 'string'
-                }
-              }
-            }
           }
         }
       },
@@ -125,28 +62,6 @@ const target = {
         properties: {
           foo: {
             type: 'string'
-          },
-          bar: {
-            type: 'string'
-          },
-          baz1: {
-            type: 'array',
-            items: {
-              type: 'string'
-            }
-          },
-          baz2: {
-            type: 'array',
-            items: {
-              properties: {
-                foo: {
-                  type: 'string'
-                },
-                bar: {
-                  type: 'string'
-                }
-              }
-            }
           }
         }
       },
@@ -160,6 +75,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,13 @@ beforeEach(() => {
 it('should dereference', () => {
   dereference(source)
 
-  expect(source).toStrictEqual(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/)
-
-  source.operations.transit.output.properties.baz = { type: 'string', default: '.baz' }
-  expect(() => dereference(source)).toThrow(/is not defined/)
+  assert.deepStrictEqual(source, fixtures.target)
 })
 
 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: {}

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

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

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

@@ -0,0 +1 @@
+index: not a list

package/test/component/dummies/migrations/ordered/migrations/0001-first.yml

@@ -0,0 +1,4 @@
+- index:
+    name: index_a
+    keys:
+      a: asc

package/test/component/dummies/migrations/ordered/migrations/0002-second.yaml

@@ -0,0 +1,4 @@
+- index:
+    name: index_b
+    keys:
+      b: asc

package/test/component/dummies/migrations/ordered/migrations/0010-third.json

@@ -0,0 +1 @@
+[{ "delete": { "filter": {} } }]

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

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

package/test/component/expand.fixtures.js

@@ -1,11 +1,10 @@
-'use strict'
-
-const source = {
-  path: '',
+export const source = {
+  path: import.meta.dirname, // `version` hashes the component directory
   entity: {
     schema: {
+      type: 'object',
       properties: {
-        foo: 'string'
+        foo: { type: 'string' }
       }
     },
     storage: 'mongodb'
@@ -16,26 +15,30 @@ const source = {
       bridge: 'node',
       bindings: ['amqp'],
       input: {
+        type: 'object',
         properties: {
-          foo: 'integer',
+          foo: { type: 'integer' },
           bar: {
             type: 'array',
             items: {
+              type: 'object',
               properties: {
-                baz: 'string'
+                baz: { type: 'string' }
               }
             }
           }
         }
       },
       output: {
+        type: 'object',
         properties: {
-          foo: 'integer',
+          foo: { type: 'integer' },
           bar: {
             type: 'array',
             items: {
+              type: 'object',
               properties: {
-                baz: 'string'
+                baz: { type: 'string' }
               }
             }
           }
@@ -59,7 +62,7 @@ const source = {
   }
 }
 
-const target = {
+export const target = {
   entity: {
     schema: {
       type: 'object',
@@ -133,6 +136,3 @@ const target = {
     }
   }
 }
-
-exports.source = source
-exports.target = target

package/test/component/expand.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 { expand } = require('../../src/.component')
-const fixtures = require('./expand.fixtures')
+import { expand } from '../../src/.component/index.js'
+import * as fixtures from './expand.fixtures.js'
 
 let source
 
@@ -11,18 +12,21 @@ beforeEach(() => {
   source = clone(fixtures.source)
 })
 
-it('should expand', () => {
-  expand(source)
-  expect(source).toMatchObject(fixtures.target)
+it('should expand', async () => {
+  await expand(source)
+  assert.partialDeepStrictEqual(source, fixtures.target)
 })
 
-it('should recognize storages.queues', async () => {
-  const queues = { foo: 'bar' }
+it('should derive version from the component contents', async () => {
+  await expand(source)
 
-  source.queues = clone(queues)
+  assert.match(source.version, /^[0-9a-f]{8}$/)
+})
+
+it('should keep declared version', async () => {
+  source.version = '1.0.0'
 
-  expand(source)
+  await expand(source)
 
-  expect(source.queues).toBeUndefined()
-  expect(source.properties['@toa.io/storages.queues']).toMatchObject(queues)
+  assert.deepStrictEqual(source.version, '1.0.0')
 })

package/test/component/migrations.test.js

@@ -0,0 +1,62 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { join } from 'node:path'
+
+import { migrations } from '../../src/.component/index.js'
+
+const DUMMIES = join(import.meta.dirname, 'dummies/migrations')
+
+const entity = () => ({ entity: { schema: { properties: {} } } })
+
+describe('migrations', () => {
+  it('should read a directory of migrations', async () => {
+    const manifest = entity()
+
+    await migrations(join(DUMMIES, 'ordered'), manifest)
+
+    assert.deepEqual(
+      manifest.entity.migrations.map(({ id }) => id),
+      ['0001-first', '0002-second', '0010-third']
+    )
+  })
+
+  it('should read whatever extension each was written with', async () => {
+    const manifest = entity()
+
+    await migrations(join(DUMMIES, 'ordered'), manifest)
+
+    assert.deepEqual(manifest.entity.migrations[0].steps, [
+      { index: { name: 'index_a', keys: { a: 'asc' } } }
+    ])
+    assert.deepEqual(manifest.entity.migrations[2].steps, [{ delete: { filter: {} } }])
+  })
+
+  it('should leave a component with no migrations alone', async () => {
+    const manifest = entity()
+
+    await migrations(join(DUMMIES, 'nothing-here'), manifest)
+
+    assert.equal(manifest.entity.migrations, undefined)
+  })
+
+  it('should refuse two files resolving to one id', async () => {
+    await assert.rejects(
+      migrations(join(DUMMIES, 'conflicting'), entity()),
+      /has more than one migrations\/0001-one/
+    )
+  })
+
+  it('should refuse migrations on a component that stores nothing', async () => {
+    await assert.rejects(
+      migrations(join(DUMMIES, 'stateless'), {}),
+      /declares migrations but stores nothing/
+    )
+  })
+
+  it('should refuse a migration that is not a list of steps', async () => {
+    await assert.rejects(
+      migrations(join(DUMMIES, 'malformed'), entity()),
+      /is not a list of steps/
+    )
+  })
+})

package/test/component/normalize.fixtures.js

@@ -1,11 +1,9 @@
-'use strict'
+import { generate } from 'randomstring'
 
-const { generate } = require('randomstring')
-
-const operations = {
+export const operations = {
   namespace: 'dummies',
   name: 'dummy',
-  path: __dirname,
+  path: import.meta.dirname,
   bindings: ['foo', 'bar'],
   'bindings@local': ['foo'],
   operations: {
@@ -22,5 +20,3 @@ const operations = {
     }
   }
 }
-
-exports.operations = operations

package/test/component/normalize.test.js

@@ -1,10 +1,10 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { dirname } = require('node:path')
-const clone = require('clone-deep')
+import clone from 'clone-deep'
 
-const { normalize } = require('../../src/.component')
-const fixtures = require('./normalize.fixtures')
+import { normalize, extensions } from '../../src/.component/index.js'
+import * as fixtures from './normalize.fixtures.js'
 
 let manifest
 
@@ -13,51 +13,117 @@ beforeEach(() => {
 })
 
 describe('operations', () => {
-  it('should set default bindings', () => {
-    normalize(manifest)
+  it('should set default bindings', async () => {
+    await normalize(manifest)
 
-    expect(manifest.operations.add.bindings).toStrictEqual(manifest.bindings)
+    assert.deepStrictEqual(manifest.operations.add.bindings, manifest.bindings)
+  })
+
+  it('should state an empty output where none is declared', async () => {
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.operations.add.output, {})
+  })
+
+  it('should state no input for an operation that takes none', async () => {
+    manifest.operations.compute = { type: 'computation', input: null }
+
+    await normalize(manifest)
+
+    assert.equal('input' in manifest.operations.compute, false)
+  })
+
+  it('should scope a computation to none', async () => {
+    manifest.operations.compute = { type: 'computation' }
+
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.operations.compute.scope, 'none')
+    assert.deepStrictEqual(manifest.operations.compute.query, false)
+  })
+
+  it('should scope an effect to none unless it says otherwise', async () => {
+    manifest.operations.affect = { type: 'effect' }
+    manifest.operations.reach = { type: 'effect', scope: 'objects' }
+
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.operations.affect.scope, 'none')
+    assert.deepStrictEqual(manifest.operations.reach.scope, 'objects')
+  })
+})
+
+describe('namespace', () => {
+  it('should default to `default`', async () => {
+    delete manifest.namespace
+
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.namespace, 'default')
+  })
+})
+
+describe('entity', () => {
+  it('should default storage and flags', async () => {
+    manifest.entity = { properties: {} }
+
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.entity.storage, '@toa.io/storages.mongodb')
+    assert.deepStrictEqual(manifest.entity.associated, false)
+    assert.deepStrictEqual(manifest.entity.custom, false)
+  })
+
+  it('should allow a date-time on the record', async () => {
+    manifest.entity = { properties: { settled: { type: 'string', format: 'date-time' } } }
+
+    await normalize(manifest)
+
+    assert.deepStrictEqual(manifest.entity.properties.settled.format, 'date-time')
   })
 })
 
 describe('extensions', () => {
-  it('should resolve absolute references', () => {
-    const origins = manifest.extensions['@toa.io/extensions.origins']
-    const path = dirname(require.resolve('@toa.io/extensions.origins/package.json'))
+  it('should add predefined extensions', async () => {
+    await extensions(manifest)
+
+    // telemetry normalizes its declaration, so a component that declares nothing has an
+    // empty one rather than none; fetch has no manifest of its own to normalize
+    assert.deepStrictEqual(manifest.extensions['@toa.io/extensions.telemetry'], {})
+    assert.strictEqual(manifest.extensions['@toa.io/extensions.fetch'], null)
+  })
 
-    normalize(manifest)
+  it('should add predefined extensions without explicit declarations', async () => {
+    delete manifest.extensions
 
-    expect(manifest.extensions[path]).toStrictEqual(origins)
+    await extensions(manifest)
+
+    assert.deepStrictEqual(manifest.extensions, {
+      '@toa.io/extensions.telemetry': {},
+      '@toa.io/extensions.fetch': null,
+      '@toa.io/extensions.introspection': {}
+    })
   })
 })
 
 describe('receivers', () => {
   it('should substitute default namespace', async () => {
     manifest.receivers = {
-      'messages.created': 'add'
+      'messages.created': { operation: 'add' }
     }
 
-    normalize(manifest)
+    await normalize(manifest)
 
-    expect(manifest.receivers).toStrictEqual({
-      'default.messages.created': 'add'
-    })
+    assert.deepStrictEqual(Object.keys(manifest.receivers), ['default.messages.created'])
   })
 
   it('should not substitute default namespace for foreign events', async () => {
-    const receiver = {
-      transition: 'add',
-      source: 'test'
-    }
-
     manifest.receivers = {
-      'messages.created': receiver
+      'messages.created': { transition: 'add', source: 'test' }
     }
 
-    normalize(manifest)
+    await normalize(manifest)
 
-    expect(manifest.receivers).toStrictEqual({
-      'messages.created': receiver
-    })
+    assert.deepStrictEqual(Object.keys(manifest.receivers), ['messages.created'])
   })
 })