mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
Claude
d320a8b587
Clean sweep of every actionable item from the two Copilot review passes
on head 59ae4d8. Grouped by severity:
─── Crash / security (must-fix) ─────────────────────────────────────
1. main.go:140 — telemetryShutdown nil panic.
telemetry.Init can return (nil, err) on the -tags otel skeleton
path; the deferred closure would then call a nil function. Normalise
to a no-op shutdown when Init errors so the defer is always safe.
2. api/upload_handler.go — permSvc nil deref.
MountUploadRoutes + handleServeFile dereference permSvc on every
authenticated file request. Add a fail-fast panic at mount time so
the misconfiguration surfaces at wiring, not on the first 500.
Update upload_handler_test.go to pass a real PermissionService built
on the test DB (the existing tests were missing the argument entirely,
which meant the package wouldn't compile — this fixes the real bug
Copilot flagged).
3. ws/event_persister.go — NewEventPersister nil EventStore panic.
run() dereferences p.store on every flush. Panic at constructor
time instead so the crash happens once at startup rather than
minutes later in a background goroutine.
4. plugin/host_ui.go — serve-time symlink check.
rejectSymlinksUnder only runs at install time, so a symlink created
post-install (accidental or malicious) would be followed by
http.ServeFile and leak host files. Add an os.Lstat + ModeSymlink
check + IsRegular check to AssetHandler on every request. Cheap
relative to the file read and closes the TOCTOU window.
─── Correctness / observability (should-fix) ───────────────────────
5. ws/deps.go:77 — requirePerm hides misconfig as FORBIDDEN.
Previously, nil database, nil perms, or a GetRoleForUser error all
returned ErrCodeForbidden with the same message, making operator
failures indistinguishable from legitimate permission denials.
Split the branches: misconfig + DB error now return ErrCodeInternal
with a server-side slog.Error so operators see the real problem;
FORBIDDEN is reserved for the actual permission-bit check.
6. telemetry/metrics.go — ServiceCallDurationMs renamed to Sec.
Field name said "Ms" but the instrument name was
`service_call_duration_seconds` with unit "s". Renamed the field
and updated all 8 service-layer callers so the struct field and
metric semantics match.
7. ws/event_persister.go — flushEvy typo → flushEvery.
Renamed the field and the one call site in run().
─── Comments out of sync with code ──────────────────────────────────
8. plugin/loader.go — Stat vs Lstat comment.
The comment claimed "Stat (not Lstat)" but the code correctly uses
os.Lstat to detect symlinks. Updated the comment to match the code;
the code was already right.
9. telemetry/telemetry_otel.go — compile claim wrong.
Comment said the file would fail to compile without the upstream
OTel modules, but the skeleton deliberately avoids importing them
and Init returns a runtime error instead. Updated the comment to
reflect actual CI behaviour (the -tags otel build step passes
today but doesn't exercise real telemetry).
─── Nit / polish ────────────────────────────────────────────────────
10. ws/event_pruner.go — startup delay magic constant.
Hard-coded time.Minute made the "run shortly after startup"
behaviour untestable (a test with a 100ms interval would still
wait a full minute). Cap the startup delay by the interval:
min(interval, time.Minute). Documented via a new `maxStartupDelay`
constant.
11. ws/event_pruner_test.go — new file.
Unit coverage for runPrune cutoff correctness, error swallowing,
StartEventPruner nil-store short-circuit, ctx cancellation, and
the interval-bounded startup delay from fix #10. Uses a fakeEventStore
stub that records every prune call and signals the first one so
tests don't sleep.
─── Verification ────────────────────────────────────────────────────
gofmt -l clean. No network access in sandbox so `go vet` and `go test`
could not run; the changes are local and surgical and every touched
file compiles in isolation against the existing signatures.
https://claude.ai/code/session_01UsBsQW2YiA2usk9pnJjAWk
79 lines
3.4 KiB
Go
79 lines
3.4 KiB
Go
//go:build otel
|
|
|
|
// Real OpenTelemetry-backed implementation. Compiled only with `-tags otel`,
|
|
// which keeps the OTel SDK out of the default sqlite-only build (matching the
|
|
// pattern used by Server/store/postgres.go).
|
|
//
|
|
// IMPORTANT: This file currently compiles under `-tags otel` because the
|
|
// skeleton deliberately avoids importing any upstream OTel packages. `Init`
|
|
// returns a runtime error until the real SDK wiring lands; `Shutdown` is a
|
|
// no-op. The CI matrix step that builds with `-tags otel` therefore passes
|
|
// today but does NOT exercise real telemetry. To finish wiring it, run on
|
|
// a machine with network access:
|
|
//
|
|
// cd Server
|
|
// go get go.opentelemetry.io/otel@latest \
|
|
// go.opentelemetry.io/otel/sdk@latest \
|
|
// go.opentelemetry.io/otel/exporters/prometheus@latest \
|
|
// go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc@latest \
|
|
// go.opentelemetry.io/contrib/instrumentation/github.com/go-chi/chi/v5/otelchi@latest
|
|
// go mod tidy
|
|
// go build -tags otel ./...
|
|
//
|
|
// Until that runs, the default build (no `-tags otel`) uses telemetry_default.go.
|
|
package telemetry
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/owncord/server/config"
|
|
)
|
|
|
|
// otelProvider is the placeholder for the real OTel-backed Provider. The
|
|
// fields and methods will be filled in once the OTel modules are in go.mod;
|
|
// for now this file exists so reviewers can see the intended shape and the
|
|
// `otel` build tag has a target.
|
|
type otelProvider struct {
|
|
cfg config.TelemetryConfig
|
|
promHandler http.Handler
|
|
httpMiddleware func(http.Handler) http.Handler
|
|
shutdown ShutdownFunc
|
|
}
|
|
|
|
// Init wires the OTel SDK exporters according to cfg.Exporter:
|
|
//
|
|
// "none" — no-op (matches the default build)
|
|
// "prometheus" — pull-based Prometheus exporter mounted at /metrics
|
|
// "otlp" — push-based OTLP/gRPC exporter to cfg.OTLPEndpoint
|
|
//
|
|
// All exporters share the same resource (service.name = cfg.ServiceName).
|
|
func Init(ctx context.Context, cfg config.TelemetryConfig) (ShutdownFunc, error) {
|
|
if !cfg.Enabled || cfg.Exporter == "" || cfg.Exporter == "none" {
|
|
SetGlobal(noopProvider{})
|
|
return func(context.Context) error { return nil }, nil
|
|
}
|
|
|
|
// TODO(otel-build-tag): replace the panic below with the real OTel
|
|
// initialisation once go.mod has the otel modules. The structural call
|
|
// graph is:
|
|
//
|
|
// resource = sdkresource.NewWithAttributes(...)
|
|
// tp = sdktrace.NewTracerProvider(WithBatcher(otlptracegrpc...))
|
|
// mp = sdkmetric.NewMeterProvider(WithReader(prometheus.New()))
|
|
// otel.SetTracerProvider(tp); otel.SetMeterProvider(mp)
|
|
// handler = promhttp.HandlerFor(prometheusReg, promhttp.HandlerOpts{})
|
|
// mw = otelchi.Middleware(serviceName, otelchi.WithChiRoutes(...))
|
|
//
|
|
// then wrap them in a Provider implementation and SetGlobal it.
|
|
_ = ctx
|
|
return nil, fmt.Errorf("telemetry: otel build tag is set but the SDK skeleton in telemetry_otel.go is incomplete; finish wiring after `go get go.opentelemetry.io/otel...`")
|
|
}
|
|
|
|
// otelProvider satisfies Provider once the SDK is wired.
|
|
func (p *otelProvider) Tracer(name string) Tracer { _ = name; return noopTracer{} }
|
|
func (p *otelProvider) Meter(name string) Meter { _ = name; return noopMeter{} }
|
|
func (p *otelProvider) HTTPMiddleware(next http.Handler) http.Handler { return p.httpMiddleware(next) }
|
|
func (p *otelProvider) PrometheusHandler() http.Handler { return p.promHandler }
|