Make ContextMetadata traceId optional

[julianna-ciq]

Describe your change

Makes ContextMetadata.traceId optional across the API schema, generated BrowserTypes and BridgingTypes, public typings, documentation, and conformance checks. Desktop Agents may generate a trace ID, so callers can construct an IntentEventPayload without supplying one.

Related Issue

N/A — reported as a mismatch between the public ContextMetadata type and the generated browser protocol payload.

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.

Validation

• npm run build in packages/fdc3-schema
• npm run build in packages/fdc3-standard
• npm run build in toolbox/fdc3-conformance
• Verified public ContextMetadata without traceId is assignable to BrowserTypes.IntentEventPayload.metadata
• Verified generated IntentEvent runtime conversion accepts metadata without traceId

[netlify]

✅ Deploy Preview for fdc3 ready!

Name	Link
🔨 Latest commit	f326bb0
🔍 Latest deploy log	https://app.netlify.com/projects/fdc3/deploys/6a91900b84f2da0008bf2b86
😎 Deploy Preview	https://deploy-preview-2157.preview-fdc3.finos.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.03%. Comparing base (cb00631) to head (f326bb0).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2157   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files          73       73           
  Lines        4251     4251           
  Branches      596      604    +8     
=======================================
  Hits         4040     4040           
  Misses        211      211           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[kriswest]

I expected traceId to be required in ContextMetadata as it was to be generated by the DA if not provided - and thought that was what was agreed in the working group. It is already optional in AppProvidableContextMetadata (https://fdc3.finos.org/docs/next/api/ref/Types#appprovidablecontextmetadata).

The docs are not currently in agreement with sources as they do say the DA may provide a traceId - but I think that is the error, not the sources requiring it on output. The conformance tests agree with the sources, whicch you change in this PR. Generation of a UIUD is if it was not provided seems a lesser burden on DAs than apps checking for its existence on using it. So I think we should be making the alternative change and updating the API overview content to require DAs to generate it if not present.

I note that the Agent Proxy is generating traceIds for raiseIntent if one is not provided at:

FDC3/packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts

Line 177 in cb00631

traceId: metadata?.traceId ?? v4(),

The reference implementation generates one for a raiseIntent request if not provided:

FDC3/toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts

Line 72 in cb00631

traceId: appProvidedMeta.traceId ?? sc.createUUID(),

and for a result if not provided:

FDC3/toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts

Line 232 in cb00631

traceId: appMeta.traceId ?? sc.createUUID(),

I don't see the same on broadcast in the proxy:

FDC3/packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts

Line 64 in cb00631

metadata: metadata ?? {},

The reference implementation handles generation for a broadcast:

FDC3/toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts

Line 475 in cb00631

traceId: appProvidedMetadata.traceId ?? sc.createUUID(),

While I think we should go the other way here and require DAs to generate the traceId if not present - were we to go this way, more work is required IMHO,

[kriswest]

Can we get an issue open for this.