-
Notifications
You must be signed in to change notification settings - Fork 135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FDC3 For Web Browsers Implementation #1309
base: main
Are you sure you want to change the base?
Conversation
bd27747
to
e2a8a55
Compare
@robmoffat Please see #1405 for build fixes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewing the addon and fdc3-agent-proxy package. More reviews to come...
Then "{result}" is an error with message "TargetAppUnavailable" | ||
|
||
Scenario: void is returned in the result | ||
Given Raise Intent will return no result |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given Raise Intent will return no result | |
Given Raise Intent returns no result |
| OrderFood | fdc3.instrument | AAPL | chipShop | c1 | raiseIntentRequest | | ||
|
||
Scenario: Context Data is returned in the result | ||
Given Raise Intent will return a context of "{instrumentContext}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given Raise Intent will return a context of "{instrumentContext}" | |
Given Raise Intent returns a context of "{instrumentContext}" |
| OrderFood | fdc3.instrument | AAPL | raiseIntentRequest | | ||
|
||
Scenario: App Channel is returned in the result | ||
Given Raise Intent will return an app channel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given Raise Intent will return an app channel | |
Given Raise Intent returns an app channel |
| OrderFood | fdc3.instrument | AAPL | raiseIntentRequest | | ||
|
||
Scenario: User Channel is returned in the result | ||
Given Raise Intent will return a user channel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given Raise Intent will return a user channel | |
Given Raise Intent returns a user channel |
| OrderFood | fdc3.instrument | AAPL | raiseIntentRequest | | ||
|
||
Scenario: Private Channel is returned in the result | ||
Given Raise Intent will return a private channel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given Raise Intent will return a private channel | |
Given Raise Intent returns a private channel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviews for the fdc3-get-agent package
packages/fdc3-get-agent/test/step-definitions/desktop-agent.steps.ts
Outdated
Show resolved
Hide resolved
packages/fdc3-get-agent/test/step-definitions/desktop-agent.steps.ts
Outdated
Show resolved
Hide resolved
packages/fdc3-get-agent/test/step-definitions/desktop-agent.steps.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just starting a review - have only really got through addon
"packages/fdc3", | ||
"toolbox/fdc3-for-web/demo", | ||
"toolbox/fdc3-workbench" | ||
], | ||
"scripts": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd also be useful to have some readme content on the scripts, both at this top-level and the individual scripts in each package. What do the merge, report and syncpack tasks actually achieve? Which scripts need running on a PR branch before creating a PR? (e.g. code generation after schema changes). How do you preview docs changes.
We were light on this content before this PR, but with the complexity it adds, guide content becomes more important IMHO
@@ -0,0 +1,134 @@ | |||
import { IframeChannelsPayload, Channel } from "@kite9/fdc3-common"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix before merge
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
And "App1/a1" is opened with connection id "a1" | ||
And "listenerApp/b1" is opened with connection id "b1" | ||
And "listenerApp/b1" registers an intent listener for "returnBook" | ||
# Scenario: Context Not Handled By App |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These lines should be deleted.
# Scenario: Raising An Invalid Intent (non existent intent but valid app) | ||
# When "App1/a1" raises an intent for "nonExistentIntent" with contextType "fdc3.book" on app "listenerApp/b1" | ||
# Then messaging will have outgoing posts | ||
# | msg.payload.error | msg.type | | ||
# | NoAppsFound | raiseIntentResponse | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Scenario: Raising An Invalid Intent (non existent intent but valid app) | |
# When "App1/a1" raises an intent for "nonExistentIntent" with contextType "fdc3.book" on app "listenerApp/b1" | |
# Then messaging will have outgoing posts | |
# | msg.payload.error | msg.type | | |
# | NoAppsFound | raiseIntentResponse | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this? What does this file accomplish for the repo?
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
I pinged Derek about this today, fwiw. |
At least it's helping me persuade myself to buy a bigger laptop (rendering the diff takes some doing) ;-) It's also a huge contribution of work to the standard which will have a massive positive impact on it if you/we pull it off. Looking forward to helping get that done. |
|
|
2 similar comments
|
@kriswest I think you're going to need to go through EasyCLA ⬆️ |
@robmoffat doh, I wonder why those commits are not tied to my github id :-( I'll work on this later on today 😭 |
/easycla |
@robmoffat fixed the easycla problem - I had removed an old email from my github account. Commits stay associated with the github ID, but apparently EasyCLA's state is based on the email address! |
At various times we've committed the generated source files with or without prettier reformatting them. Always apply prettier after generation to make them more stable.
Tested against our Desktop Agent using Workbench from PR #1485 (rebased onto branch All workbench functionality successfully tested:
raiseIntent / raiseIntentForContext tested without UI Iframes enabled in desktop agent. App Resolution was handled in container window. Untested:
|
ok, I've tested UI hosted on the preview site. There's now a third option in the demo dropdown to allow you to choose which default UI you want to use: When we merge this PR, we need to change this one spot in
these two URLs should be changed to the boolean value |
Implementation PR for FDC3 for the Web (#896)
This PR primarily implements the
getAgent()
function (in the fdc3-get-agent package) as defined by the FDC3 Web Connection Protocol (WCP) and aDesktopAgentProxy
(in the fdc3-agent-proxy package) that it uses to implement communication with browser-based Desktop Agents via the FDC3 Desktop Agent Communication Protocol (DACP).Additionally, the FDC3 repository is refactored to be a monorepo supported by
npm workspaces
. The existing repository was split into fdc3-context (context type definitions), fdc3-schems (bridging and DACP protocol messages) and fdc3-standard (existing API TypeScript definitions, Intents and App Directory) packages. A testing package was added with tooling used in multiple packages for testing.These packages are rolled up for release on NPM by an fdc3 package (publishing to the existing @finos/fdc3 NPM package). Previous releases provided both ES6 and CommonJs modules within a single package - this release will only provide ES6, with a separate fdc3-commonjs module provided for backwards compatibility (will release at @finos/fdc3-commonjs).
Finally, a reference implementation, demo for FDC3 in a Web Browser and reference channel selector and intent resolver UIs (that can be injected into an app by getAgent) are provided in the toolbox/fdc3-for-web package.