Fixing issue with intent metadata in agent-proxy and a leak in conformance test execution

Author: kriswest

packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts

@@ -147,6 +147,8 @@ export class DefaultIntentSupport implements IntentSupport {
         app: app || undefined,
         metadata: {
           traceId: metadata?.traceId ?? v4(),
+          ...(metadata?.signature !== undefined && { signature: metadata.signature }),
+          ...(metadata?.custom !== undefined && { custom: metadata.custom }),
         },
       },
       meta,
@@ -197,6 +199,8 @@ export class DefaultIntentSupport implements IntentSupport {
         app,
         metadata: {
           traceId: metadata?.traceId ?? v4(),
+          ...(metadata?.signature !== undefined && { signature: metadata.signature }),
+          ...(metadata?.custom !== undefined && { custom: metadata.custom }),
         },
       },
       meta,

packages/fdc3-agent-proxy/test/features/raise-intents.feature

@@ -71,3 +71,19 @@ Feature: Basic Intents Support
     And messaging will have posts
       | payload.context.type | matches_type                 |
       | fdc3.cancel-me       | raiseIntentForContextRequest |
+
+  Scenario: Raising an intent with metadata forwards traceId, signature and custom
+    Given "intentMetadata" is metadata with traceId "trace-123" and signature "sig-abc"
+    When I call "{api}" with "raiseIntent" with parameters "Buy" and "{instrumentContext}" and "{null}" and "{intentMetadata}"
+    Then "{result}" is an object with the following contents
+      | source.appId | source.instanceId |
+      | bank         | b1                |
+    And messaging will have posts
+      | payload.intent | payload.context.type | payload.metadata.traceId | payload.metadata.signature | payload.metadata.custom.priority | matches_type       |
+      | Buy            | fdc3.instrument      | trace-123                | sig-abc                    | high                             | raiseIntentRequest |
+
+  Scenario: Raising an intent without metadata generates a traceId but omits signature and custom
+    When I call "{api}" with "raiseIntent" with parameters "Buy" and "{instrumentContext}"
+    And messaging will have posts
+      | payload.intent | payload.context.type | payload.metadata.signature | payload.metadata.custom | matches_type       |
+      | Buy            | fdc3.instrument      | {null}                     | {null}                  | raiseIntentRequest |

packages/fdc3-agent-proxy/test/step-definitions/intents.steps.ts

@@ -202,3 +202,14 @@ Given('{string} returns a void promise', (world: CustomWorld, intentHandlerName:
     return null;
   };
 });
+
+Given(
+  '{string} is metadata with traceId {string} and signature {string}',
+  (world: CustomWorld, field: string, traceId: string, signature: string) => {
+    world.props[field] = {
+      traceId,
+      signature,
+      custom: { priority: 'high' },
+    };
+  }
+);

packages/testing/src/steps/generic.impl.ts

@@ -100,6 +100,31 @@ export async function callWithMethodAndThreeParams(
   }
 }
 
+export async function callWithMethodAndFourParams(
+  world: PropsWorldLike,
+  field: string,
+  fnName: string,
+  param1: string,
+  param2: string,
+  param3: string,
+  param4: string
+): Promise<void> {
+  try {
+    const object = handleResolve(field, world) as Record<string, (...args: unknown[]) => unknown>;
+    const fn = object[fnName];
+    const result = await fn.call(
+      object,
+      handleResolve(param1, world),
+      handleResolve(param2, world),
+      handleResolve(param3, world),
+      handleResolve(param4, world)
+    );
+    world.props['result'] = result;
+  } catch (error) {
+    world.props['result'] = error;
+  }
+}
+
 export function referToAs(world: PropsWorldLike, from: string, to: string): void {
   world.props[to] = handleResolve(from, world);
 }

packages/testing/src/steps/generic.steps.ts

@@ -37,6 +37,21 @@ export function setupGenericSteps(schemaBasePath: string): void {
     }
   );
 
+  When(
+    'I call {string} with {string} with parameters {string} and {string} and {string} and {string}',
+    async (
+      world: PropsWorldLike,
+      field: string,
+      fnName: string,
+      param1: string,
+      param2: string,
+      param3: string,
+      param4: string
+    ) => {
+      await impl.callWithMethodAndFourParams(world, field, fnName, param1, param2, param3, param4);
+    }
+  );
+
   When('I refer to {string} as {string}', (world: PropsWorldLike, from: string, to: string) => {
     impl.referToAs(world, from, to);
   });

toolbox/fdc3-conformance/src/test/advanced/fdc3.context-metadata.ts

