Go client: no typed RunSweep wrapper — the sweep RPC is unreachable and the parity doc claims RPC coverage

Abierto
#2,336 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
58/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
api, backend

Línea de trabajo

Read client/opensysml/client.go and client/opensysml/runs.go, then compare their request and response conversions with api/proto/sysml.proto and the handler in internal/frontend/grpc/sweep.go. Implement the typed client wrapper and preserve the response fields listed in the issue. Done means callers can invoke the sweep RPC through the Go client and receive its table and metadata; update docs/reference/client-parity.md to resolve its contradictory coverage claims.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Disclaimer, this issue was detected and written by an AI

Summary

The service has a RunSweep RPC that answers a table of run rows for a parameter
sweep. Every other client wraps it. client/opensysml has no RunSweep method at
all; a caller can only reach a sweep indirectly through RecordRun.

docs/reference/client-parity.md contradicts itself: "Every client exposes all 31
RPCs ... as typed calls", while the Open gaps table says "the package has no typed
RunSweep wrapper at all" (estimate about one day).

Service contract (already implemented)

api/proto/sysml.proto:

RunSweepRequest: model_hash, symbol_id (FQN of an analysis case or calc,
definition or usage), subject_symbol_id, positional arguments, named
named_arguments, ranges (SweepRange: parameter, start, end, step),
samples (draw uniformly; 0 steps; above 0 needs a seed and refuses a range with
a step), seed, engine.

RunSweepResponse: rows (SweepRow: inputs, outputs, verdicts,
elapsed_micros, error, failure_reason, evaluations), parameters,
sampled, seed, error, diagnostics, failure_reason, instances,
engine, strength, bounds.

The handler is internal/frontend/grpc/sweep.go:29; it requires
CapabilityVerification (not runs), and already checks ctx.Err() per
table at :143. A pre-run failure is a 200 with RunSweepResponse.error +
failure_reason; a failed row is a row, not a table error.

Current client state

  • client/opensysml/client.go Client: RunAction/RunMonteCarlo (RunRuns)
    but no RunSweep.
  • client/opensysml/runs.go:284 — runRowsFromProto already decodes
    []*pb.SweepRow, but only Inputs, Outputs, Verdicts, Error
    (RunRow at runs.go:37). elapsed_micros, failure_reason and
    evaluations are dropped.
  • runs.go:439 — RecordRange(parameter, start, end, step) already builds a
    pb.SweepRange, so the range/value conversion exists.
  • runs.go:517 — Recording.Sweep uses the same decoder.

Required API

// SweepRange is one parameter stepped (or drawn) from start to end.
type SweepRange struct {
    Parameter string
    Start, End, Step Value // Step is nil for a sampled sweep
}

// Sweep is what a sweep answers: the table and the parameters it covered.
type Sweep struct {
    Rows        []RunRow
    Parameters  []string
    Sampled     bool
    Seed        uint64
    Diagnostics []Diagnostic
    Instances   []*Instance // when the type already maps (analysis.go)
    Engine      string
    Strength    string
    Bounds      []Bound
}

type SweepOption func(*sweepOptions)

func SweepSubject(symbolID string) SweepOption
func SweepArguments(values ...Value) SweepOption
func SweepArgument(name string, value Value) SweepOption
func SweepSamples(rows int64) SweepOption
func SweepSeed(seed uint64) SweepOption
func SweepEngine(name string) SweepOption

// Sweep runs the analysis case or calc over the ranges and answers one row per
// run, in the service's order. Requires the verification capability.
func (c *client) Sweep(ctx context.Context, model *Model, symbolID string,
    ranges []SweepRange, opts ...SweepOption) (*Sweep, error)
Lenguaje dominante
Go
Estrellas
59
Forks
20
Merge medio
10 h 23 min
PR fusionados (30 d)
897

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Open-MBEE/OpenSysML

Todos los issues de Open-MBEE/OpenSysML

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.