8000 [WIP] Expand broadcast, raise*, and open methods to include metadata by julianna-ciq · Pull Request #1595 · finos/FDC3 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[WIP] Expand broadcast, raise*, and open methods to include metadata #1595

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

julianna-ciq
Copy link
Contributor

Describe your change

Adds the metadata property at the end of the .broadcast(), .raiseIntent(), .raiseIntentForContext(), and .open() methods.
Includes schema updates, doc updates, and implementation updates.

Provides placeholder space for signature (see #1571) and hostParams (#1546).

Related Issue

Resolves #1290

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
  • Context types: Were new Context type schemas created or modified in this PR?
    • Were the field type conventions adhered to?
    • Was the BaseContext schema applied via allOf (as it is in existing types)?
    • Was a title and description provided for all properties defined in the schema?
    • Was at least one example provided?
    • Was code generation (npm run build) run and the results checked in?

      Generated code will be found at /src/context/ContextTypes.ts
  • Intents: Were new Intents created in this PR?

@julianna-ciq julianna-ciq requested a review from a team as a code owner May 21, 2025 16:34
Copy link
netlify bot commented May 21, 2025

Deploy Preview for fdc3 failed. Why did it fail? →

Name Link
🔨 Latest commit d0fb59a
🔍 Latest deploy log https://app.netlify.com/projects/fdc3/deploys/6852a80efa8b9f000814d969

@kriswest kriswest mentioned this pull request May 22, 2025
16 tasks
@@ -18,3 +18,15 @@ export interface ContextMetadata {
*/
readonly source: AppIdentifier;
}

export interface AppProvidableContextMetadata {
signature?: string;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are apps limited on the metadata they can send? Shouldn't they be allowed to put anything in here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The discussions around #1290 indicated that we should limit the metadata. Let's discuss this at the next Web meeting.

})
```

### Timestamp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this? We already have a timestamp in the message meta I think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was in my notes as one of the few properties we should support. Let's discuss what metadata properties should be included at the next Web meeting.

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

Successfully merging this pull request may close these issues.

Add property to support analytics across apps
2 participants
0