@toa.io/userland 1.0.0-alpha.7 → 1.0.0-alpha.9

package/samples/src/suite/components.js

@@ -1,31 +0,0 @@
-'use strict'
-
-const norm = require('@toa.io/norm')
-const { merge } = require('@toa.io/generic')
-
-const read = require('./.read')
-
-/**
- * @param {string[]} paths
- * @param {toa.samples.suite.Options} [options]
- * @returns {Promise<toa.samples.Suite>}
- */
-const components = async (paths, options = {}) => {
-  /** @type {toa.samples.Suite} */
-  const suite = { title: 'Component samples', autonomous: true, operations: {} }
-
-  for (const path of paths) {
-    const manifest = await norm.component(path)
-
-    options.id = manifest.locator.id
-
-    const operations = await read.operations(path, options)
-    // const messages = await read.messages(path, options)
-
-    merge(suite, { operations })
-  }
-
-  return suite
-}
-
-exports.components = components

package/samples/src/suite/context.js

@@ -1,20 +0,0 @@
-'use strict'
-
-const read = require('./.read')
-
-/**
- * @param {string} path
- * @param {toa.samples.suite.Options} [options]
- * @returns {Promise<toa.samples.Suite>}
- */
-const context = async (path, options = {}) => {
-  /** @type {toa.samples.Suite} */
-  const suite = { title: 'Integration samples', autonomous: false }
-
-  suite.operations = await read.operations(path, options)
-  suite.messages = await read.messages(path, options)
-
-  return suite
-}
-
-exports.context = context

package/samples/src/suite/index.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const { components } = require('./components')
-const { context } = require('./context')
-
-exports.components = components
-exports.context = context

package/samples/test/components.test.js

@@ -1,42 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-const { suite } = require('./suite.mock')
-const { replay } = require('./replay.mock')
-const mock = { suite, replay }
-
-jest.mock('../src/suite', () => mock.suite)
-jest.mock('../src/replay', () => mock.replay)
-
-const { components } = require('../')
-
-it('should be', () => {
-  expect(components).toBeDefined()
-})
-
-const paths = [generate()]
-
-/** @type {toa.samples.suite.Options} */
-const options = { component: generate(), runner: { [generate()]: generate() } }
-
-/** @type {boolean} */
-let result
-
-beforeAll(async () => {
-  result = await components(paths, options)
-})
-
-it('should load suite', async () => {
-  expect(mock.suite.components).toHaveBeenCalledWith(paths, options)
-})
-
-it('should replay suite', async () => {
-  const suite = await mock.suite.components.mock.results[0].value
-
-  expect(mock.replay.replay).toHaveBeenCalledWith(suite, paths, options.runner)
-})
-
-it('should return result', async () => {
-  expect(result).toStrictEqual(await mock.replay.replay.mock.results[0].value)
-})

package/samples/test/context/components/dummy/manifest.toa.yaml

@@ -1,2 +0,0 @@
-namespace: dummies
-name: dummy

package/samples/test/context/components/dummy/samples/do.yaml

@@ -1,11 +0,0 @@
-title: First case
-input:
-  foo: bar
-output:
-  baz: true
----
-title: Second case
-input:
-  foo: qux
-output:
-  baz: false

package/samples/test/context/components/dummy/samples/dummies.dummy.do.yaml

@@ -1,11 +0,0 @@
-title: Third case
-input:
-  foo: bar
-output:
-  baz: true
----
-title: Fourth case
-input:
-  foo: qux
-output:
-  baz: false

package/samples/test/context/components/dummy/samples/dummies.dummy.undo.yaml

@@ -1,7 +0,0 @@
-title: Should undo
-input: 1
-output: true
----
-title: Should not undo
-input: 0
-output: false

package/samples/test/context/components/dummy/samples/messages/somewhere.something.happened.yaml

@@ -1,6 +0,0 @@
-title: Something happened with a dummy
-payload:
-  foo: bar
-input: foo
-query:
-  id: bar

package/samples/test/context/components/pot/manifest.toa.yaml

@@ -1,2 +0,0 @@
-namespace: dummies
-name: pot

package/samples/test/context/components/pot/samples/do.yaml

@@ -1,11 +0,0 @@
-title: First case
-input:
-  foo: bar
-output:
-  baz: true
----
-title: Second case
-input:
-  foo: qux
-output:
-  baz: false

