Server Context Refactor

CHANGELOG.md

@@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added Conformance tests for FDC3 2.2 ([#1586](https://github.com/finos/FDC3/pull/1586))
 * Fix for channel change listeners not sending addEventListenerRequests ([#1606](https://github.com/finos/FDC3/pull/1606))
 * When adding a listener on the current channel, the payload.channelId should be null ([#1611](https://github.com/finos/FDC3/pull/1611))
+* Refactoring of the `fdc3-web-impl` handlers to remove cyclic dependency and manage state in `FDC3ServerInstance`s.  ([#1696](https://github.com/finos/FDC3/pull/1696))
 
 ### Deprecated
 

README.md

@@ -86,16 +86,15 @@ This project (the FDC3 Standard repo) is now a monorepo containing the following
 | `packages/fdc3-schema`               | `@finos/fdc3-schema` (npm)                             | Contains the FDC3 For The Web and Desktop Agent Bridging protocol schemas.   Generates `BridgingTypes.ts` and `BrowserTypes.ts` versions of those schemas for consumption in typescript code.                          | n/a                   |
 | `packages/fdc3-context`              | `@finos/fdc3-context` (npm)                            | Contains the schemas for standard FDC3 context types.  Generates the `ContextTypes.ts` typescript version of the schema for consumption in typescript/javascript.                                                      | n/a                   |
 | `packages/fdc3-standard`             | `@finos/fdc3-standard` (npm)                           | Interface definitions for the FDC3 standard in typescript (e.g. the `DesktopAgent` interface) and the app directory schema.                                                                                            | Jest, embedded NYC    |
-| `packages/fdc3-agent-proxy`          | `@finos/fdc3-agent-proxy` (npm)                        | Contains a complete implementation of the FDC3 DACP.  Written in a platform-agnostic manner.                                                                                                                            | Cucumber, NYC         |
-| `packages/fdc3-get-agent`            | `@finos/fdc3-get-agent` (npm)                          | Implements the `getAgent` and `fdc3Ready()` functions as well as the FDC3 Web Connection protocol to allow FDC3 to work on the web or in an electron container.                                                     | Cucumber, NYC         |
+| `packages/fdc3-agent-proxy`          | `@finos/fdc3-agent-proxy` (npm)                        | Contains a complete implementation of the FDC3 DACP.  Written in a platform-agnostic manner.                                                                                                                           | Cucumber, NYC         |
+| `packages/fdc3-get-agent`            | `@finos/fdc3-get-agent` (npm)                          | Implements the `getAgent` and `fdc3Ready()` functions as well as the FDC3 Web Connection protocol to allow FDC3 to work on the web or in an electron container.                                                        | Cucumber, NYC         |
 | `packages/testing`                   | -not released-                                         | Contains testing tools used by the cucumber tests used within other modules of this project.                                                                                                                           |                       |
-| `toolbox/fdc3-conformance`           | -not released-                                         | Contains definitions of the [FDC3 conformance test suite](https://fdc3.finos.org/docs/api/conformance/Conformance-Overview)                                                         | Test Definitions Only |
+| `toolbox/fdc3-conformance`           | -not released-                                         | Contains definitions of the [FDC3 conformance test suite](https://fdc3.finos.org/docs/api/conformance/Conformance-Overview)                                                                                            | Test Definitions Only |
 | `toolbox/fdc3-workbench`             | [here](https://fdc3.finos.org/toolbox/fdc3-workbench/) | Contains an FDC3-For-Web ready version of the [FDC3 Workbench](toolbox/fdc3-workbench/README.md).                                                                                                                      |                       |
 | `toolbox/fdc3-explained`             | [Here](https://fdc3.finos.org/toolbox/fdc3-explained)  | [Readme Here](toolbox/fdc3-explained/README.md)                                                                                                                                                                        |                       |
-| `toolbox/fdc3-for-web/fdc3-web-impl` | `@finos/fdc3-web-impl` (npm)                           | Portable and reusable implementation of the FDC3 For-The-Web Desktop Agent-Side protocol,                                                                                                                              | Cucumber, NYC         |
-| `toolbox/fdc3-for-web/demo`          | -not released-                                         | A reference implementation of an FDC3-For-The-Web Desktop Agent, using the above implementation and conforming to  the conformance test suite (see above) |                       |
-| `packages/fdc3`                      | `@finos/fdc3` (npm)                                    | Imports `fdc3-standard`, `fdc3-context`, `fdc3-schema` and `fdc3-get-agent` sub-modules.  This is intended to be the main entry point for typescript / javascript applications using FDC3         |                       |
-| `packages/fdc3-commonjs`                      | `@finos/fdc3-commonjs` (npm)                                    | A roll-up of the `fdc3` sub-module.  This is for **backwards compatibility where CommonJS is required**.  May not be provided in future versions of FDC3.         |                       |
+| `toolbox/fdc3-for-web/demo`          | -not released-                                         | Scripts to run FDC3-Sail so you can try out FDC3 in your browser.                                                                                                                                                      |                       |
+| `packages/fdc3`                      | `@finos/fdc3` (npm)                                    | Imports `fdc3-standard`, `fdc3-context`, `fdc3-schema` and `fdc3-get-agent` sub-modules.  This is intended to be the main entry point for typescript / javascript applications using FDC3                              |                       |
+| `packages/fdc3-commonjs`             | `@finos/fdc3-commonjs` (npm)                           | A roll-up of the `fdc3` sub-module.  This is for **backwards compatibility where CommonJS is required**.  May not be provided in future versions of FDC3.                                                              |                       |
 
 
 ### Building and Running The FDC3 Modules

package.json

@@ -21,7 +21,7 @@
     "packages/fdc3-schema",
     "packages/fdc3-context",
     "packages/fdc3-standard",
-    "packages/testing",
+    "packages/fdc3-testing",
     "packages/fdc3-agent-proxy",
     "toolbox/fdc3-for-web/fdc3-web-impl",
     "packages/fdc3-get-agent",
@@ -67,4 +67,4 @@
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"
   }
-}
+}

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

@@ -1,7 +1,7 @@
 import { Given, When } from '@cucumber/cucumber';
-import { SimpleIntentResolver } from '@finos/testing';
+import { SimpleIntentResolver } from '@finos/fdc3-testing';
 import { CustomWorld } from '../world/index';
-import { CHANNEL_STATE } from '@finos/testing';
+import { CHANNEL_STATE } from '@finos/fdc3-testing';
 import {
   DefaultChannelSupport,
   DefaultHeartbeatSupport,

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

@@ -1,8 +1,8 @@
 import { DataTable, Given, Then, When } from '@cucumber/cucumber';
 import { Context } from '@finos/fdc3-context';
-import { handleResolve, matchData } from '@finos/testing';
+import { handleResolve, matchData } from '@finos/fdc3-testing';
 import { CustomWorld } from '../world/index';
-import { CHANNEL_STATE } from '@finos/testing';
+import { CHANNEL_STATE } from '@finos/fdc3-testing';
 import { ApiEvent } from '@finos/fdc3-standard';
 import {
   BroadcastEvent,

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

@@ -8,8 +8,8 @@ import {
   DefaultIntentSupport,
   DefaultHeartbeatSupport,
 } from '../../src';
-import { SimpleIntentResolver, setupGenericSteps } from '@finos/testing';
-import { CHANNEL_STATE, SimpleChannelSelector } from '@finos/testing/dist/src/agent';
+import { SimpleIntentResolver, setupGenericSteps } from '@finos/fdc3-testing';
+import { CHANNEL_STATE, SimpleChannelSelector } from '@finos/fdc3-testing/dist/src/agent';
 import { HeartbeatEvent } from '@finos/fdc3-schema/dist/generated/api/BrowserTypes';
 import { LogLevel } from '@finos/fdc3-standard';
 

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

@@ -1,6 +1,6 @@
 import { Given } from '@cucumber/cucumber';
 import { CustomWorld } from '../world/index';
-import { handleResolve } from '@finos/testing';
+import { handleResolve } from '@finos/fdc3-testing';
 import { Context } from '@finos/fdc3-context';
 import { ContextMetadata, ResolveError } from '@finos/fdc3-standard';
 import { IntentEvent } from '@finos/fdc3-schema/dist/generated/api/BrowserTypes';

packages/fdc3-agent-proxy/test/world/index.ts

@@ -1,6 +1,6 @@
 import { setWorldConstructor } from '@cucumber/cucumber';
 import { TestMessaging } from '../support/TestMessaging';
-import { PropsWorld } from '@finos/testing';
+import { PropsWorld } from '@finos/fdc3-testing';
 
 export class CustomWorld extends PropsWorld {
   messaging: TestMessaging | null = null;

packages/fdc3-agent-proxy/tsconfig.json

@@ -25,7 +25,7 @@
       "path": "../fdc3-context"
     },
     {
-      "path": "../testing"
+      "path": "../fdc3-testing"
     },
     {
       "path": "../fdc3-context"

packages/fdc3-get-agent/.nycrc.json

@@ -0,0 +1,14 @@
+{
+  "include": [
+    "dist/src/**/*.js"
+  ],
+  "exclude": [
+    "**/*.d.ts"
+  ],
+  "reporter": [
+    "lcov",
+    "text",
+    "json"
+  ],
+  "all": true
+}

packages/fdc3-get-agent/.nycrc.test-coverage.json

@@ -0,0 +1,14 @@
+{
+  "include": [
+    "dist/test/support/**/*.js"
+  ],
+  "exclude": [
+    "**/*.d.ts"
+  ],
+  "reporter": [
+    "lcov",
+    "text",
+    "json"
+  ],
+  "all": true
+}

packages/fdc3-get-agent/cucumber.yml

@@ -6,10 +6,9 @@ default:
   paths: 
    - test/features/*.feature
   require: 
-   - test/step-definitions/*.steps.ts 
-   - test/support/*.ts
-   - test/world/index.ts
+   - dist/test/step-definitions/*.steps.js 
+   - dist/test/support/*.js
+   - dist/test/world/index.js
   requireModule:
    - ts-node/register
   tags: "not @failing"
-

packages/fdc3-get-agent/package.json

@@ -18,8 +18,9 @@
   ],
   "scripts": {
     "build": "tsc --module es2022",
-    "test": "tsc && nyc --reporter=lcov --reporter=text --reporter json cucumber-js",
-    "clean": "rimraf dist cucumber-report.html coverage .nyc_output node_modules test-results.xml",
+    "test": "tsc && nyc --nycrc-path .nycrc.json cucumber-js",
+    "test:coverage-test-infra": "tsc && nyc --nycrc-path .nycrc.test-coverage.json cucumber-js",
+    "clean": "rimraf dist cucumber-report.html coverage coverage-test-infra .nyc_output node_modules test-results.xml",
     "lint": "eslint src/"
   },
   "dependencies": {
@@ -34,7 +35,6 @@
     "@cucumber/cucumber": "10.3.1",
     "@cucumber/messages": "^28.1.0",
     "@eslint/js": "^9.19.0",
-    "@finos/fdc3-web-impl": "2.2.1-beta.4",
     "@finos/testing": "2.2.1-beta.4",
     "@types/node": "^20.16.11",
     "@types/wtfnode": "^0.7.3",
@@ -50,4 +50,4 @@
     "typescript-eslint": "^8.17.0",
     "wtfnode": "^0.9.3"
   }
-}
+}