Namespace (rename) iframe messages in FDC3 for the web to avoid potential conflicts #1375
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
novavi
reviewed
Sep 24, 2024
robmoffat
approved these changes
Sep 24, 2024
novavi
reviewed
Sep 24, 2024
| "description": "Handshake message sent back to an iframe from the DA proxy code (setup by `getAgent()`) over the `MessagePort` provide in the preceding iFrameHello message, confirming that it is listening to the `MessagePort` for further communication.", | ||
| "$id": "https://fdc3.finos.org/schemas/next/api/fdc3UserInterfaceHandshake.schema.json", | ||
| "title": "Fdc3 UserInterface Handshake", | ||
| "description": "Handshake message sent back to a user interface from the DA proxy code (setup by `getAgent()`) over the `MessagePort` provide in the preceding iFrameHello message, confirming that it is listening to the `MessagePort` for further communication.", |
There was a problem hiding this comment.
No big deal, but if you wanted to be consistent with the descriptions in the other schemas you could say "a UI" instead of "a user interface".
|
It didn't work wonderfully with camel case so I ended up with UserInterface which felt more legible. Adjusted in WCP1Hello and WCP3Handshake for consistency (replaced UI with user interface and completed a sentence fragment I noticed at the same time) |
novavi
reviewed
Sep 24, 2024
|
|
||
| Messages are also provided that are specific to each interface type provided by a Desktop Agent. The following messages are specific to Channel Selector user interfaces: | ||
|
|
||
| - [`iFrameChannels`](https://fdc3.finos.org/schemas/next/api/iFrameChannels.schema.json): Sent by the parent frame to initialize a Channel Selector user interface by providing metadata for the Desktop Agent's user channels and details of any channel that is already selected. This message will typically be sent by a `getAgent()` implementation immediately after the `iFrameHandshake` and before making the injected iframe visible. | ||
| - [`iFrameChannelSelected`](https://fdc3.finos.org/schemas/next/api/iFrameChannelSelected.schema.json): Sent by the Channel Selector to indicate that a channel has been selected or deselected. | ||
| - [`fdc3UserInterfaceChannels`](https://fdc3.finos.org/schemas/next/api/fdc3UserInterfaceChannels.schema.json): Sent by the parent frame to initialize a Channel Selector user interface by providing metadata for the Desktop Agent's user channels and details of any channel that is already selected. This message will typically be sent by a `getAgent()` implementation immediately after the `fdc3UserInterfaceHandshake` and before making the injected iframe visible. |
There was a problem hiding this comment.
fdc3UserInterfaceChannels should be Fdc3UserInterfaceChannels
(This is assuming the block above containing Fdc3UserInterfaceHello / Fdc3UserInterfaceHandshake / Fdc3UserInterfaceDrag / Fdc3UserInterfaceDrag was the correct case.)
There was a problem hiding this comment.
Was fixed earlier in 0d2c9a4
novavi
reviewed
Sep 24, 2024
| - [`iFrameChannels`](https://fdc3.finos.org/schemas/next/api/iFrameChannels.schema.json): Sent by the parent frame to initialize a Channel Selector user interface by providing metadata for the Desktop Agent's user channels and details of any channel that is already selected. This message will typically be sent by a `getAgent()` implementation immediately after the `iFrameHandshake` and before making the injected iframe visible. | ||
| - [`iFrameChannelSelected`](https://fdc3.finos.org/schemas/next/api/iFrameChannelSelected.schema.json): Sent by the Channel Selector to indicate that a channel has been selected or deselected. | ||
| - [`fdc3UserInterfaceChannels`](https://fdc3.finos.org/schemas/next/api/fdc3UserInterfaceChannels.schema.json): Sent by the parent frame to initialize a Channel Selector user interface by providing metadata for the Desktop Agent's user channels and details of any channel that is already selected. This message will typically be sent by a `getAgent()` implementation immediately after the `fdc3UserInterfaceHandshake` and before making the injected iframe visible. | ||
| - [`fdc3UserInterfaceChannelSelected`](https://fdc3.finos.org/schemas/next/api/fdc3UserInterfaceChannelSelected.schema.json): Sent by the Channel Selector to indicate that a channel has been selected or deselected. |
There was a problem hiding this comment.
fdc3UserInterfaceChannelSelected should be Fdc3UserInterfaceChannelSelected
There was a problem hiding this comment.
Was fixed earlier in 0d2c9a4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR renames the iframe* messages in FDC3 for the web to make clashes on the type field value for
iFrameHelloand to make them less web specific as they might be used in other languages as part of the DACP - as requested in the review by @novavi:#1191 (comment)
THis doesn't materially change the process proposed, just some string values - but its best done now as it would be a breaking change later.