Allow DAs to customize timeoutsand apps to control logging by kriswest · Pull Request #1497 · finos/FDC3

kriswest · 2025-01-16T13:03:27Z

Describe your change

Resolves two requested additions to getAgent/fdc3-for-web:

Adds the ability to control debug logging output from getAgent() and the DesktopAgentProxy via new arguments to getAgent(). The new arguments are documented in the types and documentation pages.
- Docs changes can be found in the preview at: https://deploy-preview-1497--fdc3.netlify.app/docs/next/api/ref/GetAgent (or will be when the preview builds...)
Allows DesktopAgents to set two custom timeouts, one for most FDC3 for Web message exchanges and a second for message exchanges that involve application launches. Also extends the default timeout for application launch message exchanges to 100 seconds and introduces standardized error messages for ApiTimeout.

Related Issue

resolves #1487
resolves #1488

Contributor License Agreement

I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

Issue: If a change was made to the FDC3 Standard, was an issue linked above?
CHANGELOG: Is a CHANGELOG.md entry included?
API changes: Does this PR include changes to any of the FDC3 APIs (DesktopAgent, Channel, PrivateChannel, Listener, Bridging)?
- Docs & Sources: If yes, were both documentation (/docs) and sources updated?
  
  JSDoc comments on interfaces and types should be matched to the main documentation in /docs
- Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
  
  Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
- Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
  
  The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
  - If yes, was code generation (npm run build) run and the results checked in?
    
    Generated code will be found at /src/api/BrowserTypes.ts and/or /src/bridging/BridgingTypes.ts

…fdc3-get-agent

…unches

github-actions · 2025-01-16T13:36:29Z

github-actions · 2025-01-16T13:36:32Z

Coverage Report

Commit: 27edb07
Base: fdc3-for-web-impl@3abc5cb

Type	Base	This PR
Total Statements Coverage	97.32%	97.4% (+0.08%)
Total Branches Coverage	86.09%	86.53% (+0.44%)
Total Functions Coverage	98.07%	97.88% (-0.19%)
Total Lines Coverage	97.33%	97.42% (+0.09%)

Details (changed files)

File	Statements	Branches	Functions	Lines
packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/index.ts	100%	100%	62.5%	100%
packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts	88%	50%	100%	88%
packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts	97.29%	66.66%	100%	97.29%
packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts	100%	60%	100%	100%
packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts	100%	90%	100%	100%
packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts	100%	77.77%	100%	100%
packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts	93.33%	72.72%	100%	93.33%
packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts	94.59%	100%	80%	94.59%
packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts	100%	94.11%	100%	100%
packages/fdc3-agent-proxy/src/util/Logger.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/messaging/message-port.ts	97.43%	86.66%	100%	97.43%
packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts	100%	81.25%	100%	100%
packages/fdc3-get-agent/src/strategies/FailoverHandler.ts	100%	76.47%	100%	100%
packages/fdc3-get-agent/src/strategies/HelloHandler.ts	94%	81.25%	100%	94%
packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts	98.48%	86.95%	100%	98.46%
packages/fdc3-get-agent/src/strategies/Timeouts.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/strategies/getAgent.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/util/Logger.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/Errors.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/GetAgent.ts	100%	100%	100%	100%

Details (all files)