package/samples/test/context/components/pot/samples/messages/somewhere.something.happened.yaml

@@ -1,6 +0,0 @@
-title: Something happened with a pot
-payload:
-  foo: bar
-input: foo
-query:
-  id: bar

package/samples/test/context/context.toa.yaml

@@ -1,3 +0,0 @@
-name: test
-packages: components/*
-registry: whatever.none

package/samples/test/context/samples/dummies.dummy.observe.yaml

@@ -1,6 +0,0 @@
-title: Should observe
-query:
-  id: 57022f11306149d8b246c9ea4a164079
-output:
-  id: 57022f11306149d8b246c9ea4a164079
-  bar: 2

package/samples/test/context/samples/dummies.dummy.transit.yaml

@@ -1,10 +0,0 @@
-title: First sample
-input:
-  foo: 1
-output:
-  bar: 2
----
-input:
-  foo: 2
-output:
-  bar: 3

package/samples/test/context/samples/messages/somewhere.something.happened.yaml

@@ -1,6 +0,0 @@
-title: First sample
-component: dummies.dummy
-payload:
-  foo: 1
-input:
-  bar: 2

package/samples/test/context.fixtures.js

@@ -1,8 +0,0 @@
-'use strict'
-
-const { flip } = require('@toa.io/generic')
-
-const components = jest.fn(async () => flip())
-const mock = { components: { components } }
-
-exports.mock = mock

package/samples/test/context.test.js

@@ -1,82 +0,0 @@
-'use strict'
-
-const { resolve } = require('node:path')
-const { directory: { glob } } = require('@toa.io/filesystem')
-
-const fixtures = require('./context.fixtures')
-const { suite } = require('./suite.mock')
-const { replay } = require('./replay.mock')
-
-const mock = { suite, replay, ...fixtures.mock }
-
-jest.mock('../src/suite', () => mock.suite)
-jest.mock('../src/replay', () => mock.replay)
-jest.mock('../src/components', () => mock.components)
-
-const { context } = require('../src/context')
-const { generate } = require('randomstring')
-
-it('should be', async () => {
-  expect(context).toBeDefined()
-})
-
-const CONTEXT = resolve(__dirname, './context')
-const COMPONENTS = resolve(CONTEXT, 'components/*')
-
-/** @type {string[]} */
-let paths
-
-/** @type {toa.samples.suite.Options} */
-const options = { component: generate(), runner: { [generate()]: generate() } }
-
-/** @type {boolean} */
-let ok
-
-beforeAll(async () => {
-  paths = await glob(COMPONENTS)
-})
-
-beforeEach(async () => {
-  jest.clearAllMocks()
-
-  mock.components.components.mockImplementation(async () => true)
-
-  ok = await context(CONTEXT, options)
-})
-
-it('should replay context components sample sets', async () => {
-  expect(mock.components.components).toHaveBeenCalledWith(paths, options)
-})
-
-it('should load integration suite', async () => {
-  expect(mock.suite.context).toHaveBeenCalledWith(CONTEXT, options)
-})
-
-it('should replay integration suite', async () => {
-  const suite = await mock.suite.context.mock.results[0].value
-
-  expect(replay.replay).toHaveBeenCalledWith(suite, paths, options.runner)
-})
-
-it('should return false if components replay failed', async () => {
-  jest.clearAllMocks()
-
-  mock.components.components.mockImplementation(async () => false)
-
-  ok = await context(CONTEXT)
-
-  expect(ok).toStrictEqual(false)
-  expect(replay.replay).not.toHaveBeenCalled()
-})
-
-it('should return replay result if components replay ok', async () => {
-  jest.clearAllMocks()
-
-  mock.components.components.mockImplementation(async () => true)
-
-  ok = await context(CONTEXT)
-
-  const mocked = await mock.replay.replay.mock.results[0].value
-
-  expect(ok).toStrictEqual(mocked)
-})

package/samples/test/replay.mock.js

@@ -1,7 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-const replay = jest.fn(async () => generate())
-
-exports.replay = { replay }

package/samples/test/replay.test.js

@@ -1,152 +0,0 @@
-'use strict'
-
-const { resolve } = require('node:path')
-const { directory } = require('@toa.io/filesystem')
-
-const { stage } = require('./stage.mock')
-const { translate } = require('./replay.translate.mock')
-const mock = { stage, translate }
-
-jest.mock('@toa.io/userland/stage', () => mock.stage)
-jest.mock('../src/.replay/.suite/translate', () => mock.translate)
-
-const load = require('../src/suite')
-
-const { replay } = require('../src')
-
-it('should be', () => {
-  expect(replay).toBeDefined()
-})
-
-let ok
-
-/** @type {toa.samples.Suite} */
-let suite
-
-beforeEach(() => {
-  jest.clearAllMocks()
-})
-
-describe('autonomous', () => {
-  let paths
-
-  beforeEach(async () => {
-    const path = resolve(__dirname, '../../example/components/tea.pots')
-
-    paths = [path]
-    suite = await load.components(paths)
-    ok = await replay(suite, paths)
-  })
-
-  it('should not boot composition for autonomous suite', async () => {
-    expect(stage.composition).not.toHaveBeenCalled()
-  })
-
-  it('should invoke operations with translated samples', async () => {
-    const component = await stage.component.mock.results[0].value
-
-    for (const set of Object.values(suite.operations)) {
-      for (const [endpoint, samples] of Object.entries(set)) {
-        for (const sample of samples) {
-          const request = translation(sample)
-
-          expect(component.invoke).toHaveBeenCalledWith(endpoint, request)
-        }
-      }
-    }
-  })
-})
-
-describe('integration', () => {
-  let paths
-
-  beforeEach(async () => {
-    const path = resolve(__dirname, '../../example')
-
-    paths = await directory.directories(resolve(path, 'components'))
-    suite = await load.context(path)
-    ok = await replay(suite, paths)
-  })
-
-  it('should boot composition', () => {
-    expect(stage.composition).toHaveBeenCalled()
-    expect(stage.composition).toHaveBeenCalledWith(paths)
-  })
-
-  it('should invoke operations with translated samples', async () => {
-    /**
-     * @param {string} component
-     * @return {jest.MockedObject<toa.core.Component>}
-     */
-    const getRemote = (component) => {
-      for (let n = 0; n < stage.remote.mock.calls.length; n++) {
-        const call = stage.remote.mock.calls[n]
-
-        if (call[0] === component) return stage.remote.mock.results[n].value
-      }
-
-      throw new Error(`Remote ${component} hasn't been connected`)
-    }
-
-    for (const [id, set] of Object.entries(suite.operations)) {
-      const remote = await getRemote(id)
-
-      for (const [endpoint, samples] of Object.entries(set)) {
-        for (const sample of samples) {
-          const request = translation(sample)
-
-          expect(remote.invoke).toHaveBeenCalledWith(endpoint, request)
-        }
-      }
-    }
-  })
-
-  it('should emit translated messages', async () => {
-    /**
-     * @param {toa.samples.Message} declaration
-     * @returns {{index: number, message: toa.sampling.Message}}
-     */
-    const translation = (declaration) => {
-      const find = (call) => call[0].payload === declaration.payload
-      const index = mock.translate.message.mock.calls.findIndex(find)
-      const message = mock.translate.message.mock.results[index].value
-      const call = mock.translate.message.mock.calls[index]
-
-      expect(call[1]).toStrictEqual(suite.autonomous)
-
-      return { index, message }
-    }
-
-    for (const [label, samples] of Object.entries(suite.messages)) {
-      for (const sample of samples) {
-        const { index, message } = translation(sample)
-
-        expect(stage.binding.binding.emit)
-          .toHaveBeenNthCalledWith(index + 1, label, message)
-      }
-    }
-  })
-
-  it('should shutdown stage', () => {
-    expect(stage.shutdown).toHaveBeenCalled()
-  })
-
-  it('should return results', () => {
-    expect(ok).toStrictEqual(true)
-  })
-
-  it.each(['messages', 'operations'])('should not throw if no %s defined', async (key) => {
-    delete suite[key]
-
-    ok = await replay(suite, paths)
-
-    expect(ok).toStrictEqual(true)
-  })
-})
-
-const translation = (declaration) => {
-  const find = (call) => call[0].input === declaration.input
-  const index = mock.translate.operation.mock.calls.findIndex(find)
-
-  return mock.translate.operation.mock.results[index].value
-}

