Skip to content
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

What branch of the fdc3 conformance tests uses getAgent()? #1481

Closed
1 of 6 tasks
Charlotte981 opened this issue Dec 20, 2024 · 10 comments
Closed
1 of 6 tasks

What branch of the fdc3 conformance tests uses getAgent()? #1481

Charlotte981 opened this issue Dec 20, 2024 · 10 comments
Labels
question Further information is requested

Comments

@Charlotte981
Copy link

Question Area

  • App Directory
  • API
  • Context Data
  • Intents
  • Use Cases
  • Other

Question

In the FDC3 Web Browsers Discussion group meeting yesterday on the 19th of December, it was mentioned that there was a branch of the fdc3 conformance tests set up to use getAgent() instead of just window.fdc3. I have checked the 2_0_fdc3_for_the_web branch and it appears to use fdc3Ready() instead of getAgent(), so we were wondering if it is a different branch that supports it instead?
We were also wondering what branch of the finos/fdc3 repository has an fdc3 workbench implementation that works with getAgent()?

@Charlotte981 Charlotte981 added the question Further information is requested label Dec 20, 2024
@kriswest
Copy link
Contributor

I'm just looking at this as well @Charlotte981. The fdc3Ready function is actually replaced fdc3-for-web-impl (and derived branches) with a version that use getAgent so that is probably correct. The instructions Rob gave me are here: #1466 (comment)

Note that this is based on having https://github.com/finos/FDC3/tree/fdc3-for-web-impl-getAgent-refactor checked out and replacing the "@kite9/client" dependency with the lcoally checked out fdc3-get-agent pacakage. is that right @robmoffat? I don't see the @kite9/fdc3-get-agent dependency from your instrucitons so I assume you have local changes, one of which is swapping @kite9/client for @kite9/fdc3-get-agent (local checkout).

@kriswest
Copy link
Contributor

@Charlotte981 heres the replacement fdc3Ready function (for interest's sake):

export function fdc3Ready(waitForMs = DEFAULT_WAIT_FOR_MS): Promise<DesktopAgent> {
return getAgent({
timeoutMs: waitForMs,
dontSetWindowFdc3: false,
channelSelector: true,
intentResolver: true,
});
}

@robmoffat
Copy link
Member

ok, sorry guys, looks like I fat-fingered the push yesterday when I was testing for Kris.

See: https://github.com/finos/FDC3-conformance-framework/blob/2_0_fdc3_for_the_web/package.json

In this version, it's referencing @kite9/fdc3-get-agent correctly.

WRT the fdc3Ready function, this is what the conformance framework used previously, and it's still supported (deprecated) by the new FDC3-for-web-impl code versions and will be in 2.2.

@robmoffat
Copy link
Member

We were also wondering what branch of the finos/fdc3 repository has an fdc3 workbench implementation that works with getAgent()?

fdc3-for-web-impl will do you,. this also uses fdc3Ready currently.

@Charlotte981
Copy link
Author

Awesome, thank you @kriswest @robmoffat for the update.

@kriswest
Copy link
Contributor

closing as completed (feel free to reopen if further questions)

@Roaders
Copy link
Contributor

Roaders commented Dec 24, 2024

@kriswest @robmoffat is this the long term goal for the workbench and conformance tests? To use this fdc3Ready function?

I was looking at the workbench and considering a PR that removes it and removed the utility that has a proxy for the agent implementation. I was thinking that we just use await getAgent() in all places that need it.

IMHO this would be simpler and easier to follow. Also closer to how people would use it in a real apps so more of an example of how to use it.

@kriswest
Copy link
Contributor

Hi @Roaders, I can't speak for @robmoffat who implemented the change, but I suspect it was done that way for expediency and that both projects should switch to await getAgent() in due course. We could do with an issue raising for that and would gladly accept a PR for the change ;-) I'm still working on completing my own PR into fdc3-for-web-impl, but may get this after it goes in.

@Roaders
Copy link
Contributor

Roaders commented Dec 30, 2024

I have a PR that's most of the way through for implementing that so maybe wait a few days till I'm able to finish that before spending the time on it @kriswest

@Roaders
Copy link
Contributor

Roaders commented Jan 2, 2025

Created issue #1484 and Pr #1485 to migrate workbench to getAgent()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants