Java client: no member enumeration, no GetElementProperties, no instance paths
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 42/100
Direzione di ricerca
Start in client/java, especially internal/Protos.java and the Java Symbol, Model, and Instance APIs; compare the listed Python and Go methods and the protobuf fields and RPC messages. Implement member decoding, element-properties access, and instance-path access with the suggested fields and options. Done means Java callers can retrieve these data through public APIs, matching the documented behavior of the Python and Go clients.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
This issue was written with AI help. The results were produced against the version below.
The Java client (client/java) is the binding for JVM hosts: Eclipse-based tools, Cameo plugins, web services. Three features the service already serves, and the Python and Go clients expose, are missing from it:
| feature | service | Python | Go | Java |
|---|---|---|---|---|
SymbolInfo.members (#1974, capability symbol_members) |
yes | Symbol.members() |
Symbol.Members |
dropped: Symbol has no members |
GetElementProperties (#2013, capability element_properties) |
yes | Model.element_properties() |
Client.ElementProperties |
no method |
InstancePaths and Instance.reached_by (#1979) |
yes | Instance.paths(), .path, .owner |
Client.InstancePaths |
no method; Instance is id, type and feature values |
The data is already there: the generated protobuf classes contain SymbolInfo.members and the GetElementProperties messages, and Capabilities names SYMBOL_MEMBERS and ELEMENT_PROPERTIES. But internal/Protos.java never reads members, and no public method calls either RPC.
What it costs a Java user
We run the same 1630 static reads through every client, with the Pilot as oracle (https://github.com/hideo67/sysmlv2-tests, suite opensysml-java). Over sysml-grpc at 19bc16d1df:
| client | API | pass | fail | unsupported |
|---|---|---|---|---|
| Python | Symbol API, with members() |
652 | 222 | 747 |
| Go | Symbol API, with Members |
642 | 232 | 747 |
| TypeScript | Symbol API, no members | 542 | 326 | 753 |
| Java | Symbol API, no members | 542 | 326 | 753 |
| Python, Go | element_properties |
1236 | 323 | 62 |
The Java client gives the same answer as the TypeScript client on every case. Where it gives the wrong answer, the decoding is not at fault; the information never reaches the caller:
- Inherited members are invisible. With
part def Base { part p; } part def Mid :> Base;andpart m : Mid;,m's inheritedpis not amongchildIds()orattributes(). 94 cases that Go passes fail in Java: inherited parts, ports, connections, parameters and annotations read through a usage or a specialization (our matrices A10, A30, A40, B12, B20, C01, C10, C30, D10). - No route to most of the metamodel. Through
element_properties, Python and Go answer 470 reads that the Symbol API has no field for (connector ends, send action arguments, value expressions, state entry/do/exit actions, documentation, ...). A Java user has no route to any of them. - No owner path of an object.
Instancedoes not say how it was reached, and there is no way to ask for its paths, so an object reached through a connector end cannot be traced back to its owner (6 more cases Go passes).
Suggestion
- Add
List<Member> members()toSymbol, read fromSymbolInfo.members, withinherited,inheritedFromandwithheldLibraryMembers, and an option forinclude_library_members, like Python'smembers(inherited=True, library=True). - Add
Model.elementProperties(String element, String... properties), returning element references with the id the call accepts back, like Python and Go. - Add
reachedBy,owner,pathtoInstanceandModel.instancePaths(Instance).
The TypeScript client also lacks members and instance paths (it has element_properties). A shared checklist of service features versus client bindings might help keep the bindings level.
Version
- OpenSysML
developat19bc16d1df(nightly-199-g19bc16d1df) - Java client 0.12.1 from
client/javaof the same commit (mvn -f client/java/pom.xml install), JDK 21;bin/sysml-grpcfrommake build-grpc - Suite: https://github.com/hideo67/sysmlv2-tests,
test-suite/test-opensysml-java
- Lingua principale
- Go
- Stelle
- 56
- Fork
- 17
- Merge medio
- 12h 45m
- PR unite (30g)
- 910
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Open-MBEE/OpenSysML
-
dependencies
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
Open-MBEE/OpenSysML#1951 · 3 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Open-MBEE/OpenSysML#2029 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement spec compliance
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
Open-MBEE/OpenSysML#2028 · 3 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Symbol API fields answer differently from GetElementProperties, with no sign that the answer is incompleteForse già presa @devin-ai-integration l’ha presa oggi. Apertadocumentation enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Open-MBEE/OpenSysML#2021 · 2 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di Open-MBEE/OpenSysML
Issue simili
-
area: metrics area: tracing contribfest enhancement good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
open-telemetry/opentelemetry-ebpf-instrumentation#4188 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
blinklabs-io/dingo#6074 ·
I maintainer di solito rispondono entro 1 giorno
-
kind/bug remote
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
podman-container-tools/podman#30143 ·
I maintainer di solito rispondono entro 1 giorno
-
component/mesheryctl kind/bug language/go
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
meshery/meshery#22993 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100