Go client: expose EngineInfo.kind and EngineInfo.protocol (the service already fills them)

Open Beginner friendly
#2,341 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
api

Research direction

Start with client/opensysml/engines.go and the EngineInfo definition in api/proto/sysml.proto; inspect how ListEngines maps the existing response fields. Update the Go client mapping and check client/opensysml/engines_test.go for the built-in and registered tool cases. Done when both values match the service and existing fields remain unchanged; the issue also calls for the Go cell in the parity test and documentation.

Written by the indexing model from the issue text.

Description

Disclaimer, this issue was detected and written by an AI

Summary

ListEnginesResponse carries each engine's origin and transport:
EngineInfo.kind (built-in, tool, engine, policy, sampler) and
EngineInfo.protocol (-, object, argv+<stdin>, <transport>/<protocol>).
The service fills both. client/opensysml drops them, so an in-process caller
cannot tell an engine's kind or how it is spoken to and falls back to forking
sysml -engines.

Current state

  • api/proto/sysml.proto::EngineInfo — kind = 9, protocol = 10.
  • client/opensysml/engines.go:12 — EngineInfo has Name, Authority,
    Answers, Bounds, Process, ProcessFound, Ready, Unavailable; no
    Kind, no Protocol.
  • ListEngines at engines.go:115 copies fields 1–8 only.

Proposal

  • Add Kind string and Protocol string to EngineInfo, with the proto's
    comments, and copy e.Kind/e.Protocol in ListEngines.
  • No capability gate: the fields are part of the existing engines response.

Tests

  • client/opensysml/engines_test.go: a service with a built-in engine reports
    Kind == "built-in" and Protocol == "-"; a registered tool reports its
    manifest kind and <transport>/<protocol> spelling; the undecoded old fields
    are unchanged.
  • parity_options_test.go/parity doc: add the Go cell.

Acceptance

  • EngineInfo.Kind/.Protocol match the service for built-in and external
    engines.
  • No new capability gate; existing ListEngines callers keep working.
Dominant language
Go
Stars
59
Forks
20
Avg merge
10h 23m
Merged PRs (30d)
897

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Open-MBEE/OpenSysML

All issues in Open-MBEE/OpenSysML

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.