FDC3
FDC3 copied to clipboard
Published
20 hours ago •
finos
finos
Conformance 2.2: Adding A Channel Change Event Listener Doesn't Send `addEventListenerRequest`
Describe your change
- #1605
Contributor License Agreement
- [x] I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.
Review Checklist
- [x] Issue: If a change was made to the FDC3 Standard, was an issue linked above?
- [x] CHANGELOG: Is a CHANGELOG.md entry included?
- [ ] API changes: Does this PR include changes to any of the FDC3 APIs (
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
JSDoc comments on interfaces and types should be matched to the main documentation in /docs - [ ] Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined - [ ] Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other- [ ] If yes, was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.ts
- [ ] If yes, was code generation (
- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
- [ ] Context types: Were new Context type schemas created or modified in this PR?
- [ ] Were the field type conventions adhered to?
- [ ] Was the
BaseContextschema applied viaallOf(as it is in existing types)? - [ ] Was a
titleanddescriptionprovided for all properties defined in the schema? - [ ] Was at least one example provided?
- [ ] Was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/context/ContextTypes.ts
- [ ] Intents: Were new Intents created in this PR?
- [ ] Were the intent name prefixes and other naming conventions & characteristics adhered to?
- [ ] Was the new intent added to the list in the Intents Overview?
Deploy Preview for fdc3 ready!
| Name | Link |
|---|---|
| Latest commit | 55276b2867b7a918718bcc9f35ee8f354b658310 |
| Latest deploy log | https://app.netlify.com/projects/fdc3/deploys/6847126397833d000889b6d5 |
| Deploy Preview | https://deploy-preview-1606.preview-fdc3.finos.org |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Death currently incorporates a heck of a lot more than the change listed. Can you retarget this at the branch you used as a base so that we can practically implement a review please.
Good spot, done.
Also, don't forget that this event has to be sent regardless of registration to notify injected channel, select code and listeners in the proxy. Hence, please ensure that this change doesn't result in double transmission of the event nor double handling. It may not be obvious to a test that the event is double triggered
It actually isn't. The DefaultChannelSupport adds its own event listener when it's created. So, when the test adds a second one you see the message appear twice. We can remove one of these from the list of expected messages if it makes the tests less readable?
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Coverage Report
Commit: 561d6ff Base: fdc3-new-conformance-2.2@9bdd8cf
| Type | Base | This PR |
|---|---|---|
| Total Statements Coverage |  97.52% |
97.29% (-0.23%) |
| Total Branches Coverage | 86.51% |
86.2% (-0.31%) |
| Total Functions Coverage | 96.47% |
96.37% (-0.1%) |
| Total Lines Coverage | 97.69% |
97.39% (-0.3%) |
Details (changed files)
| File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DesktopAgentEventListener.ts | 90.9% | 83.33% | 100% | 90.9% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts | 95.13% | 85.55% | 96.55% | 94.82% |
Details (all files)
| File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/index.ts | 100% | 100% |  62.5% | 100% |
| packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts | 88% | 50% | 100% | 88% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts | 97.29% | 66.66% | 100% | 97.29% |
| packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts | 100% | 60% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DesktopAgentEventListener.ts | 90.9% | 83.33% | 100% | 90.9% |
| packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts | 93.33% | 72.72% | 100% | 93.33% |
| packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts | 94.59% | 100% | 80% | 94.59% |
| packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts | 100% | 94.11% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/index.ts | 100% | 100% |  28.57% | 100% |
| packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/messaging/message-port.ts | 97.43% | 86.66% | 100% | 97.43% |
| packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts | 97.36% | 89.47% | 100% | 97.36% |
| packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/FailoverHandler.ts | 100% | 76.47% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/HelloHandler.ts | 94% | 81.25% | 100% | 94% |
| packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts | 95.65% | 73.33% | 100% | 95.65% |
| packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts | 98.48% | 86.95% | 100% | 98.46% |
| packages/fdc3-get-agent/src/strategies/Timeouts.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/getAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts | 97.14% | 71.42% | 100% | 97.01% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts | 100% | 75% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullChannelSelector.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullIntentResolver.ts | 100% | 100% | 66.66% | 100% |
| packages/fdc3-get-agent/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/util/Uuid.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/index.ts | 91.3% | 70.83% | 60% | 95% |
| packages/fdc3-standard/src/api/AppIdentifier.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/AppIntent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/AppMetadata.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Channel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/ContextMetadata.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/DesktopAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/DisplayMetadata.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Errors.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Events.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/GetAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Icon.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Image.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/ImplementationMetadata.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/IntentMetadata.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/IntentResolution.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Listener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Methods.ts | 94.18% | 84.28% | 96.29% | 95.23% |
| packages/fdc3-standard/src/api/PrivateChannel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/RecommendedChannels.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Types.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/context/ContextType.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/intents/Intents.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/contextConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/intentConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/typeHelpers.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/ui/ChannelSelector.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/ui/Connectable.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/ui/IntentResolver.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts | 96.87% | 84.21% | 100% | 96.55% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts | 95.13% | 85.55% | 96.55% | 94.82% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts | 88.23% | 71.87% | 86.66% | 90% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts | 97.22% | 90.47% | 100% | 96.8% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts | 97.14% | 86.84% | 100% | 97.14% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts | 100% | 100% | 100% | 100% |