C2-25477: OpenFin - setContext in session context group (#2315)

In the OpenFin world, broadcasting a context in a session context group is different from broadcasting in a default context group.

The default context group way:
``` js
await openfin.joinContextGroup(id);
await openfin.setContext(context)
```

The session context group way:
```
const group = await openfin.joinSessionContextGroup(id);
await group.setContext(context)
```

Author: antoinerollindev

spec/mainApiHandler.spec.ts

@@ -20,6 +20,7 @@ jest.mock('../src/app/openfin-handler', () => {
     openfinHandler: {
       connect: jest.fn(),
       fireIntent: jest.fn(),
+      setContext: jest.fn(),
       joinContextGroup: jest.fn(),
       joinSessionContextGroup: jest.fn(),
       getContextGroups: jest.fn(),
@@ -749,5 +750,30 @@ describe('main api handler', () => {
 
       expect(spy).toHaveBeenCalledTimes(1);
     });
+
+    it('should call `setContext`', () => {
+      const spy = jest.spyOn(openfinHandler, 'setContext');
+      const value = {
+        cmd: apiCmds.openfinSetContext,
+        context: 'context',
+      };
+
+      ipcMain.send(apiName.symphonyApi, value);
+
+      expect(spy).toHaveBeenCalledWith('context', undefined);
+    });
+
+    it('should call `setContext` with session group id', () => {
+      const spy = jest.spyOn(openfinHandler, 'setContext');
+      const value = {
+        cmd: apiCmds.openfinSetContext,
+        context: 'context',
+        sessionContextGroupId: 'session-context-group-id',
+      };
+
+      ipcMain.send(apiName.symphonyApi, value);
+
+      expect(spy).toHaveBeenCalledWith('context', 'session-context-group-id');
+    });
   });
 });

spec/openfinHandler.spec.ts

@@ -10,6 +10,7 @@ jest.mock('@openfin/node-adapter', () => ({
     connectSync: jest.fn().mockReturnValue({
       onDisconnection: jest.fn(),
       fireIntent: jest.fn(),
+      setContext: jest.fn(),
       registerIntentHandler: jest.fn(),
       getAllClientsInContextGroup: jest.fn(),
       joinContextGroup: jest.fn(),
@@ -253,6 +254,52 @@ describe('Openfin', () => {
     expect(fireIntentForContextSpy).toHaveBeenCalledTimes(1);
   });
 
+  it('should set context in current context group', async () => {
+    const connectSyncMock = await connectMock.Interop.connectSync();
+    const setContextSpy = jest.spyOn(connectSyncMock, 'setContext');
+
+    await openfinHandler.connect();
+    const context = {
+      type: 'fdc3.contact',
+      name: 'Andy Young',
+      id: {
+        email: '[email protected]',
+      },
+    };
+    await openfinHandler.setContext(context);
+
+    expect(setContextSpy).toHaveBeenCalledTimes(1);
+  });
+
+  it('should set context in the provided session context group', async () => {
+    const connectSyncMock = await connectMock.Interop.connectSync();
+    const setContextSpy = jest.spyOn(connectSyncMock, 'setContext');
+
+    const sessionContextGroupId = 'sessionContextGroupId';
+    const sessionContextGroup = {
+      id: sessionContextGroupId,
+      setContext: jest.fn(),
+    };
+    jest
+      .spyOn(connectSyncMock, 'joinSessionContextGroup')
+      .mockResolvedValue(sessionContextGroup);
+
+    await openfinHandler.connect();
+    const context = {
+      type: 'fdc3.contact',
+      name: 'Andy Young',
+      id: {
+        email: '[email protected]',
+      },
+    };
+
+    await openfinHandler.joinSessionContextGroup(sessionContextGroupId);
+    await openfinHandler.setContext(context, sessionContextGroupId);
+
+    expect(setContextSpy).not.toHaveBeenCalled();
+    expect(sessionContextGroup.setContext).toHaveBeenCalledTimes(1);
+  });
+
   it('should remove from context group', async () => {
     const connectSyncMock = await connectMock.Interop.connectSync();
     const removeFromContextGroupSpy = jest.spyOn(

src/app/main-api-handler.ts

@@ -655,7 +655,10 @@ ipcMain.handle(
       case apiCmds.openfinRemoveFromContextGroup:
         return openfinHandler.removeFromContextGroup();
       case apiCmds.openfinSetContext:
-        return openfinHandler.setContext(arg.context);
+        return openfinHandler.setContext(
+          arg.context,
+          arg.sessionContextGroupId,
+        );
       default:
         break;
     }

src/app/openfin-handler.ts

@@ -12,6 +12,8 @@ const TIMEOUT_THRESHOLD = 10000;
 export class OpenfinHandler {
   private interopClient: OpenFin.InteropClient | undefined;
   private intentHandlerSubscriptions: Map<UUID, any> = new Map();
+  private sessionContextGroups: Map<string, OpenFin.SessionContextGroup> =
+    new Map();
   private isConnected: boolean = false;
   private fin: NodeFin | undefined;
 
@@ -135,7 +137,13 @@ export class OpenfinHandler {
   public async joinSessionContextGroup(contextGroupId: string) {
     return this.interopClient
       ?.joinSessionContextGroup(contextGroupId)
-      .then(({ id }) => id);
+      .then((sessionContextGroup) => {
+        this.sessionContextGroups.set(
+          sessionContextGroup.id,
+          sessionContextGroup,
+        );
+        return sessionContextGroup.id;
+      });
   }
 
   /**
@@ -169,6 +177,8 @@ export class OpenfinHandler {
       }
     });
     this.intentHandlerSubscriptions.clear();
+
+    this.sessionContextGroups.clear();
   }
 
   /**
@@ -205,10 +215,17 @@ export class OpenfinHandler {
   }
 
   /**
-   * Sets a context for the context group of the current entity.
+   * Sets a context for the current context group.
+   * If no session context group is specified, the context is set for the current context group (joined through joinContextGroup).
+   * If a session context group is specified, the context is set for the given session context group (joined through joinSessionContextGroup).
    * @param context
    */
-  public setContext(context: any) {
+  public setContext(context: any, sessionContextGroupId?: string) {
+    if (sessionContextGroupId) {
+      return this.sessionContextGroups
+        .get(sessionContextGroupId)
+        ?.setContext(context);
+    }
     return this.interopClient?.setContext(context);
   }
 

src/renderer/ssf-api.ts

@@ -1131,10 +1131,11 @@ export class SSFApi {
    * Sets a context for the context group of the current entity.
    * @param context
    */
-  public async openfinSetContext(context: any) {
+  public async openfinSetContext(context: any, sessionContextGroupId?: string) {
     const response = await local.ipcRenderer.invoke(apiName.symphonyApi, {
       cmd: apiCmds.openfinSetContext,
       context,
+      sessionContextGroupId,
     });
     return response;
   }