Correcting issues agent-proxy tests after rebase on main post 2.2.2 release

kriswest · kriswest · commit 449db1ba0d9e · 2026-04-23T17:01:44.000+01:00
diff --git a/packages/fdc3-agent-proxy/test/features/app-channels.feature b/packages/fdc3-agent-proxy/test/features/app-channels.feature
@@ -115,7 +115,7 @@ Feature: Channel Listeners Support
       | id.ticker | type            | name  |
       | AAPL      | fdc3.instrument | Apple |
 
-  Scenario: App channel context listener receives originating app metadata
+  Scenario: App channel context listener receives source metadata
     Given "resultHandler" pipes context and metadata to "contexts" and "metadatas"
     When I call "{api1}" with "getOrCreateChannel" with parameter "channel-name"
     And I refer to "{result}" as "channel1"
@@ -126,4 +126,4 @@ Feature: Channel Listeners Support
       | AAPL      | fdc3.instrument | Apple |
     And "{metadatas}" is an array of objects with the following contents
       | source.appId      | source.instanceId     |
-      | broadcasting-app   | broadcasting-instance |
+      | cucumber-app   | cucumber-instance |
diff --git a/packages/fdc3-agent-proxy/test/features/broadcast.feature b/packages/fdc3-agent-proxy/test/features/broadcast.feature
@@ -30,7 +30,7 @@ Feature: Broadcasting
       | {null}            | {null}               | {null}               | getUserChannelsRequest   |
       | one               | fdc3.instrument      | Apple                | broadcastRequest         |
 
-  Scenario: Context listener receives originating app metadata
+  Scenario: Context listener receives source metadata
     Given "resultHandler" pipes context and metadata to "contexts" and "metadatas"
     When I call "{api}" with "getOrCreateChannel" with parameter "channel-name"
     And I refer to "{result}" as "channel1"
@@ -41,4 +41,4 @@ Feature: Broadcasting
       | AAPL      | fdc3.instrument | Apple |
     And "{metadatas}" is an array of objects with the following contents
       | source.appId      | source.instanceId     |
-      | broadcasting-app   | broadcasting-instance |
+      | cucumber-app   | cucumber-instance |
diff --git a/packages/fdc3-agent-proxy/test/features/private-channels.feature b/packages/fdc3-agent-proxy/test/features/private-channels.feature
@@ -26,7 +26,7 @@ Feature: Basic Private Channels Support
       | id.ticker | type            | name  |
       | AAPL      | fdc3.instrument | Apple |
 
-  Scenario: Private channel context listener receives originating app metadata
+  Scenario: Private channel context listener receives source metadata
     Given "resultHandler" pipes context and metadata to "contexts" and "metadatas"
     When I call "{privateChannel}" with "addContextListener" with parameters "fdc3.instrument" and "{resultHandler}"
     And messaging receives "{instrumentMessageOne}"
@@ -35,7 +35,7 @@ Feature: Basic Private Channels Support
       | AAPL      | fdc3.instrument | Apple |
     And "{metadatas}" is an array of objects with the following contents
       | source.appId      | source.instanceId     |
-      | broadcasting-app   | broadcasting-instance |
+      | cucumber-app   | cucumber-instance |
 
   Scenario: Adding and then unsubscribing an "onAddContextListener" listener will send a notification of each event to the agent
     Given "typesHandler" pipes events to "types"
diff --git a/packages/fdc3-agent-proxy/test/features/user-channels.feature b/packages/fdc3-agent-proxy/test/features/user-channels.feature
@@ -332,7 +332,7 @@ Feature: Basic User Channels Support
       | payload.channelId | payload.contextType | matches_type              |
       | {null}            | fdc3.instrument     | addContextListenerRequest |
 
-  Scenario: User channel context listener receives originating app metadata
+  Scenario: User channel context listener receives source metadata
     Given "resultHandler" pipes context and metadata to "contexts" and "metadatas"
     When I call "{api}" with "joinUserChannel" with parameter "one"
     And I call "{api}" with "addContextListener" with parameters "fdc3.instrument" and "{resultHandler}"
@@ -342,4 +342,4 @@ Feature: Basic User Channels Support
       | AAPL      | fdc3.instrument | Apple |
     And "{metadatas}" is an array of objects with the following contents
       | source.appId      | source.instanceId     |
