Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove flows from log messages #3913

Merged
merged 8 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions internal/client-go/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5y
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e h1:bRhVy7zSSasaqNksaRZiA5EEI+Ei4I1nO5Jh72wfHlg=
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4 h1:YUO/7uOKsKeq9UokNS62b8FYywz3ker1l1vDZRCRefw=
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
Expand Down
6 changes: 4 additions & 2 deletions selfservice/flow/login/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,12 @@ func (s *ErrorHandler) PrepareReplacementForExpiredFlow(w http.ResponseWriter, r
}

func (s *ErrorHandler) WriteFlowError(w http.ResponseWriter, r *http.Request, f *Flow, group node.UiNodeGroup, err error) {
s.d.Audit().
logger := s.d.Audit().
WithError(err).
WithRequest(r).
WithField("login_flow", f).
WithField("login_flow", f.ToLoggerField())

logger.
Info("Encountered self-service login error.")

if f == nil {
Expand Down
17 changes: 17 additions & 0 deletions selfservice/flow/login/flow.go
Original file line number Diff line number Diff line change
Expand Up @@ -327,3 +327,20 @@ func (f *Flow) ContinueWith() []flow.ContinueWith {
func (f *Flow) SetReturnToVerification(to string) {
f.ReturnToVerification = to
}

func (f *Flow) ToLoggerField() map[string]interface{} {
if f == nil {
return map[string]interface{}{}
}
return map[string]interface{}{
"id": f.ID.String(),
"return_to": f.ReturnTo,
"request_url": f.RequestURL,
"active": f.Active,
"type": f.Type,
"nid": f.NID,
"state": f.State,
"refresh": f.Refresh,
"requested_aal": f.RequestedAAL,
}
}
6 changes: 4 additions & 2 deletions selfservice/flow/recovery/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,12 @@ func (s *ErrorHandler) WriteFlowError(
group node.UiNodeGroup,
recoveryErr error,
) {
s.d.Audit().
logger := s.d.Audit().
WithError(recoveryErr).
WithRequest(r).
WithField("recovery_flow", f).
WithField("recovery_flow", f.ToLoggerField())

logger.
Info("Encountered self-service recovery error.")

if f == nil {
Expand Down
15 changes: 15 additions & 0 deletions selfservice/flow/recovery/flow.go
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,18 @@ func (f *Flow) SetState(state State) {
func (t *Flow) GetTransientPayload() json.RawMessage {
return t.TransientPayload
}

func (f *Flow) ToLoggerField() map[string]interface{} {
if f == nil {
return map[string]interface{}{}
}
return map[string]interface{}{
"id": f.ID.String(),
"return_to": f.ReturnTo,
"request_url": f.RequestURL,
"active": f.Active,
"type": f.Type,
"nid": f.NID,
"state": f.State,
}
}
8 changes: 5 additions & 3 deletions selfservice/flow/registration/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,22 +72,24 @@ func (s *ErrorHandler) PrepareReplacementForExpiredFlow(w http.ResponseWriter, r

return e.WithFlow(a), nil
}

func (s *ErrorHandler) WriteFlowError(
w http.ResponseWriter,
r *http.Request,
f *Flow,
group node.UiNodeGroup,
err error,
) {

if dup := new(identity.ErrDuplicateCredentials); errors.As(err, &dup) {
err = schema.NewDuplicateCredentialsError(dup)
}

s.d.Audit().
logger := s.d.Audit().
WithError(err).
WithRequest(r).
WithField("registration_flow", f).
WithField("registration_flow", f.ToLoggerField())

logger.
Info("Encountered self-service flow error.")

if f == nil {
Expand Down
19 changes: 17 additions & 2 deletions selfservice/flow/registration/flow.go
Original file line number Diff line number Diff line change
Expand Up @@ -272,10 +272,25 @@ func (f *Flow) SetState(state State) {
f.State = state
}

func (t *Flow) GetTransientPayload() json.RawMessage {
return t.TransientPayload
func (f *Flow) GetTransientPayload() json.RawMessage {
return f.TransientPayload
}

func (f *Flow) SetReturnToVerification(to string) {
f.ReturnToVerification = to
}

func (f *Flow) ToLoggerField() map[string]interface{} {
if f == nil {
return map[string]interface{}{}
}
return map[string]interface{}{
"id": f.ID.String(),
"return_to": f.ReturnTo,
"request_url": f.RequestURL,
"active": f.Active,
"Type": f.Type,
"nid": f.NID,
"state": f.State,
}
}
7 changes: 4 additions & 3 deletions selfservice/flow/settings/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ func (s *ErrorHandler) WriteFlowError(
id *identity.Identity,
err error,
) {
s.d.Audit().
logger := s.d.Audit().
WithError(err).
WithRequest(r).
WithField("settings_flow", f).
Info("Encountered self-service settings error.")
WithField("settings_flow", f.ToLoggerField())

logger.Info("Encountered self-service settings error.")

shouldRespondWithJSON := x.IsJSONRequest(r)
if f != nil && f.Type == flow.TypeAPI {
Expand Down
15 changes: 15 additions & 0 deletions selfservice/flow/settings/flow.go
Original file line number Diff line number Diff line change
Expand Up @@ -265,3 +265,18 @@ func (f *Flow) SetState(state State) {
func (t *Flow) GetTransientPayload() json.RawMessage {
return t.TransientPayload
}

func (f *Flow) ToLoggerField() map[string]interface{} {
if f == nil {
return map[string]interface{}{}
}
return map[string]interface{}{
"id": f.ID.String(),
"return_to": f.ReturnTo,
"request_url": f.RequestURL,
"active": f.Active,
"Type": f.Type,
"nid": f.NID,
"state": f.State,
}
}
6 changes: 4 additions & 2 deletions selfservice/flow/verification/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,12 @@ func (s *ErrorHandler) WriteFlowError(
group node.UiNodeGroup,
err error,
) {
s.d.Audit().
logger := s.d.Audit().
WithError(err).
WithRequest(r).
WithField("verification_flow", f).
WithField("verification_flow", f.ToLoggerField())

logger.
Info("Encountered self-service verification error.")

if f == nil {
Expand Down
15 changes: 15 additions & 0 deletions selfservice/flow/verification/flow.go
Original file line number Diff line number Diff line change
Expand Up @@ -297,3 +297,18 @@ func (f *Flow) SetState(state State) {
func (t *Flow) GetTransientPayload() json.RawMessage {
return t.TransientPayload
}

func (f *Flow) ToLoggerField() map[string]interface{} {
if f == nil {
return map[string]interface{}{}
}
return map[string]interface{}{
"id": f.ID.String(),
"return_to": f.ReturnTo,
"request_url": f.RequestURL,
"active": f.Active,
"Type": f.Type,
"nid": f.NID,
"state": f.State,
}
}
Loading