FDC3 for Web specification #1191
Open
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
Draft Agent agnostic fdc3 spec
❌ Deploy Preview for fdc3 failed. Why did it fail? →
|
This comment was marked as outdated.
This comment was marked as outdated.
12 tasks
This comment was marked as outdated.
This comment was marked as outdated.
Co-authored-by: Brian Ingenito <28159742+bingenito@users.noreply.github.com>
Make window.fdc3 optional
This was referenced Oct 24, 2024
…-fns Deprecating functions in Methods.ts
kemerava
requested changes
Nov 1, 2024
kriswest
force-pushed
the
fdc3-for-web
branch
from
f71010e
to
34587f7
Compare
|
@kemerava many thanks for the detailed review. I've resolved most of the comments for things fixed. I've left a few open for you to look at, please resolve those as well. Our branch protection will require you to post another review/confirm requested changes have been made. |
pvoznyuk
reviewed
Nov 6, 2024
|
|
||
| ```js | ||
| const desktopAgent = await getAgent({ | ||
| timeoutMs: 250, |
There was a problem hiding this comment.
Timeouts are usually counted in milliseconds. Isn’t it overkill to name it timeoutMs rather than just timeout?
pvoznyuk
reviewed
Nov 6, 2024
| @@ -603,7 +613,7 @@ To find a User channel, one calls: | |||
| ```ts | |||
| // returns an array of channels | |||
| const allChannels = await fdc3.getUserChannels(); | |||
| const redChannel = allChannels.find(c => c.id === 'red'); | |||
| const redChannel = allChannels.find(c => c.id === "red"); | |||
There was a problem hiding this comment.
I think this would be the correct example.
const redChannel = allChannels.find(c => c.id === "fdc3.channel.1");
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.
resolves #896
resolves #1385
resolves #1402
This PR adds specifications and documentation related to enabling FDC3 for the web. This was based off of the committee's working doc and an initial PR (#1167) with the draft by @thorsent.
This assumes that "@finos/fdc3" will implement getAgent() and communication mechanisms to work with a Desktop Agent running in a different browser window.
The protocols were codified as "Web Connection Protocol (WCP)" for negotiating the handshake between the library and desktop agents, and "Browser Communication Protocol (BCP)" which encompasses the complete "wire protocol". The former is entirely specific to working in a Web Browser, however the latter might be reused in other implementations and hence may change name (e.g. 'The FDC3 Wire Protocol' or similar).
This documentation followed three streams:
Some changes and additions were made from the original working document:
Deep links to docs for review:
getAgent()for gaining access to an API implementation for web apps: https://deploy-preview-1191--fdc3.netlify.app/docs/next/api/supported-platformsgetAgent()reference docs for app implementors: https://deploy-preview-1191--fdc3.netlify.app/docs/next/api/ref/GetAgentAgentErrorenumeration added for connection issues: https://deploy-preview-1191--fdc3.netlify.app/docs/next/api/ref/Errors#agenterror