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

Adding language binding for golang #1483

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

Conversation

kemerava
Copy link
Contributor

Describe your change

Adding golang language binding
@michael-bowen-sc

Related Issue

#1482

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?

@kemerava kemerava requested a review from a team as a code owner December 26, 2024 18:45
Copy link

netlify bot commented Dec 26, 2024

Deploy Preview for fdc3 canceled.

Name Link
🔨 Latest commit 36cf97b
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/676da4b2b064e500091d839f

@kemerava kemerava changed the title Adding launguage binging for golang Adding launguage binding for golang Dec 26, 2024
Comment on lines +84 to +85
User ChannelType = "user"
System ChannelType = "system"
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation

Suggested change
User ChannelType = "user"
System ChannelType = "system"
User ChannelType = "user"
System ChannelType = "system"

Copy link
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

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

Looks like a great contribution @kemerava 👏

I've given it a quick pass for typos and indentation consistency, see comments.

I think we could do with a subsection adding here on Go: https://deploy-preview-1483--fdc3.netlify.app/docs/next/api/supported-platforms#native
Please describe any idiosyncracies specific to the language. If you intend to contribute a repo with the binding to FINOS it can also be mentioned there.

Comment on lines +74 to +75
Id string `json:"id"`
Type ChannelType `json:"type"`
Copy link
Contributor

Choose a reason for hiding this comment

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

Indentation

Suggested change
Id string `json:"id"`
Type ChannelType `json:"type"`
Id string `json:"id"`
Type ChannelType `json:"type"`


```go
func (ch *Channel) AddContextListener(contextType string, handler ContextHandler) <-chan Result[Listener] {
// Implmentation here
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Implmentation here
// Implementation here

// handle the contact
})
listenerResultInstrument := <-channel.AddContextListener("fdc3.instrument", func(context Context, contextMetadata *ContextMetadata) {
// handle the instrumnt
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// handle the instrumnt
// handle the instrument


```go
func (channel *Channel) Broadcast(context Context) <-chan Result[any] {
// Implmentation here
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Implmentation here
// Implementation here


```go
func (channel *Channel) GetCurrentContext(contextType string) <-chan Result[Context] {
// Implmentation here
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Implmentation here
// Implementation here

Comment on lines +769 to +772
// The unique name of the intent that can be invoked by the raiseIntent call.
Name string `json:"name"`

DisplayName string `json:"displayName"`
Copy link
Contributor

Choose a reason for hiding this comment

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

Check indentation

Comment on lines +850 to +865

```go
type IntentResolution struct {
// The application that resolved the intent.
Source AppIdentifier `json:"source"`
// The intent that was raised.
Intent string `json:"intent"`
// The version number of the Intents schema being used.
Version string `json:"version"`
}

type IntentResult any

func (ir *IntentResolution) GetResult() <-chan Result[IntentResult] {
// implementation here
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Check indentation

Comment on lines +948 to +958
resolutionResult := <-desktopAgent.RaiseIntent("QuoteStream", context, nil)
if resolutionResult.Err != nil {
// handle error
}
if channel, ok := resolutionResult.Value.(Channel); ok {
log.Println("The result is a channel")
} else if context, ok := resolutionResult.Value.(Context); ok {
log.Println("The result is a context")
} else {
log.Error("The result is of incorrect data type!")
}
Copy link
Contributor

Choose a reason for hiding this comment

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

check indentation

Comment on lines +62 to +66
// The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'.
AppId string `json:"appId"`
// An optional instance identifier, indicating that this object represents a specific instance of the application described.
InstanceId string `json:"instanceId"`
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Check indentation

Type string `json:"type"`
Name string `json:"name"`
Id map[string]string `json:"id"`
// This field is required only in golang, as golang structs cannot be extended with more fields later
Copy link
Contributor

Choose a reason for hiding this comment

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

check indentation

@kriswest kriswest changed the title Adding launguage binding for golang Adding language binding for golang Dec 28, 2024
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.

2 participants