File	Statements	Branches	Functions	Lines
packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/index.ts	100%	100%	62.5%	100%
packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts	88%	50%	100%	88%
packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts	97.29%	66.66%	100%	97.29%
packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts	100%	60%	100%	100%
packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts	100%	90%	100%	100%
packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts	100%	77.77%	100%	100%
packages/fdc3-agent-proxy/src/listeners/EventListener.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts	93.33%	72.72%	100%	93.33%
packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts	94.59%	100%	80%	94.59%
packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts	100%	94.11%	100%	100%
packages/fdc3-agent-proxy/src/util/Logger.ts	100%	100%	100%	100%
packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/index.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/messaging/message-port.ts	97.43%	86.66%	100%	97.43%
packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts	97.36%	89.47%	100%	97.36%
packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts	100%	81.25%	100%	100%
packages/fdc3-get-agent/src/strategies/FailoverHandler.ts	100%	76.47%	100%	100%
packages/fdc3-get-agent/src/strategies/HelloHandler.ts	94%	81.25%	100%	94%
packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts	95.65%	73.33%	100%	95.65%
packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts	98.48%	86.95%	100%	98.46%
packages/fdc3-get-agent/src/strategies/Timeouts.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/strategies/getAgent.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts	97.14%	71.42%	100%	97.01%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts	100%	75%	100%	100%
packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts	100%	90%	100%	100%
packages/fdc3-get-agent/src/ui/NullChannelSelector.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/ui/NullIntentResolver.ts	100%	100%	66.66%	100%
packages/fdc3-get-agent/src/util/Logger.ts	100%	100%	100%	100%
packages/fdc3-get-agent/src/util/Uuid.ts	100%	100%	100%	100%
packages/fdc3-standard/src/index.ts	100%	100%	0%	100%
packages/fdc3-standard/src/api/Errors.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/GetAgent.ts	100%	100%	100%	100%
packages/fdc3-standard/src/api/Methods.ts	94.04%	84.05%	96.29%	95%
packages/fdc3-standard/src/api/RecommendedChannels.ts	100%	100%	100%	100%
packages/fdc3-standard/src/context/ContextType.ts	100%	100%	100%	100%
packages/fdc3-standard/src/intents/Intents.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/contextConfiguration.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/intentConfiguration.ts	100%	100%	100%	100%
packages/fdc3-standard/src/internal/typeHelpers.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts	100%	100%	100%	100%
toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts	96.87%	84.21%	100%	96.55%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts	96.38%	86.41%	100%	96.12%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts	88.23%	71.87%	86.66%	90%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts	95.6%	86.56%	100%	95%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts	97.14%	86.84%	100%	97.14%
toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts	100%	100%	100%	100%

…ntrol-timeouts

kriswest · 2025-01-24T21:38:39Z

@robmoffat I think this and the new tests are working well now.

N.b. I needed to test from the fdc3-get-agent package (although the timeouts are in the fdc3-agent-proxy package) as the custom timeouts are set by the DA in WCP3Handshake responses (which are the province of getAgent()).

kriswest · 2025-01-24T21:42:10Z

I had to merge the debug logging PR into this one to figure out the tests (needed debug output from the proxy messages).

After doing so I realized that every call to broadcast on the current user channel is preceeded by a call to get the current user channel... I think this should be refined for performance reasons and the current user channel tracked in the channel support - there is, after all, a message sent when the channel is changed... Interested in your thoughts on that @robmoffat.

kriswest · 2025-01-27T18:14:27Z

@robmoffat not sure why netlify is ignoring this PR...

robmoffat · 2025-01-27T18:35:20Z

@robmoffat not sure why netlify is ignoring this PR...

I can't figure it out! @TheJuanAndOnly99 any ideas?

…elete a redundant step

kriswest · 2025-01-27T18:38:43Z

Closing to re-open (in case that wakes netlify up)

github-actions · 2025-01-27T18:39:18Z

github-actions · 2025-01-27T18:42:21Z

TheJuanAndOnly99 · 2025-01-27T18:48:51Z

Hey @kriswest @robmoffat If I'm not mistaken Netlify will only generate previews for PRs made against the production branch

kriswest · 2025-01-27T18:51:58Z

@TheJuanAndOnly99 This PR got a preview and was targetting the same (non-main) branch: #1495

...hmm its possible I raised that against main, then changed it... perhaps thats it.

kriswest · 2025-01-27T18:53:16Z

/netlify

kriswest · 2025-01-27T18:55:15Z

Switching to main as the base doesn't seem to get going on a build unfortunately. We might be in close and re-open territory.

@robmoffat I'll make the changes to the logging args which should deal with all your comments then open as a new PR?

github-actions · 2025-01-27T19:12:23Z

github-actions · 2025-01-28T15:43:55Z

github-actions · 2025-01-28T16:04:32Z

github-actions · 2025-01-28T16:48:09Z

github-actions · 2025-01-28T19:17:38Z

kriswest added 5 commits January 15, 2025 18:46

Adding support for controlling debug logging in fdc3-agent-proxy and …

19a3aad

…fdc3-get-agent

