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

Clarify differences between App and User Channel behaviour (in docs for FDC3 versions 1.1, 1.2, 2.0 and next) #871

Closed
kriswest opened this issue Dec 2, 2022 · 1 comment · Fixed by #971
Assignees
Labels
api FDC3 API Working Group docs Documentation
Milestone

Comments

@kriswest
Copy link
Contributor

kriswest commented Dec 2, 2022

Area of Issue

[x] API

Issue Description:

There is a key difference in behaviour between App Channels and System/User channels in FDC3 versions 1.1, 1.2, 2.0 in that, when you join a user channel (or add a context listener when already joined to the channel) your handler immediately receives the current context of the channel (filtered by the type of the listener). However, this is not the case when working with a channel through the Channel interface. In that case, you do NOT receive the current context but can retrieve it manually with channel.getCurrentContext(/* optional context type name */).

This is currently (i.e. in 2.0) only stated in the overview:
2.0:

When an app joins a User channel, or adds a context listener when already joined to a channel, it will automatically receive the current context for that channel.

https://fdc3.finos.org/docs/api/spec#joining-user-channels

1.2

When an app joins a channel it will automatically recieve the current context for that channel.

https://fdc3.finos.org/docs/1.2/api/spec#joining-channels

and not in the function references for either the main Desktop Agent API or Channel interface. Hence, it is often missed by both Desktop Agent developers and application developers. Additional copy should be added to past and current documentation to clarify the behavior that should be expected.

@kriswest kriswest added bug Something isn't working docs Documentation api FDC3 API Working Group needs-pr and removed bug Something isn't working labels Dec 2, 2022
@kriswest
Copy link
Contributor Author

kriswest commented Dec 2, 2022

Note that conformance testing additions related to this are proposed under #864 and #865

@kriswest kriswest added this to the 2.1-candidates milestone Feb 23, 2023
@kriswest kriswest self-assigned this Mar 9, 2023
@hughtroeger hughtroeger self-assigned this Apr 5, 2023
@kriswest kriswest modified the milestones: 2.1-candidates, 2.1 Apr 27, 2023
@kriswest kriswest removed the needs-pr label Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants