@toa.io/norm 0.4.0 → 0.5.0

package/features/component.operations.feature

@@ -11,13 +11,13 @@ Feature: Operations declaration
       foo: string
       bar: 1
       """
-    When I declare assignment with:
+    When I declare operation assignment with:
       """
       <channel>:
         foo: .
         baz: .bar
       """
-    Then normalized assignment declaration must contain:
+    Then normalized operation assignment declaration must contain:
       """
       <channel>:
         type: object
@@ -38,13 +38,13 @@ Feature: Operations declaration
 
   Operation IO schemas must be able to reference prototype's entity properties.
 
-    When I declare assignment with:
+    When I declare operation assignment with:
       """
       output:
         id: .
       """
 
-    Then normalized assignment declaration must contain:
+    Then normalized operation assignment declaration must contain:
       """
       output:
         type: object
@@ -52,3 +52,43 @@ Feature: Operations declaration
           id:
             $ref: https://schemas.toa.io/0.0.0/definitions#/definitions/id
       """
+
+  Scenario: A receiver with binding should contain 'foreign=true'
+    When I declare operation transition with:
+      """
+      concurrency: none
+      output: null
+      """
+    When I declare receiver for profile.updated with:
+      """
+      path: ''
+      bridge: node
+      binding: amqp
+      transition: transition
+      """
+
+    Then normalized receiver for event profile.updated must contain:
+      """
+      foreign: true
+      """
+
+  Scenario: Receiver foreign property should not change if set:
+    When I declare operation transition with:
+      """
+      concurrency: none
+      output: null
+      """
+
+    When I declare receiver for profile.updated with:
+      """
+      path: ''
+      foreign: false
+      bridge: node
+      binding: amqp
+      transition: transition
+      """
+
+    Then normalized receiver for event profile.updated must contain:
+      """
+      foreign: false
+      """

package/features/steps/.test/manifest.test.js

@@ -1,8 +1,9 @@
 'use strict'
 
 const { AssertionError } = require('assert')
+const { generate } = require('randomstring')
 const { dump } = require('@toa.io/yaml')
-const { gherkin } = require('@toa.io/mock')
+const gherkin = require('@toa.io/tomato')
 
 const mock = { gherkin }
 