-      | broadcasting-app   | broadcasting-instance |
+      | cucumber-app   | cucumber-instance |
diff --git a/packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts b/packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts
@@ -58,7 +58,7 @@ export class PostMessageLoader implements Loader {
   identityValidationHandler?: IdentityValidationHandler;
 
   /** Initial timeout (released once a MessagePort is received - additional steps are outside timeout) */
-  timeout: NodeJS.Timeout | null = null;
+  timeout: ReturnType<typeof setTimeout> | null = null;
 
   /** Reference to the get fn's Promise's reject call - used when cancelling. */
   rejectFn: ((reason?: string) => void) | null = null;
diff --git a/packages/fdc3-schema/generated/api/BrowserTypes.ts b/packages/fdc3-schema/generated/api/BrowserTypes.ts
@@ -544,11 +544,6 @@ export interface OptionalFeatures {
    * feature is implemented by the Desktop Agent.
    */
   DesktopAgentBridging: boolean;
-  /**
-   * Used to indicate whether the exposure of 'originating app metadata' for
-   * context and intent messages is supported by the Desktop Agent.
-   */
-  OriginatingAppMetadata: boolean;
   /**
    * Used to indicate whether the optional `fdc3.joinUserChannel`,
    * `fdc3.getCurrentChannel` and `fdc3.leaveCurrentChannel` are implemented by
@@ -689,12 +684,10 @@ export interface AddContextListenerRequestMeta {
  * Field that represents the source application that the request being responded to was
  * received from, for debugging purposes.
  *
- * Details of the application instance that broadcast the context.
+ * Identifier for the app instance that sent the context and/or intent.
  *
  * The App resolution option chosen.
  *
- * Details of the application instance that raised the intent.
- *
  * Identifier for the app instance that was selected (or started) to resolve the intent.
  * `source.instanceId` MUST be set, indicating the specific app instance that
  * received the intent.
@@ -1192,10 +1185,7 @@ export interface BroadcastEventPayload {
    * The context object that was broadcast.
    */
   context: Context;
-  /**
-   * Details of the application instance that broadcast the context.
-   */
-  originatingApp?: AppIdentifier;
+  metadata: ContextMetadata;
 }
 
 /**
@@ -1262,6 +1252,34 @@ export interface Context {
   [property: string]: any;
 }
 
+/**
+ * Metadata relating to a broadcastEvent or intentEvent, which may include metadata provided
+ * by the Desktop Agent or the App that initiated the broadcast, raise intent or open
+ * request.
+ */
+export interface ContextMetadata {
+  /**
+   * Custom metadata that can be used to provide additional information about the context or
+   * intent. This allows for individuals to use metadata fields that have yet to be
+   * standardized.
+   */
+  custom?: { [key: string]: any };
+  /**
+   * Identifier for the app instance that sent the context and/or intent.
+   */
+  source: AppIdentifier;
+  /**
+   * The timestamp when the context or intent was created, encoded according to [ISO
+   * 8601-1:2019](https://www.iso.org/standard/70907.html) with a timezone indicator.
+   */
+  timestamp: Date;
+  /**
+   * A unique identifier for the context or intent that can be used to trace the context or
+   * intent through the system.
+   */
+  traceId: string;
+}
+
 /**
  * Identifies the type of the message and it is typically set to the FDC3 function name that
  * the message relates to, e.g. 'findIntent', with 'Response' appended.
@@ -1300,6 +1318,16 @@ export interface BroadcastRequestPayload {
    * The context object that is to be broadcast.
    */
   context: Context;
+  metadata: AppProvidableContextMetadata;
+}
+
+/**
+ * Metadata that can be provided by an app as part of a broadcast, raise intent or open API
+ * call.
+ */
+export interface AppProvidableContextMetadata {
+  custom?: { [key: string]: any };
+  traceId?: string;
 }
 
 /**
@@ -3032,10 +3060,7 @@ export interface IntentEventPayload {
    * The intent that was raised.
    */
   intent: string;
-  /**
-   * Details of the application instance that raised the intent.
-   */
-  originatingApp?: AppIdentifier;
+  metadata: ContextMetadata;
   /**
    * The requestUuid value of the raiseIntentRequest that the intentEvent being sent relates
    * to.
@@ -3366,6 +3391,7 @@ export interface OpenRequestPayload {
    * target app with no context and broadcasting the context directly to it.
    */
   context?: Context;