CHANGELOG

19a0f8e

Testing coverage

a44ec5d

Test coverage

dca1f8a

Allow DAs to customize timeouts used for message exchanges and app la…

77e92a8

…unches

kriswest requested a review from robmoffat January 16, 2025 13:03

kriswest requested a review from a team as a code owner January 16, 2025 13:03

kriswest marked this pull request as draft January 16, 2025 13:03

kriswest mentioned this pull request Jan 16, 2025

FDC3 for Web Browsers Discussion group 16th January 2025 #1496

Closed

9 tasks

kriswest added 2 commits January 16, 2025 13:16

timeouts in testing for fdc3-agent-proxy

cbf8ab1

Shorten timeouts used when testing

bdef136

kriswest marked this pull request as ready for review January 16, 2025 14:02

kriswest added 13 commits January 16, 2025 16:30

Update website/docs/api/ref/GetAgent.md

1ed86d8

WIP timeout tests - not passing yet

3bd6717

Merge branch 'fdc3-for-web-impl' into fdc3-for-web-impl-debug-logs

5dcffda

Merge branch 'fdc3-for-web-impl' into fdc3-for-web-impl-debug-logs

0644c81

Merge branch 'main' into fdc3-for-web-impl-control-timeouts

36f795a

Move conformance test docs into correct location in mono-repo

3b7f2a2

Creating ApiTimeout errors and partially complete tests

ca3daad

Merge branch 'fdc3-for-web-impl-debug-logs' into fdc3-for-web-impl-co…

e93d026

…ntrol-timeouts

first test working

5ee82fb

Log handshake messages at debug level

55bb9da

All timeout tests working

65930b2

CHANGELOG

366e092

Merge branch 'fdc3-for-web-impl' into fdc3-for-web-impl-control-timeouts

12df506

restoring missing test step

fe6b359

kriswest linked an issue Jan 27, 2025 that may be closed by this pull request

Set better default timeouts for API exchanges in DesktopAgentProxy and allow DesktopAgents to control them #1488

Closed

move non-generic test steps to their own file in fdc3-get-agent and d…

7878abf

…elete a redundant step

kriswest closed this Jan 27, 2025

kriswest reopened this Jan 27, 2025

kriswest changed the base branch from fdc3-for-web-impl to main January 27, 2025 18:52

kriswest changed the base branch from main to fdc3-for-web-impl January 27, 2025 18:55

kriswest added 2 commits January 27, 2025 19:01

defaultTimeout -> messageExchangeTimeout

da3e330

defaultTimeout -> messageExchangeTimeout (in tests)

a72c89e

Rework logging config based on log levels

e6ac4a7

Log settings in tests + coverage

ac871f0

robmoffat approved these changes Jan 28, 2025

View reviewed changes

kriswest added 2 commits January 28, 2025 16:43

Correcting NONE log level definition

036b434

Cleanup of an unused type and incorrect timeout in a test

5e392ed

Clarifying note on timeouts in DACP docs

27edb07

robmoffat approved these changes Jan 29, 2025

View reviewed changes

robmoffat merged commit a04808c into fdc3-for-web-impl Jan 29, 2025
2 checks passed

Conversation

kriswest commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your change

Related Issue

Contributor License Agreement

Review Checklist

Uh oh!

github-actions bot commented Jan 16, 2025

Uh oh!

github-actions bot commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

kriswest commented Jan 24, 2025

Uh oh!

kriswest commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kriswest commented Jan 27, 2025

Uh oh!

robmoffat commented Jan 27, 2025

Uh oh!

kriswest commented Jan 27, 2025

Uh oh!

github-actions bot commented Jan 27, 2025

Uh oh!

github-actions bot commented Jan 27, 2025

Uh oh!

TheJuanAndOnly99 commented Jan 27, 2025

Uh oh!

kriswest commented Jan 27, 2025

Uh oh!

kriswest commented Jan 27, 2025

Uh oh!

kriswest commented Jan 27, 2025

Uh oh!

github-actions bot commented Jan 27, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

github-actions bot commented Jan 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kriswest commented Jan 16, 2025 •

edited

Loading

github-actions bot commented Jan 16, 2025 •

edited

Loading

kriswest commented Jan 24, 2025 •

edited

Loading