mirror of
https://github.com/hanzoai/o11y-foundry.git
synced 2026-11-03 02:08:34 +00:00
PandeyandGitHub
09b16ec619
## Summary Reshape foundryctl's output contract so it composes with agents and shell pipelines. Three changes that fall out of the same observation: **stdout, stderr, and exit codes should be a stable contract — today they're conflated.** - **Logger to stderr, silent by default.** `instrumentation.NewLogger` writes to `os.Stderr` (was `os.Stdout`) and uses `slog.DiscardHandler` unless `--debug` is set. Matches helm/aws CLI convention. stdout is now reserved for command results. - **Typed exit codes.** `internal/errors.typ` carries a `code int` field; `errors.ExitCode(err)` walks the wrap chain via `errors.As` and returns a deterministic code: `InvalidInput=2, NotFound=3, Unsupported=4, Internal=5, Fatal=6`, untyped=1, nil=0. Compact 1-6 scheme rather than sysexits.h because sysexits would collapse `Internal` and `Fatal` into the same `EX_SOFTWARE (70)`, losing a distinction we care about (Fatal = recovered panic; Internal = expected-but-failed path). `cmd/foundryctl/main.go` now exits with `errors.ExitCode(err)`. - **`fmt.Errorf` forbidden by lint.** New forbidigo rules in `.golangci.yml` ban `fmt.Errorf` and `fmt.Print*` / `print` / `println`. 168 call sites across 38 files converted to `errors.Newf` / `errors.Wrapf` with contextually-chosen types. Narrow exception for `internal/errors/error_test.go` so the ExitCode wrap-chain test stays authentic. Sites of note for review: - `internal/errors/type.go` — exit code mapping table (one source of truth) - `internal/errors/error.go` — `ExitCode(err)` helper - `internal/instrumentation/logger.go` — `slog.DiscardHandler` default - `.golangci.yml` — forbidigo config + the single narrow test exclusion ## Test plan - [x] `go build ./...` - [x] `go test ./...` (all packages pass; new `TestExitCode` covers 9 cases: nil, untyped, each typed, fmt.Errorf-wrapped, foundry-Wrapf-wrapped) - [x] `golangci-lint run ./...` — 0 issues - [x] Manual: `foundryctl forge` on a missing file exits non-zero and emits nothing on stdout (logs hidden); `--debug` emits JSON on stderr only - [x] Manual: end-to-end forge + cast against the docker/compose flavor still produces a healthy stack
79 lines
1.9 KiB
Go
79 lines
1.9 KiB
Go
package domain
|
|
|
|
import (
|
|
"github.com/signoz/foundry/internal/errors"
|
|
kyaml "sigs.k8s.io/yaml"
|
|
)
|
|
|
|
func UnmarshalYAML(data []byte, v any) error {
|
|
return kyaml.Unmarshal(data, v)
|
|
}
|
|
|
|
func MustUnmarshalYAML(data []byte, v any) error {
|
|
return kyaml.Unmarshal(data, v)
|
|
}
|
|
|
|
func MarshalYAML(v any) ([]byte, error) {
|
|
yaml, err := kyaml.Marshal(v)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return yaml, nil
|
|
}
|
|
|
|
func MustMarshalYAML(v any) []byte {
|
|
yaml, err := MarshalYAML(v)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
return yaml
|
|
}
|
|
|
|
// MergeYAML takes a base YAML string and an override YAML string,
|
|
// and returns a new YAML string with deep merge — override keys win
|
|
// at every level, base-only keys are preserved.
|
|
func MergeYAML(base, override string) (string, error) {
|
|
var baseMap map[string]any
|
|
if err := kyaml.Unmarshal([]byte(base), &baseMap); err != nil {
|
|
return "", errors.Wrapf(err, errors.TypeInternal, "failed to unmarshal base yaml")
|
|
}
|
|
|
|
var overrideMap map[string]any
|
|
if err := kyaml.Unmarshal([]byte(override), &overrideMap); err != nil {
|
|
return "", errors.Wrapf(err, errors.TypeInternal, "failed to unmarshal override yaml")
|
|
}
|
|
|
|
deepMerge(baseMap, overrideMap)
|
|
|
|
merged, err := kyaml.Marshal(baseMap)
|
|
if err != nil {
|
|
return "", errors.Wrapf(err, errors.TypeInternal, "failed to marshal merged yaml")
|
|
}
|
|
|
|
return string(merged), nil
|
|
}
|
|
|
|
// deepMerge recursively merges override into base.
|
|
// For matching keys: if both values are maps, merge recursively.
|
|
// Otherwise, override wins.
|
|
func deepMerge(base, override map[string]any) {
|
|
for k, overrideVal := range override {
|
|
baseVal, exists := base[k]
|
|
if !exists {
|
|
base[k] = overrideVal
|
|
continue
|
|
}
|
|
|
|
baseMap, baseIsMap := baseVal.(map[string]any)
|
|
overrideMap, overrideIsMap := overrideVal.(map[string]any)
|
|
|
|
if baseIsMap && overrideIsMap {
|
|
deepMerge(baseMap, overrideMap)
|
|
} else {
|
|
base[k] = overrideVal
|
|
}
|
|
}
|
|
}
|