Files
silo-server/internal/notifications/operational_dispatch_test.go
203a18ae83 feat(observability): OpenTelemetry logs+traces with secret redaction and slog standardization (#290)
* feat(observability): OpenTelemetry logs+traces with secret redaction

Part of #265. Adds opt-in OpenTelemetry (logs + traces) alongside the existing
stderr + opslog pipeline, plus secret redaction on all sinks. Default-off: with
no OTEL_* / SILO_OTEL_ENABLED config, behavior is unchanged.

Bootstrap (internal/telemetry):
- Setup() builds one shared resource, a TracerProvider (parent-based trace-id
  ratio sampler), a LoggerProvider, and the W3C TraceContext+Baggage propagator
  from env. It installs NO MeterProvider — metrics stay on Prometheus, and the
  built-in no-op global MeterProvider keeps the trace instrumentation libs from
  double-emitting. Shutdown is deferred with a flush timeout.
- Logs are bridged via otelslog fan-out (slog.MultiHandler), level-gated by the
  shared LevelVar and best-effort so a failing collector can't break the console
  or DB branches. stderr + opslog stay untouched.

Secret redaction (internal/logredact):
- A slog.Handler masks secret-keyed attributes (password, token, api_key,
  authorization, cookie, ...) — including .With-bound attrs, nested groups,
  secret-keyed group subtrees, and values behind a LogValuer — on the console
  and OTLP sinks, with a no-op fast path when a record has no secret keys.
  opslog.shouldRedact delegates to logredact.SecretKey so all sinks share one
  marker list.

Rotation is infra-managed (no custom file sink): container runtime for stderr,
collector/backend for OTLP, opslog partition-pruning for the DB. Documented in
docs/architecture/observability.md.

Verification: go build ./..., go vet, gofmt -l — clean; go test
./internal/telemetry/ ./internal/logredact/ -race pass.

AI-use disclosure: implemented with AI assistance (Claude Code), including
adversarial reviews that hardened the bootstrap and fixed two redaction leak
paths; reviewed by the author.

* refactor(observability): slog context+component sweep, sloglint gate (phase 3)

Part of #265. Builds on the OTel bootstrap + redaction commit.

Standardizes every log call site onto the context-carrying slog variants so
records correlate with the active OpenTelemetry trace, and locks the standard
in with a machine gate so future code (human- or AI-authored) can't drift back.

- Call-site sweep: converted the remaining slog.<Level>(...) calls to the
  slog.<Level>Context(ctx, ...) form wherever a context.Context is in scope
  (background/init calls with no ctx are left as-is), across 183 files. Applied
  via a type-aware AST codemod. Log levels and message strings are preserved
  verbatim; a component attr (canonical per-package name) is added to direct
  package-level slog calls. Bound-logger calls keep their existing .With
  bindings. The main.go and telemetry package conversions rode with their file
  in the previous commit to keep each file within a single commit.
- Enforcement (.golangci.yml): enable sloglint with context=scope, static-msg,
  key-naming-case=snake, no-mixed-args. After the sweep all four report zero
  violations repo-wide (tests included), so make lint / CI now blocks any
  regression to the non-context form. The gate ships with the sweep because it
  cannot be green until the legacy sites are converted.

Metrics remain on Prometheus; no behavior change to /metrics or Grafana.

Verification: go build ./..., go vet ./..., gofmt -l — clean; sloglint (all 4
rules) 0 violations repo-wide; log levels verified unchanged.

AI-use disclosure: implemented with AI assistance (Claude Code), including the
codemod; reviewed by the author.

* fix(observability): honor per-signal OTLP protocol and secret WithGroup names

Two Codex review findings on PR #290:

- telemetry: OTEL_EXPORTER_OTLP_{TRACES,LOGS}_PROTOCOL now override the
  generic OTEL_EXPORTER_OTLP_PROTOCOL per signal, so mixed collector
  setups (e.g. HTTP logs + gRPC traces) build the right exporter.
- logredact: entering a group whose name is secret-bearing (e.g.
  WithGroup("authorization")) now masks every leaf in that subtree,
  matching how slog.Group("authorization", ...) is masked as a whole.

* fix(observability): address review feedback on telemetry bootstrap

- Telemetry setup failure no longer kills boot: Setup returns usable
  no-op providers alongside the error and main logs and continues with
  telemetry disabled, honoring the best-effort contract.
- Honor OTEL_TRACES_SAMPLER (always_on/off, traceidratio, parentbased_*
  variants); unsupported values fall back to parentbased_traceidratio.
- Attach node identity as semconv service.instance.id instead of the
  non-semconv node.name.
- Rename opslog retention-scope log attrs to target_component/target_level
  so they no longer collide with the canonical component routing key, and
  tag those lines with component=opslog.
- Fix stale levelGated comment casing; use WarnContext in the telemetry
  shutdown defer; document the LogValuer double-resolve on the redaction
  slow path.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Quick <31828688+Quick104@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-09 08:53:52 -04:00

157 lines
5.2 KiB
Go

package notifications
import (
"context"
"log/slog"
"os"
"testing"
"github.com/jackc/pgx/v5/pgxpool"
)
func TestDispatchOperationalEnqueuesApplePushAttempts(t *testing.T) {
dsn := os.Getenv("SILO_TEST_DATABASE_URL")
if dsn == "" {
t.Skip("set SILO_TEST_DATABASE_URL to run DB-backed operational push dispatch test")
}
ctx := context.Background()
config, err := pgxpool.ParseConfig(dsn)
if err != nil {
t.Fatalf("parse db config: %v", err)
}
config.MaxConns = 1
pool, err := pgxpool.NewWithConfig(ctx, config)
if err != nil {
t.Fatalf("connect db: %v", err)
}
t.Cleanup(pool.Close)
if _, err := pool.Exec(ctx, `
CREATE TEMP TABLE notification_deliveries (
id text PRIMARY KEY,
release_event_id text,
user_id integer NOT NULL,
profile_id text NOT NULL,
library_id integer,
series_id text,
episode_id text,
type text NOT NULL,
reason_flags jsonb NOT NULL DEFAULT '{}'::jsonb,
status text NOT NULL DEFAULT 'delivered',
read_at timestamptz,
delivered_at timestamptz,
created_at timestamptz NOT NULL DEFAULT now()
) ON COMMIT PRESERVE ROWS;
CREATE TEMP TABLE push_devices (
id text PRIMARY KEY,
user_id integer NOT NULL,
profile_id text NOT NULL,
device_id varchar(128) NOT NULL,
platform text NOT NULL,
provider text NOT NULL,
apns_environment text,
apns_topic text,
apns_token_ciphertext text,
apns_token_hash text,
server_device_id text NOT NULL,
push_mode text NOT NULL DEFAULT 'private_push',
enabled boolean NOT NULL DEFAULT true,
last_seen_at timestamptz,
last_success_at timestamptz,
last_failure_at timestamptz,
last_failure_code text,
created_at timestamptz NOT NULL DEFAULT now(),
updated_at timestamptz NOT NULL DEFAULT now()
) ON COMMIT PRESERVE ROWS;
CREATE TEMP TABLE push_delivery_attempts (
id text PRIMARY KEY,
notification_delivery_id text,
push_device_id text NOT NULL,
trigger_type text NOT NULL,
provider text NOT NULL,
platform text NOT NULL,
attempt_number integer NOT NULL DEFAULT 0,
attempted_at timestamptz,
next_retry_at timestamptz,
outcome text NOT NULL DEFAULT 'pending',
relay_request_id text,
upstream_status integer,
upstream_reason text,
failure_message text,
created_at timestamptz NOT NULL DEFAULT now(),
updated_at timestamptz NOT NULL DEFAULT now(),
UNIQUE (notification_delivery_id, push_device_id, trigger_type)
) ON COMMIT PRESERVE ROWS;
`); err != nil {
t.Fatalf("create temp notification push tables: %v", err)
}
if _, err := pool.Exec(ctx, `
INSERT INTO push_devices
(id, user_id, profile_id, device_id, platform, provider, apns_environment, apns_topic,
apns_token_ciphertext, apns_token_hash, server_device_id, push_mode, enabled)
VALUES
('device-private', 42, 'profile-1', 'local-private', 'apple', 'silo_relay', 'sandbox',
'org.siloserver.silo', 'ciphertext', 'hash-1', 'server-private', 'private_push', true),
('device-in-app', 42, 'profile-1', 'local-in-app', 'apple', 'silo_relay', 'sandbox',
'org.siloserver.silo', 'ciphertext', 'hash-2', 'server-in-app', 'in_app_only', true),
('device-disabled', 42, 'profile-1', 'local-disabled', 'apple', 'silo_relay', 'sandbox',
'org.siloserver.silo', 'ciphertext', 'hash-3', 'server-disabled', 'private_push', false),
('device-other-profile', 42, 'profile-2', 'local-other', 'apple', 'silo_relay', 'sandbox',
'org.siloserver.silo', 'ciphertext', 'hash-4', 'server-other', 'private_push', true)
`); err != nil {
t.Fatalf("seed push devices: %v", err)
}
system := &System{
pool: pool,
Settings: NewSettings(mapSettingReader{SettingApplePushDeliveryEnabled: "true"}),
Deliveries: NewDeliveryRepository(pool),
pushDeviceRepo: NewPushDeviceRepository(pool),
dispatcher: NewMultiDispatcher(),
logger: slog.New(slog.DiscardHandler),
}
inserted, err := system.DispatchOperational(ctx, Delivery{
ID: "delivery-request-1",
UserID: 42,
ProfileID: "profile-1",
Type: DeliveryTypeRequestFulfilled,
ReasonFlags: []byte(`{}`),
}, OperationalDispatch{})
if err != nil {
t.Fatalf("dispatch operational: %v", err)
}
if inserted == nil || inserted.ID != "delivery-request-1" {
t.Fatalf("inserted = %+v", inserted)
}
var deliveryID, pushDeviceID, triggerType, provider, platform, outcome string
if err := pool.QueryRow(ctx, `
SELECT notification_delivery_id, push_device_id, trigger_type, provider, platform, outcome
FROM push_delivery_attempts
`).Scan(&deliveryID, &pushDeviceID, &triggerType, &provider, &platform, &outcome); err != nil {
t.Fatalf("query push attempt: %v", err)
}
if deliveryID != inserted.ID ||
pushDeviceID != "device-private" ||
triggerType != PushTriggerDelivery ||
provider != PushProviderSiloRelay ||
platform != PushPlatformApple ||
outcome != PushOutcomePending {
t.Fatalf("unexpected push attempt: delivery=%q device=%q trigger=%q provider=%q platform=%q outcome=%q",
deliveryID, pushDeviceID, triggerType, provider, platform, outcome)
}
var count int
if err := pool.QueryRow(ctx, `SELECT count(*) FROM push_delivery_attempts`).Scan(&count); err != nil {
t.Fatalf("count push attempts: %v", err)
}
if count != 1 {
t.Fatalf("push attempt count = %d, want 1", count)
}
}