implement addIntentWithContextListener

Author: Roaders

CHANGELOG.md

@@ -66,6 +66,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   - resolves ([#1487](https://github.com/finos/FDC3/issues/1487))
   - resolves ([#1488](https://github.com/finos/FDC3/issues/1488))
 * Adjusted reference Desktop Agent implementation for FDC3 for Web to open a new app instance when raiseIntent is called with an appId but no instanceId ([#1556](https://github.com/finos/FDC3/pull/1556))
+* Added `addIntentWithContextListener` to `DesktopAgent` and implemented in `DesktopAgentProxy`
 
 ### Changed
 

packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts

@@ -66,6 +66,7 @@ export class DesktopAgentProxy implements DesktopAgent, Connectable {
     this.findIntentsByContext = this.findIntentsByContext.bind(this);
     this.raiseIntent = this.raiseIntent.bind(this);
     this.addIntentListener = this.addIntentListener.bind(this);
+    this.addIntentListenerWithContext = this.addIntentListenerWithContext.bind(this);
     this.raiseIntentForContext = this.raiseIntentForContext.bind(this);
     this.open = this.open.bind(this);
     this.findInstances = this.findInstances.bind(this);
@@ -183,6 +184,10 @@ export class DesktopAgentProxy implements DesktopAgent, Connectable {
     return this.intents.addIntentListener(intent, handler);
   }
 
+  addIntentListenerWithContext(intent: string, contextType: string | string[], handler: IntentHandler) {
+    return this.intents.addIntentListenerWithContext(intent, contextType, handler);
+  }
+
   raiseIntentForContext(context: Context, app?: string | AppIdentifier): Promise<IntentResolution> {
     return this.intents.raiseIntentForContext(context, this.ensureAppId(app));
   }

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

@@ -217,7 +217,23 @@ export class DefaultIntentSupport implements IntentSupport {
   }
 
   async addIntentListener(intent: string, handler: IntentHandler): Promise<Listener> {
-    const out = new DefaultIntentListener(this.messaging, intent, handler, this.messageExchangeTimeout);
+    const out = new DefaultIntentListener(this.messaging, intent, undefined, handler, this.messageExchangeTimeout);
+    await out.register();
+    return out;
+  }
+
+  async addIntentListenerWithContext(
+    intent: string,
+    contextType: string | string[],
+    handler: IntentHandler
+  ): Promise<Listener> {
+    const out = new DefaultIntentListener(
+      this.messaging,
+      intent,
+      Array.isArray(contextType) ? contextType : [contextType],
+      handler,
+      this.messageExchangeTimeout
+    );
     await out.register();
     return out;
   }

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

@@ -7,4 +7,9 @@ export interface IntentSupport {
   raiseIntent(intent: string, context: Context, app?: AppIdentifier): Promise<IntentResolution>;
   raiseIntentForContext(context: Context, app?: AppIdentifier): Promise<IntentResolution>;
   addIntentListener(intent: string, handler: IntentHandler): Promise<Listener>;
+  addIntentListenerWithContext(
+    intent: string,
+    contextType: string | string[],
+    handler: IntentHandler
+  ): Promise<Listener>;
 }

packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts

@@ -7,28 +7,34 @@ import {
   IntentEvent,
   IntentResultRequest,
   IntentResultResponse,
-  //RaiseIntentResponse,
 } from '@finos/fdc3-schema/dist/generated/api/BrowserTypes';
 
 export class DefaultIntentListener extends AbstractListener<IntentHandler, AddIntentListenerRequest> {
-  readonly intent: string;
-
-  constructor(messaging: Messaging, intent: string, action: IntentHandler, messageExchangeTimeout: number) {
+  constructor(
+    messaging: Messaging,
+    private readonly intent: string,
+    private readonly contextTypes: string[] | undefined,
+    action: IntentHandler,
+    messageExchangeTimeout: number
+  ) {
     super(
       messaging,
       messageExchangeTimeout,
-      { intent },
+      { intent, contextTypes },
       action,
       'addIntentListenerRequest',
       'addIntentListenerResponse',
       'intentListenerUnsubscribeRequest',
       'intentListenerUnsubscribeResponse'
     );
-    this.intent = intent;
   }
 
   filter(m: IntentEvent): boolean {
-    return m.type == 'intentEvent' && m.payload.intent == this.intent;
+    return (
+      m.type == 'intentEvent' &&
+      m.payload.intent == this.intent &&
+      (this.contextTypes == null || this.contextTypes.includes(m.payload.context.type))
+    );
   }
 
   action(m: IntentEvent): void {

packages/fdc3-get-agent/test/step-definitions/desktop-agent.steps.ts

@@ -223,6 +223,7 @@ Given('A Dummy Desktop Agent in {string}', async function (this: CustomWorld, fi
     raiseIntent: notImplemented,
     raiseIntentForContext: notImplemented,
     addIntentListener: notImplemented,
+    addIntentListenerWithContext: notImplemented,
     addContextListener: notImplemented,
     addEventListener: notImplemented,
     getUserChannels: notImplemented,

packages/fdc3-schema/generated/api/BrowserTypes.ts

@@ -405,6 +405,10 @@ export interface AddIntentListenerRequest {
  * The message payload typically contains the arguments to FDC3 API functions.
  */
 export interface AddIntentListenerRequestPayload {
+  /**
+   * The types of context to listen for.
+   */
+  contextTypes?: string[];
   /**
    * The name of the intent to listen for.
    */
@@ -4856,7 +4860,13 @@ const typeMap: any = {
     ],
     false
   ),
-  AddIntentListenerRequestPayload: o([{ json: 'intent', js: 'intent', typ: '' }], false),
+  AddIntentListenerRequestPayload: o(
+    [
+      { json: 'contextTypes', js: 'contextTypes', typ: u(undefined, a('')) },
+      { json: 'intent', js: 'intent', typ: '' },
+    ],
+    false
+  ),
   AddIntentListenerResponse: o(
     [
       { json: 'meta', js: 'meta', typ: r('AddContextListenerResponseMeta') },

packages/fdc3-schema/schemas/api/addIntentListenerRequest.schema.json

@@ -1,46 +1,54 @@
 {
-	"$schema": "http://json-schema.org/draft-07/schema#",
-	"$id": "https://fdc3.finos.org/schemas/next/api/addIntentListenerRequest.schema.json",
-	"type": "object",
-	"title": "AddIntentListener Request",
-	"description": "A request to add an Intent listener for a specified intent type.",
-	"allOf": [
-		{
-			"$ref": "appRequest.schema.json"
-		},
-		{
-			"type": "object",
-			"properties": {
-				"type": {
-					"$ref": "#/$defs/AddIntentListenerRequestType"
-				},
-				"payload": {
-					"$ref": "#/$defs/AddIntentListenerRequestPayload"
-				},
-				"meta": true
-			},
-			"additionalProperties": false
-		}
-	],
-	"$defs": {
-		"AddIntentListenerRequestType": {
-			"title": "AddIntentListener Request Message Type",
-			"const": "addIntentListenerRequest"
-		},
-		"AddIntentListenerRequestPayload": {
-			"title": "AddIntentListener Request Payload",
-			"type": "object",
-			"properties": {
-				"intent": {
-					"title": "Intent name",
-					"description": "The name of the intent to listen for.",
-					"type": "string"
-				}
-			},
-			"additionalProperties": false,
-			"required": [
-				"intent"
-			]
-		}
-	}
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://fdc3.finos.org/schemas/next/api/addIntentListenerRequest.schema.json",
+    "type": "object",
+    "title": "AddIntentListener Request",
+    "description": "A request to add an Intent listener for a specified intent type.",
+    "allOf": [
+        {
+            "$ref": "appRequest.schema.json"
+        },
+        {
+            "type": "object",
+            "properties": {
+                "type": {
+                    "$ref": "#/$defs/AddIntentListenerRequestType"
+                },
+                "payload": {
+                    "$ref": "#/$defs/AddIntentListenerRequestPayload"
+                },
+                "meta": true
+            },
+            "additionalProperties": false
+        }
+    ],
+    "$defs": {
+        "AddIntentListenerRequestType": {
+            "title": "AddIntentListener Request Message Type",
+            "const": "addIntentListenerRequest"
+        },
+        "AddIntentListenerRequestPayload": {
+            "title": "AddIntentListener Request Payload",
+            "type": "object",
+            "properties": {
+                "intent": {
+                    "title": "Intent name",
+                    "description": "The name of the intent to listen for.",
+                    "type": "string"
+                },
+                "contextTypes": {
+                    "title": "Context types",
+                    "description": "The types of context to listen for.",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "intent"
+            ]
+        }
+    }
 }

packages/fdc3-standard/src/api/DesktopAgent.ts

@@ -353,6 +353,22 @@ export interface DesktopAgent {
    */
   addIntentListener(intent: Intent, handler: IntentHandler): Promise<Listener>;
 
+  /**
+   * Adds a listener for incoming intents raised by other applications, via calls to `fdc3.raiseIntent` or `fdc3.raiseIntentForContext, but filters intents for one or more context types. See `addIntentListener` for details and restrictions for both usage and implementation.
+   *
+   * //Handle a raised intent
+   * const listener = fdc3.addIntentListenerWithContext('StartChat', 'fdc3.contact', context => {
+   *     // start chat has been requested by another application
+   *     return;
+   * });
+   */
+
+  addIntentListenerWithContext(
+    intent: Intent,
+    contextType: string | string[],
+    handler: IntentHandler
+  ): Promise<Listener>;
+
   /**
    * Adds a listener for incoming context broadcasts from the Desktop Agent (via a User channel or `fdc3.open`API call. If the consumer is only interested in a context of a particular type, they can they can specify that type. If the consumer is able to receive context of any type or will inspect types received, then they can pass `null` as the `contextType` parameter to receive all context types.
    *

toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts

@@ -28,6 +28,7 @@ type ListenerRegistration = {
   appId: string;
   instanceId: string;
   intentName: string;
+  contextTypes?: string[];
   listenerUUID: string;
 };
 
@@ -114,6 +115,7 @@ class PendingIntent {
     if (
       arg0.appId == this.appId.appId &&
       arg0.intentName == this.r.intent &&
+      (arg0.contextTypes == undefined || arg0.contextTypes.includes(this.r.context.type)) &&
       (arg0.instanceId == this.appId.instanceId || this.appId.instanceId == undefined)
     ) {
       this.complete = true;
@@ -248,6 +250,7 @@ export class IntentHandler implements MessageHandler {
       appId: from.appId,
       instanceId: from.instanceId,
       intentName: arg0.payload.intent,
+      contextTypes: arg0.payload.contextTypes,
       listenerUUID: sc.createUUID(),
     };
 
@@ -377,7 +380,11 @@ export class IntentHandler implements MessageHandler {
   async raiseIntentToAnyApp(arg0: IntentRequest[], sc: ServerContext<AppRegistration>): Promise<void> {
     const connectedApps = await sc.getConnectedApps();
     const matchingIntents = arg0.flatMap(i => this.directory.retrieveIntents(i.context.type, i.intent, undefined));
-    const matchingRegistrations = arg0.flatMap(i => this.registrations.filter(r => r.intentName == i.intent));
+    const matchingRegistrations = arg0.flatMap(i =>
+      this.registrations.filter(
+        r => r.intentName == i.intent && (r.contextTypes == null || r.contextTypes.includes(i.context.type))
+      )
+    ); // Get a list of intent listeners that match the intent and context type
     const uniqueIntentNames = [
       ...matchingIntents.map(i => i.intentName),
       ...matchingRegistrations.map(r => r.intentName),