@@ -15,7 +16,7 @@ it('should be', () => undefined)
 let context
 
 beforeEach(() => {
-  const manifest = {
+  const manifest = /** @type {toa.norm.component.Declaration} */ {
     name: 'test',
     namespace: 'features',
     version: '1.0.0',
@@ -40,8 +41,8 @@ describe('Given I have an entity schema:', () => {
   })
 })
 
-describe('When I declare {operation} with:', () => {
-  const step = gherkin.steps.Wh('I declare {operation} with:')
+describe('When I declare operation {operation} with:', () => {
+  const step = gherkin.steps.Wh('I declare operation {operation} with:')
 
   it('should be', () => undefined)
 
@@ -57,8 +58,84 @@ describe('When I declare {operation} with:', () => {
   })
 })
 
-describe('Then normalized {operation} declaration must contain:', () => {
-  const step = gherkin.steps.Th('normalized {operation} declaration must contain:')
+describe('When I declare receiver for {label} with:', () => {
+  const step = gherkin.steps.Wh('I declare receiver for {label} with:')
+
+  it('should be', () => undefined)
+
+  it('should declare receiver', () => {
+    const event = 'assignment'
+    const input = { binding: 'amqp' }
+    const yaml = dump(input)
+
+    step.call(context, event, yaml)
+
+    expect(context.manifest.receivers[event]).toStrictEqual(input)
+  })
+
+})
+
+describe('Then normalized receiver for event {label} must contain:', () => {
+  const step = gherkin.steps.Th('normalized receiver for event {label} must contain:')
+
+  it('should be', () => undefined)
+
+  it('should throw if does not contain', async () => {
+    const label = generate()
+    const operation = generate()
+
+    context.manifest.operations = {
+      [operation]: {
+        type: 'transition',
+        scope: 'object',
+        concurrency: 'none'
+      }
+    }
+
+    context.manifest.receivers = {
+      [label]: {
+        path: '',
+        bridge: 'node',
+        transition: operation,
+        binding: 'amqp'
+      }
+    }
+
+    const input = { binding: 'kafka' }
+    const yaml = dump({ input })
+
+    await expect(step.call(context, label, yaml)).rejects.toThrow(AssertionError)
+  })
+
+  it('should not throw if contain', async () => {
+    const label = generate()
+    const operation = generate()
+
+    context.manifest.operations = {
+      [operation]: {
+        type: 'transition',
+        scope: 'object',
+        concurrency: 'none'
+      }
+    }
+
+    context.manifest.receivers = {
+      [label]: {
+        path: '',
+        bridge: 'node',
+        transition: operation,
+        binding: 'amqp'
+      }
+    }
+
+    const yaml = dump({ transition: operation })
+
+    await expect(step.call(context, label, yaml)).resolves.not.toThrow()
+  })
+})
+
+describe('Then normalized operation {operation} declaration must contain:', () => {
+  const step = gherkin.steps.Th('normalized operation {operation} declaration must contain:')
 
   it('should be', () => undefined)
 

package/features/steps/manifest.js

@@ -10,6 +10,26 @@ const { component: load } = require('../../src')
 
 const { Given, When, Then } = require('@cucumber/cucumber')
 
+/**
+ * @param variant {'operations'| 'receivers'}
+ * @param type {string}
+ * @param yaml {string}
+ * @return {Promise<void>}
+ */
+async function checkManifest (variant, type, yaml) {
+  const temp = await directory.temp()
+  const path = join(temp, 'manifest.toa.yaml')
+
+  await save(this.manifest, path)
+
+  const manifest = await load(temp)
+  const operation = manifest[variant][type]
+  const query = parse(yaml)
+  const contains = match(operation, query)
+
+  assert.equal(contains, true)
+}
+
 Given('I have an entity schema:',
   /**
    * @param {string} yaml
@@ -21,7 +41,7 @@ Given('I have an entity schema:',
     this.manifest.entity = { schema }
   })
 
-When('I declare {operation} with:',
+When('I declare operation {operation} with:',
   /**
    * @param {toa.norm.component.operations.Type} type
    * @param {string} yaml
@@ -37,24 +57,31 @@ When('I declare {operation} with:',
     this.manifest.operations = { [type]: declaration }
   })
 
-Then('normalized {operation} declaration must contain:',
+When('I declare receiver for {label} with:',
+  async function (label, yaml) {
+    const declaration = parse(yaml)
+
+    this.manifest.receivers = { [label]: declaration }
+  })
+
+Then('normalized operation {operation} declaration must contain:',
   /**
    * @param {toa.norm.component.operations.Type} type
    * @param {string} yaml
    * @this {toa.norm.features.Context}
    */
   async function (type, yaml) {
-    const temp = await directory.temp()
-    const path = join(temp, 'manifest.toa.yaml')
-
-    await save(this.manifest, path)
-
-    const manifest = await load(temp)
-    const operation = manifest.operations[type]
-    const query = parse(yaml)
-    const contains = match(operation, query)
+    await checkManifest.call(this, 'operations', type, yaml)
+  })
 
-    assert.equal(contains, true)
+Then('normalized receiver for event {label} must contain:',
+  /**
+   * @param {string} label
+   * @param {string} yaml
+   * @this {toa.norm.features.Context}
+   */
+  async function (label, yaml) {
+    await checkManifest.call(this, 'receivers', label, yaml)
   })
 
 /**

package/features/steps/parameters.js

@@ -7,3 +7,9 @@ defineParameterType({
   regexp: /transition|observation|assignment/,
   transformer: (type) => type
 })
+
+defineParameterType({
+  name: 'label',
+  regexp: /\S+/,
+  transformer: (name) => name
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/norm",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Toa declarations normalization and validation",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -19,10 +19,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "@toa.io/mock": "0.4.0"
+    "@toa.io/mock": "0.5.0"
   },
   "dependencies": {
-    "@toa.io/core": "0.4.0",
+    "@toa.io/core": "0.5.0",
     "@toa.io/generic": "0.4.0",
     "@toa.io/schema": "0.4.0",
     "@toa.io/schemas": "0.4.0",

package/src/.component/.normalize/index.js

@@ -3,7 +3,9 @@
 const { events } = require('./events')
 const { extensions } = require('./extensions')
 const { operations } = require('./operations')
+const { receivers } = require('./receivers');
 
 exports.events = events
 exports.extensions = extensions
 exports.operations = operations
+exports.receivers = receivers

package/src/.component/.normalize/receivers.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const receivers = (component) => {
+  if (component.receivers === undefined) return
+
+  for (const receiver of Object.values(component.receivers)) {
+    if (receiver.foreign === undefined) receiver.foreign = receiver.binding !== undefined
+  }
+}
+
+exports.receivers = receivers

package/src/.component/normalize.js

@@ -1,13 +1,14 @@
 'use strict'
 
 const { convolve } = require('@toa.io/generic')
-const { events, operations, extensions } = require('./.normalize')
+const { events, operations, extensions, receivers } = require('./.normalize')
 
 const normalize = (component, environment) => {
   convolve(component, environment)
   operations(component)
   events(component)
   extensions(component)
+  receivers(component)
 }
 
 exports.normalize = normalize

package/src/.component/schema.yaml

@@ -213,7 +213,9 @@ properties:
           adaptive:
             type: boolean
             default: false
-        required: [transition, bridge, path]
+          foreign:
+            type: boolean
+        required: [transition, bridge, path, foreign]
         additionalProperties: false
 
   extensions:

package/test/component/validate.fixtures.js

@@ -47,6 +47,7 @@ const ok = {
   },
   receivers: {
     'foo.bar.happened': {
+      foreign: true,
       transition: 'add',
       bridge: 'whatever',
       binding: 'amqp',

package/types/component.d.ts

@@ -42,6 +42,7 @@ export namespace toa.norm {
       bridge: string
       binding: string
       path: string
+      foreign: boolean
     }
 
     type Entity = {