+  metadata: AppProvidableContextMetadata;
 }
 
 /**
@@ -3804,6 +3830,7 @@ export interface RaiseIntentForContextRequest {
 export interface RaiseIntentForContextRequestPayload {
   app?: AppIdentifier;
   context: Context;
+  metadata: AppProvidableContextMetadata;
 }
 
 /**
@@ -3944,15 +3971,7 @@ export interface RaiseIntentRequestPayload {
   app?: AppIdentifier;
   context: Context;
   intent: string;
-}
-
-/**
- * Metadata that can be provided by an app.
- */
-export interface AppProvidableContextMetadata {
-  hostParams?: { [key: string]: any };
-  signature?: string;
-  traceId?: string;
+  metadata: AppProvidableContextMetadata;
 }
 
 /**
@@ -5070,7 +5089,6 @@ const typeMap: any = {
   OptionalFeatures: o(
     [
       { json: 'DesktopAgentBridging', js: 'DesktopAgentBridging', typ: true },
-      { json: 'OriginatingAppMetadata', js: 'OriginatingAppMetadata', typ: true },
       { json: 'UserChannelMembershipAPIs', js: 'UserChannelMembershipAPIs', typ: true },
     ],
     false
@@ -5272,7 +5290,7 @@ const typeMap: any = {
     [
       { json: 'channelId', js: 'channelId', typ: u(null, '') },
       { json: 'context', js: 'context', typ: r('Context') },
-      { json: 'originatingApp', js: 'originatingApp', typ: u(undefined, r('AppIdentifier')) },
+      { json: 'metadata', js: 'metadata', typ: r('ContextMetadata') },
     ],
     false
   ),
@@ -5284,6 +5302,15 @@ const typeMap: any = {
     ],
     'any'
   ),
+  ContextMetadata: o(
+    [
+      { json: 'custom', js: 'custom', typ: u(undefined, m('any')) },
+      { json: 'source', js: 'source', typ: r('AppIdentifier') },
+      { json: 'timestamp', js: 'timestamp', typ: Date },
+      { json: 'traceId', js: 'traceId', typ: '' },
+    ],
+    false
+  ),
   BroadcastRequest: o(
     [
       { json: 'meta', js: 'meta', typ: r('AddContextListenerRequestMeta') },
@@ -5296,6 +5323,14 @@ const typeMap: any = {
     [
       { json: 'channelId', js: 'channelId', typ: '' },
       { json: 'context', js: 'context', typ: r('Context') },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
+    ],
+    false
+  ),
+  AppProvidableContextMetadata: o(
+    [
+      { json: 'custom', js: 'custom', typ: u(undefined, m('any')) },
+      { json: 'traceId', js: 'traceId', typ: u(undefined, '') },
     ],
     false
   ),
@@ -5850,7 +5885,7 @@ const typeMap: any = {
     [
       { json: 'context', js: 'context', typ: r('Context') },
       { json: 'intent', js: 'intent', typ: '' },
-      { json: 'originatingApp', js: 'originatingApp', typ: u(undefined, r('AppIdentifier')) },
+      { json: 'metadata', js: 'metadata', typ: r('ContextMetadata') },
       { json: 'raiseIntentRequestUuid', js: 'raiseIntentRequestUuid', typ: '' },
     ],
     false
@@ -5951,6 +5986,7 @@ const typeMap: any = {
     [
       { json: 'app', js: 'app', typ: r('AppIdentifier') },
       { json: 'context', js: 'context', typ: u(undefined, r('Context')) },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
     ],
     false
   ),
@@ -6091,6 +6127,7 @@ const typeMap: any = {
     [
       { json: 'app', js: 'app', typ: u(undefined, r('AppIdentifier')) },
       { json: 'context', js: 'context', typ: r('Context') },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
     ],
     false
   ),
@@ -6130,14 +6167,7 @@ const typeMap: any = {
       { json: 'app', js: 'app', typ: u(undefined, r('AppIdentifier')) },
       { json: 'context', js: 'context', typ: r('Context') },
       { json: 'intent', js: 'intent', typ: '' },
-    ],
-    false
-  ),
-  AppProvidableContextMetadata: o(
-    [
-      { json: 'hostParams', js: 'hostParams', typ: u(undefined, m('any')) },
-      { json: 'signature', js: 'signature', typ: u(undefined, '') },
-      { json: 'traceId', js: 'traceId', typ: u(undefined, '') },
+      { json: 'metadata', js: 'metadata', typ: r('AppProvidableContextMetadata') },
     ],
     false
   ),
@@ -6426,6 +6456,7 @@ const typeMap: any = {
   RaiseIntentResponseType: ['raiseIntentResponse'],
   RaiseIntentResultResponseType: ['raiseIntentResultResponse'],
 };
+
 export type AppRequestMessage =
   | AddContextListenerRequest
   | AddEventListenerRequest
diff --git a/website/docs/api/spec.md b/website/docs/api/spec.md
@@ -877,23 +877,23 @@ For the rationale for separating `Context` and `ContextMetadata`, see the [Conte
 
 Registered listeners MUST receive:
 
-*   `timestamp` – Indicates when the message was delivered.
-*   `source` – Identifies the originating app (`AppIdentifier`).
+- `timestamp` – Indicates when the message was delivered.
+- `source` – Identifies the originating app (`AppIdentifier`).
 
 Registered listeners MAY receive:
 
-*   `traceId` – A unique identifier for tracing the flow of context or intent messages across applications.
-*   `signature` – A cryptographic signature that can be used to verify the authenticity and integrity of the context or intent message.
-*   `custom` – Implementation-specific metadata.
+- `traceId` – A unique identifier for tracing the flow of context or intent messages across applications.
+- `signature` – A cryptographic signature that can be used to verify the authenticity and integrity of the context or intent message.
+- `custom` – Implementation-specific metadata.
 
 <!-- TODO insert security/signature field names here -->
 
 ### Trace Information
 
 The Desktop Agent MAY provide a `traceId` to intent handlers.
 
-*   If the originating app provides a `traceId`, the Desktop Agent MUST forward it.
-*   If no `traceId` is provided by the app, the Desktop Agent MAY generate a new one.
+- If the originating app provides a `traceId`, the Desktop Agent MUST forward it.
+- If no `traceId` is provided by the app, the Desktop Agent MAY generate a new one.
 
 Apps MAY propagate `traceId` when performing actions as a result of another FDC3 action. This supports observability and correlation across workflows.
 
