Skip to content

Adding language binding for golang#1483

Merged
kriswest merged 20 commits intofinos:mainfrom
kemerava:feature/golang-language-binding
Jun 2, 2025
Merged

Adding language binding for golang#1483
kriswest merged 20 commits intofinos:mainfrom
kemerava:feature/golang-language-binding

Conversation

@kemerava
Copy link
Contributor

@kemerava kemerava commented Dec 26, 2024

Describe your change

Adding golang language binding
@michael-bowen-sc

Review deeplinks:

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
@netlify
Copy link

netlify bot commented Dec 26, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit 4424cc3
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/6824ddec7cbcb3000894233b
😎 Deploy Preview https://deploy-preview-1483.preview-fdc3.finos.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@kemerava kemerava changed the title Adding launguage binging for golang Adding launguage binding for golang Dec 26, 2024
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.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you so much @kriswest for the review! (Sorry about the indentation madness, looks like this new IDE does not do spell checks or any indents, should be better now). Also I have added a section about go in the supported platforms, let me know if this is the level of granularity that would be okay there. Thanks again!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kriswest I modified the definitions of Context, this will provide a better support for json of context looking like it is supposed to, without modifying it and also it would make it possible to create other types of contexts (rather than just adding the other fields as part of the map in Context type. However, now it is a bit awkward with having all Context types implement one function. This is just the trade off that had to be made because of go's peculiarities

@kriswest kriswest changed the title Adding launguage binding for golang Adding language binding for golang Dec 28, 2024
kemerava and others added 5 commits January 2, 2025 13:00
Co-authored-by: Kris West <kris.west@interop.io>
Co-authored-by: Kris West <kris.west@interop.io>
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.

Spotted a small issue rendering the code blocks on the supported platforms page

Co-authored-by: Kris West <kris.west@interop.io>
@kemerava
Copy link
Contributor Author

Spotted a small issue rendering the code blocks on the supported platforms page

Thanks for the spot @kriswest! Fixed now!

@kriswest kriswest requested review from a team and kriswest January 23, 2025 20:58
@kriswest kriswest linked an issue Jan 23, 2025 that may be closed by this pull request
@kriswest kriswest mentioned this pull request Feb 28, 2025
19 tasks
@kriswest
Copy link
Contributor

/netlify

@kemerava
Copy link
Contributor Author

@kriswest could you please review the changes with experimental tag. Thanks!

@kriswest
Copy link
Contributor

kriswest commented May 7, 2025

Closing to reopen in case that fixes the preview issues

@kriswest kriswest closed this May 7, 2025
@kriswest kriswest reopened this May 7, 2025
@kriswest
Copy link
Contributor

kriswest commented May 7, 2025

@TheJuanAndOnly99 can you ask netlify to rebuild this preview? I don't think it accepts commands from me and closing/reopening didn't affect it (did re-run the github actions however).

@kriswest
Copy link
Contributor

kriswest commented May 7, 2025

@TheJuanAndOnly99 Ideally I'm after it using your later config so it gets a preview URL i can view ;-) But I'd settle for it just successfully building

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.

The changelog needs adjusting after the 2.2 release. Otherwise have suggested a few places to put @experimental.

Will be able to review properly once we get the preview fixed!

@TheJuanAndOnly99
Copy link
Member

Hi @kriswest I triggered the preview build https://app.netlify.com/sites/fdc3/deploys/681b9118a04a5583475bab9a. It's still failing here. I think @kemerava will need to pull the changes to this branch as it does not have the updates to the .nvmrc file from main. Once you do so let me know and I can trigger the preview build again.

@kriswest
Copy link
Contributor

kriswest commented May 7, 2025

@kemerava try merging main and then npm install in website/ and see if you get an integrity error. If not and it will then npm start ok that should sort it out. If you get an integrity error try blowing away the package-lock.json and installing again.

I think we may have ended up with bad checksum in the package-lock.json at some point (probably a bad merge), as there have been a few PRs with this error.

@kemerava
Copy link
Contributor Author

kemerava commented May 8, 2025

@kemerava try merging main and then npm install in website/ and see if you get an integrity error. If not and it will then npm start ok that should sort it out. If you get an integrity error try blowing away the package-lock.json and installing again.

I think we may have ended up with bad checksum in the package-lock.json at some point (probably a bad merge), as there have been a few PRs with this error.

@kriswest ran both, and there were some changes in the package-lock, so I committed. Hopefully that resolves it

@kriswest
Copy link
Contributor

kriswest commented May 8, 2025

@kemereva that did indeed fix the build, but there's a syntax error in the markdown to sort: https://app.netlify.com/sites/fdc3/deploys/681cd79fbf8e800009f1052a#L423

@kemerava
Copy link
Contributor Author

@kriswest thanks for noticing, I fixed those errors, now the build is no longer failing

@kriswest kriswest self-requested a review May 15, 2025 06:30
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.

LGTM
@hughtroeger or @novavi could you take a look?

@kriswest kriswest requested a review from a team May 15, 2025 06:33
Copy link
Contributor

@hughtroeger hughtroeger left a comment

Choose a reason for hiding this comment

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

Well I don't know Go, but all the examples in the site previews look good and I didn't see any typos or other issues. 👍

@kriswest kriswest merged commit 7abbe23 into finos:main Jun 2, 2025
30 of 31 checks passed
@chriscasola
Copy link

Is there a Go library that implements the FDC3 schema and code behind the documentation in this PR? Sorry if that's an uneducated question.

@kriswest
Copy link
Contributor

@chriscasola Not at present, we just have the API binding. However, @kemerava previously indicated a willingness to provide one or collaborate on one in future if there was interest in the Go binding. If you are interested I'd recommend raising an issue.

@kemerava
Copy link
Contributor Author

Is there a Go library that implements the FDC3 schema and code behind the documentation in this PR? Sorry if that's an uneducated question.

Hi @chriscasola , there is not a library implementation at the moment. What are you looking for? The full implementation underneath the API or a library with the interfaces that can be pulled and implemented?

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.

Proposal to add Go (GoLang) language binding

5 participants