package/samples/test/replay.translate.message.fixtures.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-const { flip } = require('@toa.io/generic')
-
-/** @type {toa.samples.Message} */
-const message = {
-  title: generate(),
-  payload: { [generate()]: generate() },
-  input: generate(),
-  query: { id: generate() },
-  request: {
-    current: {
-      id: generate()
-    }
-  }
-}
-
-const autonomous = flip()
-const component = generate()
-
-exports.message = message
-exports.autonomous = autonomous
-exports.component = component

package/samples/test/replay.translate.message.test.js

@@ -1,119 +0,0 @@
-'use strict'
-
-const clone = require('clone-deep')
-
-const fixtures = require('./replay.translate.message.fixtures')
-const { message: translate } = require('../src/.replay/.suite/translate')
-const { generate } = require('randomstring')
-
-it('should be', async () => {
-  expect(translate).toBeDefined()
-})
-
-/** @type {toa.samples.Message} */
-let declaration
-
-/** @type {toa.sampling.Message} */
-let message
-
-/** @type {toa.sampling.messages.Sample} */
-let sample
-
-beforeEach(() => {
-  jest.clearAllMocks()
-
-  declaration = clone(fixtures.message)
-  message = translate(declaration, fixtures.autonomous, fixtures.component)
-  sample = message.sample
-})
-
-it('should copy payload', async () => {
-  expect(message.payload).toStrictEqual(declaration.payload)
-})
-
-it('should copy title', async () => {
-  expect(sample.request.title).toStrictEqual(declaration.title)
-})
-
-it('should copy autonomous', async () => {
-  expect(sample.request.autonomous).toStrictEqual(fixtures.autonomous)
-})
-
-it('should copy component', async () => {
-  expect(sample.component).toStrictEqual(fixtures.component)
-})
-
-it.each(['input', 'query'])('should copy %s to request', async (key) => {
-  const value = declaration[key]
-
-  expect(sample.request.request[key]).toStrictEqual(value)
-})
-
-it.each(['input', 'query'])('should create request with %s', async (key) => {
-  const value = declaration[key]
-
-  delete declaration.request
-
-  const { sample } = translate(declaration, fixtures.autonomous, fixtures.component)
-
-  expect(sample.request.request[key]).toStrictEqual(value)
-})
-
-it('should keep request properties', async () => {
-  expect(sample.request.storage.current).toMatchObject(fixtures.message.request.current)
-})
-
-it('should add `terminate: true` if request is not defined (and sample is autonomous)',
-  async () => {
-    delete declaration.request
-
-    message = translate(declaration, fixtures.autonomous, fixtures.component)
-
-    expect(message.sample.request.terminate).toStrictEqual(true)
-  })
-
-it('should not create undefined keys in request', async () => {
-  delete declaration.input
-
-  message = translate(declaration, fixtures.autonomous, fixtures.component)
-
-  expect('input' in message.sample.request.request).toStrictEqual(false)
-})
-
-it('should declare sample as authentic', async () => {
-  expect(sample.authentic).toStrictEqual(true)
-})
-
-describe('validation', () => {
-  /** @type {toa.samples.Message} */
-  let declaration
-
-  const check = () => translate(declaration, fixtures.autonomous, fixtures.component)
-
-  beforeEach(() => {
-    declaration = clone(fixtures.message)
-  })
-
-  it('should throw on schema mismatch', async () => {
-    // noinspection JSValidateTypes
-    declaration.title = { foo: 1 }
-
-    expect(check).toThrow('must be string')
-  })
-
-  it('should throw on request schema mismatch', async () => {
-    // noinspection JSValidateTypes
-    declaration.request = { title: { foo: 1 } }
-
-    expect(check).toThrow('must be string')
-  })
-
-  it.each([['input', 'query']])('should throw if request.%s is defined', async (key) => {
-    expect.assertions(1)
-
-    declaration[key] = { id: generate() }
-    declaration.request = /** @type {toa.samples.Operation} */ { [key]: { id: generate() } }
-
-    expect(() => check()).toThrow('/request')
-  })
-})

package/samples/test/replay.translate.mock.js

@@ -1,17 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-// noinspection JSCheckFunctionSignatures
-const operation = jest.fn((declaration) => {
-  const { input, ...sample } = declaration
-
-  return { input, sample }
-})
-
-// noinspection JSCheckFunctionSignatures
-const message = jest.fn((declaration) => generate())
-
-const translate = { operation, message }
-
-exports.translate = translate