chore: err113 (#906)

Author: FoseFx

.golangci.yaml

@@ -28,7 +28,6 @@ linters:
     # TODOs: #865
     - cyclop # TODO
     - dupl # TODO
-    - err113 # TODO
     - exhaustruct # TODO
     - gci # TODO
     - gocognit # TODO

libs/common/hwerr/err.go

@@ -2,10 +2,12 @@ package hwerr
 
 import (
 	"context"
+	"fmt"
 	"hwlocale"
 
 	zlog "github.com/rs/zerolog"
 	"google.golang.org/genproto/googleapis/rpc/errdetails"
+	genstatus "google.golang.org/genproto/googleapis/rpc/status"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/protoadapt"
@@ -54,3 +56,27 @@ func LocalizedMessage(ctx context.Context, locale hwlocale.Locale) *errdetails.L
 		Message: str,
 	}
 }
+
+type InvalidEnumError struct {
+	Enum  string
+	Value string
+}
+
+func (e InvalidEnumError) Error() string {
+	return fmt.Sprintf("invalid enum: %q is not a valid %q", e.Value, e.Enum)
+}
+
+// ProtoStatusError implements the Error interface on *genstatus.Status
+type ProtoStatusError struct {
+	status *genstatus.Status
+}
+
+func (e ProtoStatusError) Error() string {
+	return e.status.GetMessage()
+}
+
+func NewProtoStatusError(status *genstatus.Status) ProtoStatusError {
+	return ProtoStatusError{
+		status: status,
+	}
+}

libs/common/hwgrpc/auth_interceptor.go

@@ -63,7 +63,7 @@ func authInterceptor(ctx context.Context) (context.Context, error) {
 			Msg("only fake auth is enabled! no attempt verifying token. falling back to fake token instead")
 		claims, tokenExpires, err = auth.VerifyFakeToken(ctx, token)
 	} else {
-		// verify token -> if fakeToken is used claims will be nil and we will get an error
+		// verify token -> if fakeToken is used claims will be nil, and we will get an error
 		claims, tokenExpires, err = auth.VerifyIDToken(ctx, token)
 	}
 

libs/common/hwgrpc/organization_interceptor.go

@@ -49,6 +49,8 @@ func StreamOrganizationInterceptor(
 	return next(req, stream)
 }
 
