PubSub API: standardize err msgs (#7322)

* wip Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add err consts Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * wip Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * wip, need to get latest Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm unintentional changes Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * fix dependencies Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm most of the predefined pubsub errors and convert to kitError Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm output err and make it standardized Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * cleanup Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * use kit pr that just got merged Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * use FromError() from kit Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * cleanup Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm fasthttpResponseWithKitError Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add readme and pubsub error codes Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add grpc integration tests for ones that don't require pluggable pubsub Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * --amend Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * wip, need to add pluggable pubsub to grpc, added it for http integration tests Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * cleanup Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * fix unintentional rebase change Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * gofumpt Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make lint Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * kitErrors & apiErrors -> kiterrors & apierrors Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * change fasthttpRespond -> universalFastHTTPErrorResponder && add pubsubOutbox test w/ pluggable pubsub Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add missing err Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * update apierrors.PubSubMetadataDeserialize Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm redundant err Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add log line for err Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make lint Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm go.mod changes to mv to a new PR Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * rm README since elena has it in her PR Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * fix make lint Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * pull out consts Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * resolve merge conflict issues Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make generic NotFound && NotConfigured funcs for error codes Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make lint Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * errors.As -> errors.Is and use switch instead of if based on PR feedback Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * revert back to errors.Is() to make tests pass again Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * add back ' store' to state store output for errors Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * update test since switched to generic NotFound error and fix typo Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make tests pass for state and hotreload. address error msg Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * make line more concise Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * fix some test failures. need to look into secret failure that are occuring Signed-off-by: Cassandra Coyle <cassie@diagrid.io> --------- Signed-off-by: Cassandra Coyle <cassie@diagrid.io> Co-authored-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com> Co-authored-by: Dapr Bot <56698301+dapr-bot@users.noreply.github.com>
dapr · Jan 16, 2024 · 1316322 · 1316322
1 parent cb02cff
commit 1316322
Show file tree

Hide file tree

Showing 22 changed files with 1,681 additions and 178 deletions.
diff --git a/pkg/api/errors/errors.go b/pkg/api/errors/errors.go
@@ -0,0 +1,35 @@
+package errors
+
+import (
+	"fmt"
+
+	"google.golang.org/grpc/codes"
+
+	kiterrors "github.com/dapr/kit/errors"
+)
+
+func NotFound(name string, componentType string, metadata map[string]string, grpcCode codes.Code, httpCode int, legacyTag string, reason string) error {
+	message := fmt.Sprintf("%s %s is not found", componentType, name)
+
+	return kiterrors.NewBuilder(
+		grpcCode,
+		httpCode,
+		message,
+		legacyTag,
+	).
+		WithErrorInfo(reason, metadata).
+		Build()
+}
+
+func NotConfigured(name string, componentType string, metadata map[string]string, grpcCode codes.Code, httpCode int, legacyTag string, reason string) error {
+	message := fmt.Sprintf("%s %s is not configured", componentType, name)
+
+	return kiterrors.NewBuilder(
+		grpcCode,
+		httpCode,
+		message,
+		legacyTag,
+	).
+		WithErrorInfo(reason, metadata).
+		Build()
+}
diff --git a/pkg/api/errors/pubsub.go b/pkg/api/errors/pubsub.go
@@ -0,0 +1,186 @@
+/*
+Copyright 2022 The Dapr Authors
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package errors
+
+import (
+	"fmt"
+	"net/http"
+
+	grpcCodes "google.golang.org/grpc/codes"
+
+	kiterrors "github.com/dapr/kit/errors"
+)
+
+const (
+	InFixTopic                     = "TOPIC"
+	PostFixNameEmpty               = "NAME_EMPTY"
+	PostFixMetadataDeserialization = "METADATA_DESERIALIZATION"
+	PostFixPublishMessage          = "PUBLISH_MESSAGE"
+	PostFixCloudEventCreation      = "CLOUD_EVENT_CREATION"
+	PostFixMarshalEnvelope         = "MARSHAL_ENVELOPE"
+	PostFixMarshalEvents           = "MARSHAL_EVENTS"
+	PostFixUnMarshalEvents         = "UNMARSHAL_EVENTS"
+	PostFixForbidden               = "FORBIDDEN"
+	PostFixOutbox                  = "OUTBOX"
+)
+
+func PubSubNameEmpty(name string, pubsubType string, metadata map[string]string) error {
+	message := "pubsub name is empty"
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusNotFound,
+		message,
+		"ERR_PUBSUB_EMPTY",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixNameEmpty, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubTopicEmpty(name string, pubsubType string, metadata map[string]string) error {
+	message := fmt.Sprintf("topic is empty in pubsub %s", name)
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusNotFound,
+		message,
+		"ERR_TOPIC_EMPTY",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+InFixTopic+PostFixNameEmpty, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubMetadataDeserialize(name string, pubsubType string, metadata map[string]string, err error) error {
+	message := fmt.Sprintf("failed deserializing metadata. Error: %s", err.Error())
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusBadRequest,
+		message,
+		"ERR_PUBSUB_REQUEST_METADATA",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixMetadataDeserialization, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubPublishMessage(name string, pubsubType string, topic string, err error) error {
+	message := fmt.Sprintf("error when publishing to topic %s in pubsub %s: %s", topic, name, err.Error())
+	return kiterrors.NewBuilder(
+		grpcCodes.Internal,
+		http.StatusInternalServerError,
+		message,
+		"ERR_PUBSUB_PUBLISH_MESSAGE",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixPublishMessage, map[string]string{"topic": topic, "error": err.Error()}).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubCloudEventCreation(name string, pubsubType string, metadata map[string]string) error {
+	message := "cannot create cloudevent"
+
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusInternalServerError,
+		message,
+		"ERR_PUBSUB_CLOUD_EVENTS_SER",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixCloudEventCreation, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubMarshalEnvelope(name string, topic string, pubsubType string, metadata map[string]string) error {
+	message := fmt.Sprintf("error when marshalling cloud event envelope for topic %s pubsub %s", topic, name)
+
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusInternalServerError,
+		message,
+		"ERR_PUBSUB_CLOUD_EVENTS_SER",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixMarshalEnvelope, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubMarshalEvents(name string, pubsubType string, topic string, metadata map[string]string) error {
+	message := fmt.Sprintf("error marshaling events to bytes for topic %s pubsub %s", topic, name)
+
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusBadRequest,
+		message+". error: "+metadata["error"],
+		"ERR_PUBSUB_EVENTS_SER",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixMarshalEvents, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+// PubSubUnMarshalEvents only occurs in http/api.go
+func PubSubUnMarshalEvents(name string, pubsubType string, topic string, metadata map[string]string, err error) error {
+	message := fmt.Sprintf("error when unmarshaling the request for topic %s pubsub %s: %s", topic, name, err.Error())
+
+	return kiterrors.NewBuilder(
+		grpcCodes.InvalidArgument,
+		http.StatusBadRequest,
+		message,
+		"ERR_PUBSUB_EVENTS_SER",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixUnMarshalEvents, metadata).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubPublishForbidden(name string, pubsubType string, topic string, appID string, err error) error {
+	message := fmt.Sprintf("topic %s is not allowed for app id %s", topic, appID)
+	return kiterrors.NewBuilder(
+		grpcCodes.PermissionDenied,
+		http.StatusForbidden,
+		message,
+		"ERR_PUBSUB_FORBIDDEN",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixForbidden, map[string]string{"topic": topic, "error": err.Error()}).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+// This is specifically for the error we are expecting for the api_tests. The not found
+// expected error codes are different than the existing ones for PubSubNotFound, hence
+// why this one is needed
+func PubSubTestNotFound(name string, pubsubType string, topic string, err error) error {
+	message := fmt.Sprintf("pubsub '%s' not found", name)
+	return kiterrors.NewBuilder(
+		grpcCodes.NotFound,
+		http.StatusBadRequest,
+		message,
+		"ERR_PUBSUB_NOT_FOUND",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+"TEST"+kiterrors.CodeNotFound, map[string]string{"topic": topic, "error": err.Error()}).
+		WithResourceInfo(pubsubType, name, "", message).
+		Build()
+}
+
+func PubSubOubox(appID string, err error) error {
+	message := fmt.Sprintf("error while publishing outbox message: %s", err.Error())
+	return kiterrors.NewBuilder(
+		grpcCodes.Internal,
+		http.StatusInternalServerError,
+		message,
+		"ERR_PUBLISH_OUTBOX",
+	).
+		WithErrorInfo(kiterrors.CodePrefixPubSub+PostFixOutbox, map[string]string{"appID": appID, "error": err.Error()}).
+		Build()
+}
diff --git a/pkg/api/errors/state.go b/pkg/api/errors/state.go
@@ -23,28 +23,6 @@ import (
 	kiterrors "github.com/dapr/kit/errors"
 )
 
-func StateStoreNotConfigured() error {
-	return kiterrors.NewBuilder(
-		codes.FailedPrecondition,
-		http.StatusInternalServerError,
-		"state store is not configured",
-		"ERR_STATE_STORE_NOT_CONFIGURED",
-	).
-		WithErrorInfo(kiterrors.CodePrefixStateStore+kiterrors.CodeNotConfigured, nil).
-		Build()
-}
-
-func StateStoreNotFound(storeName string) error {
-	return kiterrors.NewBuilder(
-		codes.InvalidArgument, // TODO We should change this at some point. It should be codes.NotFound, but it will be a breaking change.
-		http.StatusBadRequest,
-		fmt.Sprintf("state store %s is not found", storeName),
-		"ERR_STATE_STORE_NOT_FOUND",
-	).
-		WithErrorInfo(kiterrors.CodePrefixStateStore+kiterrors.CodeNotFound, nil).
-		Build()
-}
-
 func StateStoreInvalidKeyName(storeName string, key string, msg string) error {
 	return kiterrors.NewBuilder(
 		codes.InvalidArgument,