Update FDC3 Workbench to support setting and rendering FDC3 API metadata
- Dominant language
- TypeScript
- Stars
- 270
- Forks
- 193
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 36
Description
## Enhancement Request
The recently merged FDC3 API Metadata feature:
- #1728
Has added required support for setting additional API metadata (see [`ContextMetadata`](https://fdc3.finos.org/docs/next/api/ref/Metadata#contextmetadata)) when making FDC3 `broadcast`, `open`, `raiseIntent` or `raiseIntentForContext` API calls and when returning an `IntentResult` from an `IntentHandler`, and receiving that metadata via handlers registered via `addContextListener` and `addIntentListener`.
FDC3 workbench already supports some limited rendering of metadata received, to support the previous optional `originatingAppMetadata` feature (see [FDC3 2.2's `ContextMetadata` type](https://fdc3.finos.org/docs/api/ref/Metadata#contextmetadata)). It should be updated to support the setting of all [`AppProvidableContextMetadata`](https://fdc3.finos.org/docs/next/api/ref/Metadata#appprovidablecontextmetadata) fields when making the above API calls (currently manually settable traceId and signature fields and an arbitrary `custom` object) and any necessary additions made to support rendering of received [`ContextMetadata`](https://fdc3.finos.org/docs/next/api/ref/Metadata#contextmetadata) - which was not previously supported for an `IntentResult`.
Contributor guide
Research direction
Start by locating the FDC3 Workbench controls for making broadcast, open, raiseIntent, and raiseIntentForContext calls, plus the existing metadata rendering and IntentHandler result views. Compare the Workbench changes from #1728 and verify that all AppProvidableContextMetadata fields can be set and received ContextMetadata, including metadata on IntentResult, is rendered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100