+var ErrOrganizationIdMissing = errors.New("organization.id missing in id token")
+
 // organizationInterceptor parses and injects the organization id of the OIDC claims into the current context
 // This is a separate function to allow endpoints to not fail when an organization id is not provided
 func organizationInterceptor(ctx context.Context) (context.Context, error) {
@@ -61,7 +63,7 @@ func organizationInterceptor(ctx context.Context) (context.Context, error) {
 	}
 
 	if len(claims.Organization.Id) == 0 {
-		return nil, errors.New("organization.id missing in id token")
+		return nil, ErrOrganizationIdMissing
 	}
 
 	// parse organizationID

libs/common/otel.go

@@ -128,6 +128,8 @@ func newTraceProvider(ctx context.Context, res *resource.Resource) (*trace.Trace
 	return traceProvider, nil
 }
 
+var ErrOtelTraceExporterInvalid = errors.New("OTEL_TRACE_EXPORTER invalid")
+
 // newTraceExporter returns a new trace.SpanExporter based on the OTEL_TRACE_EXPORTER env variable
 // A SpanExporter pushes traces to a tracing database. For more configuration see the corresponding documentation.
 func newTraceExporter(ctx context.Context) (trace.SpanExporter, error) {
@@ -145,6 +147,6 @@ func newTraceExporter(ctx context.Context) (trace.SpanExporter, error) {
 		// more info: https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/[email protected]
 		return otlptracehttp.New(ctx)
 	default:
-		return nil, errors.New("OTEL_TRACE_EXPORTER invalid")
+		return nil, ErrOtelTraceExporterInvalid
 	}
 }

libs/hwauthz/spicedb/spicedb.go

@@ -1,6 +1,7 @@
 package spicedb
 
 import (
+	"common/hwerr"
 	"context"
 	"errors"
 	"fmt"
@@ -217,7 +218,7 @@ func (s *SpiceDBAuthZ) BulkCheck(ctx context.Context, checks []hwauthz.Permissio
 		resc := req.GetResource()
 
 		if pberr := pair.GetError(); pberr != nil {
-			err := fmt.Errorf("spicedb: error while checking permissions: %s", pberr.GetMessage())
+			err := fmt.Errorf("spicedb: error while checking permissions: %w", hwerr.NewProtoStatusError(pberr))
 			log.Error().Err(err).Msg("spicedb: error while checking permissions")
 			return nil, err
 		}

libs/hwdb/errors.go

@@ -4,11 +4,14 @@ import (
 	"common/hwerr"
 	"context"
 	"errors"
+	"fmt"
 	"hwlocale"
 	"reflect"
 	"strings"
 	"telemetry"
 
+	"github.com/google/uuid"
+
 	"github.com/jackc/pgerrcode"
 	"github.com/jackc/pgx/v5/pgconn"
 	"github.com/rs/zerolog"
@@ -261,3 +264,9 @@ func pgConnErr(ctx context.Context, connErr *pgconn.ConnectError) error {
 		Msg("connection issue")
 	return genericStatusError(ctx, "database connection issue")
 }
+
+type RecordNotFoundError uuid.UUID
+
+func (e RecordNotFoundError) Error() string {
+	return fmt.Sprintf("could not find record with id %q", uuid.UUID(e).String())
+}

libs/hwes/aggregate.go

@@ -121,6 +121,12 @@ func (a *AggregateBase) RegisterEventListener(eventType string, eventHandler eve
 	return a
 }
 
+type EventTypeInvalidError string
+
+func (e EventTypeInvalidError) Error() string {
+	return fmt.Sprintf("event type '%s' is invalid", string(e))
+}
+
 // HandleEvent finds and calls the registered event handler
 // based on the type of the passed event.
 // The executed event handler can modify the in-memory data of the aggregate.
@@ -133,7 +139,7 @@ func (a *AggregateBase) HandleEvent(event Event) error {
 
 	eventHandler, found := a.eventHandlers[event.EventType]
 	if !found {
-		return fmt.Errorf("event type '%s' is invalid", event.EventType)
+		return EventTypeInvalidError(event.EventType)
 	}
 
 	if err := eventHandler(event); err != nil {
@@ -155,13 +161,27 @@ func (a *AggregateBase) ClearUncommittedEvents() {
 	a.uncommittedEvents = make([]Event, 0)
 }
 
+type EventAggregateMismatchError struct {
+	Targeted uuid.UUID
+	Got      uuid.UUID
+}
+
+func (e EventAggregateMismatchError) Error() string {
+	return fmt.Sprintf("event applied to aggregate %q but was targeted at aggregate %q",
+		e.Got.String(), e.Targeted.String())
+}
+
+var ErrLoadDeletedAggregate = errors.New("AggregateBase.Load: aggregate has been marked as deleted")
+
 // Load applies events to an aggregate by utilizing the registered event listeners
 // Currently not in use. Could be helpful for testing.
 func (a *AggregateBase) Load(events []Event) error {
 	for _, event := range events {
 		if event.GetAggregateID() != a.GetID() {
-			return fmt.Errorf("event applied to aggregate '%s' but was targeted at aggregate '%s'",
-				a.GetID(), event.GetAggregateID())
+			return fmt.Errorf("AggregateBase.Load: %w", EventAggregateMismatchError{
+				Targeted: a.GetID(),
+				Got:      event.GetAggregateID(),
+			})
 		}
 
 		if err := a.HandleEvent(event); err != nil {
@@ -172,7 +192,7 @@ func (a *AggregateBase) Load(events []Event) error {
 		a.version++
 	}
 	if a.IsDeleted() {
-		return errors.New("AggregateBase.Load: aggregate has been marked as deleted")
+		return fmt.Errorf("AggregateBase.Load: %w", ErrLoadDeletedAggregate)
 	}
 
 	return nil
@@ -183,8 +203,10 @@ func (a *AggregateBase) Load(events []Event) error {
 // Apply -> You apply a *new* event to the aggregate that could be persisted
 func (a *AggregateBase) Apply(event Event) error {
 	if event.GetAggregateID() != a.GetID() {
-		return fmt.Errorf("event applied to aggregate '%s' but was targeted at aggregate '%s'",
-			a.GetID(), event.GetAggregateID())
+		return fmt.Errorf("AggregateBase.Apply: %w", EventAggregateMismatchError{
+			Targeted: a.GetID(),
+			Got:      event.GetAggregateID(),
+		})
 	}
 
 	if err := a.HandleEvent(event); err != nil {
@@ -197,18 +219,29 @@ func (a *AggregateBase) Apply(event Event) error {
 	return nil
 }
 
+type EventOutOfDateError struct {
+	AggregateVersion uint64
+	EventVersion     uint64
+}
+
+func (e EventOutOfDateError) Error() string {
+	return fmt.Sprintf("event version (%d) is lower than aggregate version (%d)",
+		e.EventVersion, e.AggregateVersion)
+}
+
 // Progress should be called after all events are loaded though an aggregate store.
 // The passed event gets applied to an aggregate by utilizing the registered event listeners.
 // Progress -> You progress the state of an aggregate
 func (a *AggregateBase) Progress(event Event) error {
 	if event.GetAggregateID() != a.GetID() {
-		return fmt.Errorf("event applied to aggregate '%s' but was targeted at aggregate '%s'",
-			a.GetID(), event.GetAggregateID())
+		return fmt.Errorf("AggregateBase.Progress: %w", EventAggregateMismatchError{
+			Targeted: a.GetID(),
+			Got:      event.GetAggregateID(),
+		})
 	}
 
 	if event.GetVersion() < a.GetVersion() {
-		return fmt.Errorf("event version of %d is lower then aggregate version of %d",
-			event.GetVersion(), a.GetVersion())
+		return EventOutOfDateError{EventVersion: event.GetVersion(), AggregateVersion: a.GetVersion()}
 	}
 
 	if err := a.HandleEvent(event); err != nil {

libs/hwes/errs/errors.go

@@ -0,0 +1,21 @@
+package errs
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/google/uuid"
+)
+
+var (
+	ErrAlreadyExists       = errors.New("cannot create an already existing aggregate")
+	ErrOrganizationMissing = errors.New("organization is missing from event")
+	ErrCommitterMissing    = errors.New("committer is missing from event")
+	ErrPayloadMissing      = errors.New("payload is empty")
+)
+
+type NotFoundError uuid.UUID
+
+func (e NotFoundError) Error() string {
+	return fmt.Sprintf("record with id %s not found", uuid.UUID(e).String())
+}

libs/hwes/event.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"fmt"
 	"hwutil"
+	"hwutil/errs"
 	"strings"
 	"telemetry"
 	"time"
@@ -70,13 +71,16 @@ type metadata struct {
 func GetEventTypeOptionOfProtoMessageV1(protoMessage proto.Message) string {
 	eventTypeOption := pbEventsV1.E_EventType
 
-	protoEventType, ok := proto.GetExtension(protoMessage.ProtoReflect().Descriptor().Options(), eventTypeOption).(string)
+	descriptorOptions := protoMessage.ProtoReflect().Descriptor().Options()
+	protoEventTypeAny := proto.GetExtension(descriptorOptions, eventTypeOption)
+	protoEventType, ok := protoEventTypeAny.(string)
 	if !ok {
-		panic(fmt.Sprintf(
-			"String type assertion for eventType '%s' on protoMessage '%s' failed.",
-			eventTypeOption.TypeDescriptor().FullName(),
-			protoMessage.ProtoReflect().Descriptor().FullName(),
-		))
+		panic(
+			fmt.Errorf("not a string: eventType %q on protoMessage %q: %w",
+				eventTypeOption.TypeDescriptor().FullName(),
+				protoMessage.ProtoReflect().Descriptor().FullName(),
+				errs.NewCastError("string", protoEventTypeAny)),
+		)
 	}
 
 	if protoEventType == "" {
@@ -164,6 +168,12 @@ func NewEventFromProto(aggregate Aggregate, message proto.Message, opts ...Event
 	return event, nil
 }
 
+type StreamIdMalformedError string
+
+func (e StreamIdMalformedError) Error() string {
+	return fmt.Sprintf("cannot resolve aggregateType and aggregateID from streamID %q", string(e))
+}
+
 // resolveAggregateIDAndTypeFromStreamID extracts the aggregateID and aggregateType of a given streamID
 // See aggregate.GetTypeID
 //
@@ -181,13 +191,13 @@ func resolveAggregateIDAndTypeFromStreamID(streamID string) (aID uuid.UUID, aggr
 		aggregateTypeStr = streamIDParts[0]
 		aggregateIDStr = streamIDParts[1]
 	} else {
-		err = fmt.Errorf("cannot resolve aggregateType and aggregateID from streamID '%s'", streamID)
+		err = StreamIdMalformedError(streamID)
 		return
 	}
 
 	aggregateType = AggregateType(aggregateTypeStr)
 	if aggregateType == "" {
-		err = fmt.Errorf("resolved empty aggregateType from streamID '%s'", streamID)
+		err = StreamIdMalformedError(streamID)
 		return
 	}
 
@@ -326,9 +336,11 @@ func (e *Event) SetProtoData(message proto.Message) error {
 	return nil
 }
 
+var ErrGetJsonOnProtoData = errors.New("data of event is marked as proto, use GetProtoData instead")
+
 func (e *Event) GetJsonData(data interface{}) error {
 	if e.DataIsProto {
-		return errors.New("data of this event is marked as proto, use GetProtoData instead")
+		return ErrGetJsonOnProtoData
 	}
 
 	if jsonable, ok := data.(hwutil.JSONAble); ok {
@@ -337,9 +349,11 @@ func (e *Event) GetJsonData(data interface{}) error {
 	return json.Unmarshal(e.Data, data)
 }
 
+var ErrGetProtoOnJsonData = errors.New("data of event is not marked as proto, use GetJsonData instead")
+
 func (e *Event) GetProtoData(message proto.Message) error {
 	if !e.DataIsProto {
-		return errors.New("data of this event is not marked as proto, use GetJsonData instead")
+		return ErrGetProtoOnJsonData
 	}
 
 	return protojson.Unmarshal(e.Data, message)