From bf7ac6535ca07ed04f15b060f816bada9fc52580 Mon Sep 17 00:00:00 2001 From: Sam Catlow Date: Tue, 27 Oct 2026 20:51:46 +1100 Subject: [PATCH] fix(staterpc): record internal identity errors on the request span instead of slog --- .../staterpc/account_security.go | 8 +++---- internal/infrastructure/staterpc/accounts.go | 16 ++++++------- .../infrastructure/staterpc/authentication.go | 12 +++++----- .../infrastructure/staterpc/identities.go | 24 +++++++++---------- .../staterpc/personal_tokens.go | 10 ++++---- 5 files changed, 35 insertions(+), 35 deletions(-) diff --git a/internal/infrastructure/staterpc/account_security.go b/internal/infrastructure/staterpc/account_security.go index b61f047ec..de006c1eb 100644 --- a/internal/infrastructure/staterpc/account_security.go +++ b/internal/infrastructure/staterpc/account_security.go @@ -26,7 +26,7 @@ func (s *accountServer) OpenAccountSession(ctx context.Context, r *pb.OpenAccoun } value, err := store.OpenAccountSession(ctx, timeValue(r.ExpiresAt)) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.OpenAccountSessionResponse{Identity: identityProto(value.Identity), Token: value.Token, ExpiresAt: timestamp(value.Expires)}, nil } @@ -36,7 +36,7 @@ func (s *accountServer) RequireFreshAccountSession(ctx context.Context, r *pb.Re if err != nil { return nil, err } - return &pb.RequireFreshAccountSessionResponse{}, accountStatus(store.RequireFreshAccountSession(ctx, r.Token)) + return &pb.RequireFreshAccountSessionResponse{}, accountStatus(ctx, store.RequireFreshAccountSession(ctx, r.Token)) } func (s *accountServer) CreateAccountRecovery(ctx context.Context, _ *pb.CreateAccountRecoveryRequest) (*pb.CreateAccountRecoveryResponse, error) { @@ -46,7 +46,7 @@ func (s *accountServer) CreateAccountRecovery(ctx context.Context, _ *pb.CreateA } code, err := store.CreateAccountRecovery(ctx) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.CreateAccountRecoveryResponse{Code: code}, nil } @@ -56,7 +56,7 @@ func (s *accountServer) RecoverAccount(ctx context.Context, r *pb.RecoverAccount if err != nil { return nil, err } - return &pb.RecoverAccountResponse{}, accountStatus(store.RecoverAccount(ctx, r.Email, r.Code, r.Password)) + return &pb.RecoverAccountResponse{}, accountStatus(ctx, store.RecoverAccount(ctx, r.Email, r.Code, r.Password)) } func (c *Client) OpenAccountSession(ctx context.Context, expires time.Time) (identity.AccountSession, error) { diff --git a/internal/infrastructure/staterpc/accounts.go b/internal/infrastructure/staterpc/accounts.go index e699ad4f3..e0978bac5 100644 --- a/internal/infrastructure/staterpc/accounts.go +++ b/internal/infrastructure/staterpc/accounts.go @@ -13,7 +13,7 @@ import ( infraaccess "github.com/samcharles93/archie-core/internal/infrastructure/access" ) -func accountStatus(err error) error { +func accountStatus(ctx context.Context, err error) error { if err == nil { return nil } @@ -23,7 +23,7 @@ func accountStatus(err error) error { case errors.Is(err, identity.ErrCredentialRejected): return status.Error(codes.Unauthenticated, "credentials not accepted") default: - return identityStatus(err) + return identityStatus(ctx, err) } } @@ -51,7 +51,7 @@ func (s *accountServer) AccountSetup(ctx context.Context, _ *pb.AccountSetupRequ return nil, err } required, err := store.AccountSetupRequired(ctx) - return &pb.AccountSetupResponse{Required: required}, accountStatus(err) + return &pb.AccountSetupResponse{Required: required}, accountStatus(ctx, err) } func (s *accountServer) RegisterAccount(ctx context.Context, r *pb.RegisterAccountRequest) (*pb.RegisterAccountResponse, error) { @@ -66,7 +66,7 @@ func (s *accountServer) RegisterAccount(ctx context.Context, r *pb.RegisterAccou } value, err := store.RegisterAccount(ctx, identity.AccountRegistration{Email: r.Email, DisplayName: r.DisplayName, Password: r.Password, Role: r.Role, OrganisationName: r.OrganisationName, WorkspaceName: r.WorkspaceName, PublicURL: r.PublicUrl}, r.Bootstrap) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.RegisterAccountResponse{Identity: identityProto(value)}, nil } @@ -78,7 +78,7 @@ func (s *accountServer) SignInAccount(ctx context.Context, r *pb.SignInAccountRe } value, err := store.SignInAccount(ctx, r.Email, r.Password) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.SignInAccountResponse{Identity: identityProto(value.Identity), Token: value.Token, ExpiresAt: timestamp(value.Expires)}, nil } @@ -90,7 +90,7 @@ func (s *accountServer) ResolveAccountSession(ctx context.Context, r *pb.Resolve } value, err := store.ResolveAccountSession(ctx, r.Token) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.ResolveAccountSessionResponse{Identity: identityProto(value)}, nil } @@ -100,7 +100,7 @@ func (s *accountServer) SignOutAccount(ctx context.Context, r *pb.SignOutAccount if err != nil { return nil, err } - return &pb.SignOutAccountResponse{}, accountStatus(store.SignOutAccount(ctx, r.Token)) + return &pb.SignOutAccountResponse{}, accountStatus(ctx, store.SignOutAccount(ctx, r.Token)) } func (s *accountServer) ChangeAccountPassword(ctx context.Context, r *pb.ChangeAccountPasswordRequest) (*pb.ChangeAccountPasswordResponse, error) { @@ -108,7 +108,7 @@ func (s *accountServer) ChangeAccountPassword(ctx context.Context, r *pb.ChangeA if err != nil { return nil, err } - return &pb.ChangeAccountPasswordResponse{}, accountStatus(store.ChangeAccountPassword(ctx, r.CurrentPassword, r.NewPassword)) + return &pb.ChangeAccountPasswordResponse{}, accountStatus(ctx, store.ChangeAccountPassword(ctx, r.CurrentPassword, r.NewPassword)) } func (c *Client) AccountSetupRequired(ctx context.Context) (bool, error) { diff --git a/internal/infrastructure/staterpc/authentication.go b/internal/infrastructure/staterpc/authentication.go index e67f944cc..fce6109d4 100644 --- a/internal/infrastructure/staterpc/authentication.go +++ b/internal/infrastructure/staterpc/authentication.go @@ -25,7 +25,7 @@ func (s *accountServer) GetAuthenticationSettings(ctx context.Context, _ *pb.Get } value, err := store.AuthenticationSettings(ctx) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.GetAuthenticationSettingsResponse{Settings: authenticationProto(value)}, nil } @@ -35,7 +35,7 @@ func (s *accountServer) SaveAuthenticationSettings(ctx context.Context, r *pb.Sa if !ok { return nil, status.Error(codes.Unavailable, "authentication settings unavailable") } - return &pb.SaveAuthenticationSettingsResponse{}, accountStatus(store.SaveAuthenticationSettings(ctx, authenticationValue(r.Settings))) + return &pb.SaveAuthenticationSettingsResponse{}, accountStatus(ctx, store.SaveAuthenticationSettings(ctx, authenticationValue(r.Settings))) } func (c *Client) AuthenticationSettings(ctx context.Context) (identity.AuthenticationSettings, error) { @@ -66,7 +66,7 @@ func (s *accountServer) BeginPasskey(ctx context.Context, r *pb.BeginPasskeyRequ } value, err := store.BeginPasskey(ctx, r.Registration) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.BeginPasskeyResponse{Token: value.Token, Options: value.Options}, nil } @@ -78,7 +78,7 @@ func (s *accountServer) FinishPasskey(ctx context.Context, r *pb.FinishPasskeyRe } value, err := store.FinishPasskey(ctx, r.Token, r.Credential, r.Registration, r.Name) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } return &pb.FinishPasskeyResponse{Identity: identityProto(value.Identity), Token: value.Token, ExpiresAt: timestamp(value.Expires)}, nil } @@ -90,7 +90,7 @@ func (s *accountServer) ListPasskeys(ctx context.Context, _ *pb.ListPasskeysRequ } values, err := store.ListPasskeys(ctx) if err != nil { - return nil, accountStatus(err) + return nil, accountStatus(ctx, err) } out := &pb.ListPasskeysResponse{} for _, value := range values { @@ -104,7 +104,7 @@ func (s *accountServer) DeletePasskey(ctx context.Context, r *pb.DeletePasskeyRe if err != nil { return nil, err } - return &pb.DeletePasskeyResponse{}, accountStatus(store.DeletePasskey(ctx, r.Id)) + return &pb.DeletePasskeyResponse{}, accountStatus(ctx, store.DeletePasskey(ctx, r.Id)) } func (c *Client) BeginPasskey(ctx context.Context, registration bool) (identity.PasskeyCeremony, error) { diff --git a/internal/infrastructure/staterpc/identities.go b/internal/infrastructure/staterpc/identities.go index d656a4c0b..e56bb6ec1 100644 --- a/internal/infrastructure/staterpc/identities.go +++ b/internal/infrastructure/staterpc/identities.go @@ -3,9 +3,9 @@ package staterpc import ( "context" "errors" - "log/slog" "time" + "go.opentelemetry.io/otel/trace" "google.golang.org/grpc/codes" "google.golang.org/grpc/status" "google.golang.org/protobuf/types/known/timestamppb" @@ -21,7 +21,7 @@ func (s *identityServer) ListIdentities(ctx context.Context, _ *pb.ListIdentitie } values, err := s.deps.Identities.List(ctx) if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } out := make([]*pb.Identity, len(values)) for i := range values { @@ -36,7 +36,7 @@ func (s *identityServer) GetIdentity(ctx context.Context, request *pb.GetIdentit value, err = s.deps.Identities.ResolveLegacyName(ctx, request.Id) } if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.GetIdentityResponse{Identity: identityProto(value)}, nil } @@ -47,7 +47,7 @@ func (s *identityServer) CreateIdentity(ctx context.Context, request *pb.CreateI value, err = s.deps.Identities.Create(ctx, value, identityAudit(request.Audit)) } if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.CreateIdentityResponse{Identity: identityProto(value)}, nil } @@ -79,12 +79,12 @@ func (s *identityServer) ResolveIdentitySubject(ctx context.Context, request *pb subject := identity.Subject{Issuer: request.Issuer, Subject: request.Subject} if subject.Issuer == identity.PersonalTokenIssuer && s.deps.PersonalTokens != nil { if err := identity.UsePersonalToken(ctx, s.deps.PersonalTokens, subject, time.Now()); err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } } value, err := s.deps.SubjectBindings.ResolveSubject(ctx, subject) if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.ResolveIdentitySubjectResponse{Identity: identityProto(value)}, nil } @@ -97,7 +97,7 @@ func (s *identityServer) ClaimIdentitySubject(ctx context.Context, request *pb.C identity.Subject{Issuer: request.Issuer, Subject: request.Placeholder}, identity.Subject{Issuer: request.Issuer, Subject: request.Subject}) if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.ClaimIdentitySubjectResponse{Identity: identityProto(value)}, nil } @@ -108,11 +108,11 @@ func (s *identityServer) BindIdentitySubject(ctx context.Context, request *pb.Bi } subject := identity.Subject{Issuer: request.Issuer, Subject: request.Subject} if err := s.deps.SubjectBindings.BindSubject(ctx, identity.IdentityID(request.Id), subject, identityAudit(request.Audit)); err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } value, err := s.deps.Identities.Get(ctx, identity.IdentityID(request.Id)) if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.BindIdentitySubjectResponse{Identity: identityProto(value)}, nil } @@ -142,7 +142,7 @@ func (c *Client) BindSubject(ctx context.Context, id identity.IdentityID, subjec func (s *server) applyIdentityCommand(ctx context.Context, id string, version int64, audit *pb.IdentityAudit, command identity.Command) (identity.Identity, error) { value, err := s.deps.Identities.Apply(ctx, identity.IdentityID(id), version, command, identityAudit(audit)) if err != nil { - return identity.Identity{}, identityStatus(err) + return identity.Identity{}, identityStatus(ctx, err) } return value, nil } @@ -238,7 +238,7 @@ func auditProto(value identity.Audit) *pb.IdentityAudit { return &pb.IdentityAudit{ActorId: string(value.ActorID), Source: value.Source, RequestId: value.RequestID} } -func identityStatus(err error) error { +func identityStatus(ctx context.Context, err error) error { switch { case errors.Is(err, org.ErrLastOwner): return mapError(err) @@ -249,7 +249,7 @@ func identityStatus(err error) error { case errors.Is(err, identity.ErrInvalid), errors.Is(err, identity.ErrIllegalTransition), errors.Is(err, identity.ErrSystemImmutable): return status.Error(codes.FailedPrecondition, err.Error()) default: - slog.Error("identity store", "err", err) + trace.SpanFromContext(ctx).RecordError(err) return status.Error(codes.Internal, "internal state store error") } } diff --git a/internal/infrastructure/staterpc/personal_tokens.go b/internal/infrastructure/staterpc/personal_tokens.go index e6152dd09..6ecfc2215 100644 --- a/internal/infrastructure/staterpc/personal_tokens.go +++ b/internal/infrastructure/staterpc/personal_tokens.go @@ -23,7 +23,7 @@ func (s *server) tokenOwner(ctx context.Context) (identity.IdentityID, error) { } p, ok := access.PrincipalFromContext(ctx) if !ok || p.IdentityID == identity.SystemID { - return "", identityStatus(fmt.Errorf("%w: personal tokens belong to a signed-in person", identity.ErrInvalid)) + return "", identityStatus(ctx, fmt.Errorf("%w: personal tokens belong to a signed-in person", identity.ErrInvalid)) } return p.IdentityID, nil } @@ -31,7 +31,7 @@ func (s *server) tokenOwner(ctx context.Context) (identity.IdentityID, error) { // tokenSubject validates a token ID: the hex SHA-256 the token binds as. func tokenSubject(id string) (identity.Subject, error) { if raw, err := hex.DecodeString(id); err != nil || len(raw) != 32 { - return identity.Subject{}, identityStatus(fmt.Errorf("%w: invalid token id", identity.ErrInvalid)) + return identity.Subject{}, status.Error(codes.FailedPrecondition, "invalid token id") } return identity.Subject{Issuer: identity.PersonalTokenIssuer, Subject: id}, nil } @@ -51,7 +51,7 @@ func (s *accountServer) AddPersonalToken(ctx context.Context, r *pb.AddPersonalT return nil, err } if err := s.deps.PersonalTokens.BindPersonalToken(ctx, owner, subject, r.GetName(), optionalTime(r.GetExpiresAt()), tokenAudit(ctx, owner, "add", r.GetId())); err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.AddPersonalTokenResponse{}, nil } @@ -63,7 +63,7 @@ func (s *accountServer) ListPersonalTokens(ctx context.Context, _ *pb.ListPerson } tokens, err := s.deps.PersonalTokens.SubjectsOf(ctx, owner, identity.PersonalTokenIssuer) if err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } out := make([]*pb.PersonalToken, 0, len(tokens)) for _, t := range tokens { @@ -85,7 +85,7 @@ func (s *accountServer) RevokePersonalToken(ctx context.Context, r *pb.RevokePer return nil, err } if err := s.deps.PersonalTokens.UnbindSubject(ctx, owner, subject, tokenAudit(ctx, owner, "revoke", r.GetId())); err != nil { - return nil, identityStatus(err) + return nil, identityStatus(ctx, err) } return &pb.RevokePersonalTokenResponse{}, nil }