Merge pull request #1767 from finos/conformance-qualified-ids

Support fully qualified app ids to be returned by desktop agent and not fail conformance tests

Author: kriswest

CHANGELOG.md

@@ -42,6 +42,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Updated .NET API documentation for IListener.Unsubscribe to be async for 2.2 and current. ([#1690](https://github.com/finos/FDC3/pull/1690))
 * Fix for channel change listeners not sending addEventListenerRequests ([#1606](https://github.com/finos/FDC3/pull/1606))
 * Fix to ensure that Adding A Channel Change Event Listener Doesn't Send addEventListenerRequest - Conformance 2.2 ([#1606](https://github.com/finos/FDC3/pull/1606))
+* Updated Conformance tests to allow agents that fully qualify app Ids (as recommended in the Standard) to pass the conformance tests ([#1767](https://github.com/finos/FDC3/pull/1767))
 
 ## [FDC3 Standard 2.2](https://github.com/finos/FDC3/compare/v2.1..v2.2) - 2025-03-12
 

toolbox/fdc3-conformance/src/mock/general.ts

@@ -1,6 +1,7 @@
 import { closeWindowOnCompletion, sendContextToTests } from './mock-functions';
 import { getAgent, Context } from '@finos/fdc3';
 import { AppControlContext } from '../context-types';
+import { appIdMatches } from '../utils';
 
 getAgent().then(async fdc3 => {
   await closeWindowOnCompletion(fdc3);
@@ -13,7 +14,7 @@ getAgent().then(async fdc3 => {
     type: 'fdc3-conformance-opened',
   };
 
-  if (appId !== 'MockAppId') {
+  if (!appIdMatches(appId, 'MockAppId')) {
     appOpenedContext.errorMessage = `Incorrect appId retrieved from getInfo(). Expected MockAppId, got ${appId}`;
   }
 

toolbox/fdc3-conformance/src/test/advanced/fdc3.findIntent.ts

@@ -2,6 +2,7 @@ import { AppIntent, IntentMetadata, ResolveError, DesktopAgent } from '@finos/fd
 import { assert, expect } from 'chai';
 import { APIDocumentation } from '../support/apiDocuments';
 import { ContextType, IntentApp, Intent } from '../support/intent-support';
+import { appIdMatches } from '../../utils';
 
 declare let fdc3: DesktopAgent;
 const findIntentDocs = '\r\nDocumentation: ' + APIDocumentation.findIntent + '\r\nCause';
@@ -163,6 +164,10 @@ function validateAppIntent(
     expect(
       appIntent.apps[index],
       `AppIntent.apps[${index}] did not have expected property 'appId' ${findIntentDocs}`
-    ).to.have.property('appId', appId);
+    ).to.have.property('appId');
+    expect(
+      appIdMatches(appIntent.apps[index].appId, appId),
+      `AppIntent.apps[${index}].appId '${appIntent.apps[index].appId}' did not match expected '${appId}' ${findIntentDocs}`
+    ).to.be.true;
   });
 }

toolbox/fdc3-conformance/src/test/advanced/fdc3.findIntentsByContext.ts

@@ -3,7 +3,7 @@ import { assert, expect } from 'chai';
 import { APIDocumentation } from '../support/apiDocuments';
 import { DesktopAgent } from '@finos/fdc3';
 import { ContextType, IntentApp, Intent } from '../support/intent-support';
-import { handleFail } from '../../utils';
+import { appIdMatches, handleFail } from '../../utils';
 
 declare let fdc3: DesktopAgent;
 const findIntentsByContextDocs = '\r\nDocumentation: ' + APIDocumentation.findIntentsByContext;
@@ -59,7 +59,10 @@ function validateIntents(
   assert.isDefined(firstIntent);
   if (firstIntent !== undefined) {
     expect(firstIntent.apps).to.have.length(expectedAppCount);
-    const sharedAppNames = firstIntent.apps.map(app => app.appId);
-    expect(sharedAppNames).to.have.all.members(expectedAppIds);
+    const sharedAppIds = firstIntent.apps.map(app => app.appId);
+    const missingAppIds = expectedAppIds.filter(
+      expected => !sharedAppIds.some(received => appIdMatches(received, expected))
+    );
+    expect(missingAppIds, `Expected app IDs not found in [${sharedAppIds.join(', ')}]`).to.be.empty;
   }
 }

toolbox/fdc3-conformance/src/test/advanced/fdc3.open.ts

@@ -5,6 +5,7 @@ import { OpenControlImpl } from '../support/open-support';
 import { DesktopAgent, getAgent } from '@finos/fdc3';
 import { assert, expect } from 'chai';
 import { ControlContextType } from '../support/intent-support';
+import { appIdMatches } from '../../utils';
 
 const documentation = '\r\nDocumentation: ' + APIDocumentation + '\r\nCause:';
 
@@ -99,7 +100,7 @@ export default async () => {
       const result = control.contextReceiver('fdc3-conformance-opened');
       const targetApp = { appId: openApp.b.id };
       const instanceIdentifier = await control.openMockApp(targetApp);
-      expect(instanceIdentifier.appId).to.eq(openApp.b.id);
+      expect(appIdMatches(instanceIdentifier.appId, openApp.b.id)).to.be.true;
       expect(instanceIdentifier).to.have.property('instanceId');
       await result;
       await control.closeMockApp(AOpensB4);

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

@@ -12,7 +12,7 @@ import {
 } from '@finos/fdc3';
 import { APIDocumentation } from './apiDocuments';
 import constants from '../../constants';
-import { handleFail, wait, wrapPromise } from '../../utils';
+import { appIdMatches, handleFail, wait, wrapPromise } from '../../utils';
 import { AppControlContext, IntentUtilityContext } from '../../context-types';
 
 const raiseIntentDocs = '\r\nDocumentation: ' + APIDocumentation.raiseIntent + '\r\nCause';
@@ -194,7 +194,7 @@ export class RaiseIntentControl {
       expect(intentResolution.source as AppIdentifier).to.have.property('instanceId');
       expect(typeof intentResolution.source.instanceId).to.be.equal('string');
       expect(intentResolution.source.instanceId).to.not.be.equal('');
-      expect((intentResolution.source as AppIdentifier).appId).to.eq(appId, raiseIntentDocs);
+      expect(appIdMatches(intentResolution.source.appId, appId), raiseIntentDocs).to.be.true;
     } else assert.fail('Invalid intent resolution object');
   };
 

toolbox/fdc3-conformance/src/utils.ts

@@ -41,3 +41,16 @@ export function handleFail(documentation: string, ex: unknown): never {
   const message = ex instanceof Error ? ex.message : String(ex);
   assert.fail(documentation + message);
 }
+
+/**
+ * Checks whether a received appId matches an expected unqualified appId.
+ * Accepts either an exact match (e.g. 'MockAppId') or a fully qualified
+ * appId with the current hostname (e.g. 'MockAppId@localhost').
+ */
+export function appIdMatches(received: string, expected: string): boolean {
+  if (received === expected) {
+    return true;
+  }
+
+  return received.split('@')[0] === expected.split('@')[0];
+}