@@ -19,12 +19,18 @@ const validator = new ContextMetadataValidator();
 export default async () => {
   const fdc3 = await getAgent();
   const cc = new ChannelControlImpl(fdc3);
+  let mockAppOpened = false;
 
   return describe('fdc3.contextMetadata', () => {
-    beforeEach(cc.leaveChannel);
+    beforeEach(async function beforeEach() {
+      mockAppOpened = false;
+      await cc.leaveChannel();
+    });
 
     afterEach(async function afterEach() {
-      await cc.closeMockApp(this.currentTest?.title ?? 'Some-Test-Title');
+      if (mockAppOpened) {
+        await cc.closeMockApp(this.currentTest?.title ?? 'Some-Test-Title');
+      }
     });
 
     // --- User Channel Tests ---
@@ -51,6 +57,7 @@ export default async () => {
 
       const channel = await cc.getNonGlobalUserChannel();
       await cc.joinChannel(channel);
+      mockAppOpened = true;
       await cc.openChannelApp(ucMetadataBroadcast, channel.id, JOIN_AND_BROADCAST);
       await resolveExecutionCompleteListener;
 
@@ -88,6 +95,7 @@ export default async () => {
 
       const channel = await cc.getNonGlobalUserChannel();
       await cc.joinChannel(channel);
+      mockAppOpened = true;
       await cc.openChannelApp(ucMetadataTraceId, channel.id, JOIN_AND_BROADCAST_WITH_TRACE_ID);
       await resolveExecutionCompleteListener;
 
@@ -126,6 +134,7 @@ export default async () => {
 
       const channel = await cc.getNonGlobalUserChannel();
       await cc.joinChannel(channel);
+      mockAppOpened = true;
       await cc.openChannelApp(ucMetadataSignatureCustom, channel.id, JOIN_AND_BROADCAST_WITH_SIGNATURE_CUSTOM);
       await resolveExecutionCompleteListener;
 
@@ -164,6 +173,7 @@ export default async () => {
         }
       );
 
+      mockAppOpened = true;
       await cc.openChannelApp(acMetadataBroadcast, 'test-channel', APP_CHANNEL_AND_BROADCAST);
       await resolveExecutionCompleteListener;
 
@@ -189,6 +199,7 @@ export default async () => {
       const resolveExecutionCompleteListener = cc.initCompleteListener(acGetCurrentContextWithMetadata);
       const testChannel = await fdc3.getOrCreateChannel('test-channel');
 
+      mockAppOpened = true;
       await cc.openChannelApp(acGetCurrentContextWithMetadata, 'test-channel', APP_CHANNEL_AND_BROADCAST);
       await resolveExecutionCompleteListener;
 

toolbox/fdc3-conformance/src/test/basic/fdc3.basic.ts

@@ -70,7 +70,6 @@ const basicIL1 = (fdc3: DesktopAgent, documentation: string) => {
 };
 
 const basicGI1 = (fdc3: DesktopAgent, documentation: string) => {
-  console.log('coming here in');
   it('(BasicGI1) Returns ImplementationMetadata object', async () => {
     try {
       const info = await fdc3.getInfo();

toolbox/fdc3-conformance/src/test/fdc3-conformance-utils.ts

@@ -1,4 +1,4 @@
-import { Channel, Context, DesktopAgent } from '@finos/fdc3';
+import { Channel, Context, DesktopAgent, Listener } from '@finos/fdc3';
 import { AppControlContext, AppControlContextListener } from '../context-types';
 import constants from '../constants';
 import { wait } from '../utils';
@@ -7,9 +7,18 @@ declare let fdc3: DesktopAgent;
 
 export async function closeMockAppWindow(testId: string, count: number = 1) {
   const appControlChannel = await fdc3.getOrCreateChannel(constants.ControlChannel);
-  const { listenerPromise: contextPromise } = await waitForContext('windowClosed', testId, appControlChannel, count);
+  const { listenerPromise: contextPromise, listener } = await waitForContext(
+    'windowClosed',
+    testId,
+    appControlChannel,
+    count
+  );
   await broadcastCloseWindow(testId);
-  await contextPromise;
+  try {
+    await contextPromise;
+  } finally {
+    listener.unsubscribe();
+  }
   await wait(constants.WindowCloseWaitTime); // wait for window to close
 }
 
@@ -26,7 +35,7 @@ export const waitForContext = async (
   testId: string,
   channel: Channel,
   count = 1
-): Promise<AppControlContextListener> => {
+): Promise<AppControlContextListener & { listener: Listener }> => {
   let promiseResolve: (c: Context) => void;
   let promiseReject: (x: unknown) => void;
 
@@ -41,23 +50,22 @@ export const waitForContext = async (
     }
   }, 1000);
 
-  return channel
-    .addContextListener(contextType, ctx => {
-      if (ctx['testId'] == testId) {
-        console.log(`Received ${contextType}`);
-        count--;
-        if (count == 0) {
-          promiseResolve(ctx);
-        } else {
-          console.log(`Waiting for ${count} more ${contextType}`);
-        }
+  const listener = await channel.addContextListener(contextType, ctx => {
+    if (ctx['testId'] == testId) {
+      console.log(`Received ${contextType}`);
+      count--;
+      if (count == 0) {
+        promiseResolve(ctx);
       } else {
-        console.log(`Wrong test id expected:  ${testId} got: ${ctx['testId']}`);
+        console.log(`Waiting for ${count} more ${contextType}`);
       }
-    })
-    .then(() => {
-      return {
-        listenerPromise,
-      };
-    });
+    } else {
+      console.log(`Wrong test id expected:  ${testId} got: ${ctx['testId']}`);
+    }
+  });
+
+  return {
+    listenerPromise,
+    listener,
+  };
 };

toolbox/fdc3-conformance/src/test/support/channels-support.ts

@@ -53,12 +53,12 @@ export class ChannelControlImpl implements ChannelControl {
   };
 
   initCompleteListener = async (testId: string) => {
-    const { listenerPromise } = await waitForContext(
+    const { listenerPromise, listener } = await waitForContext(
       'executionComplete',
       testId,
       await this.fdc3.getOrCreateChannel(constants.ControlChannel)
     );
-    return listenerPromise;
+    return listenerPromise.finally(() => listener.unsubscribe());
   };
 
   openChannelApp = async (