Skip to content

chore: error messages and names #3005

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.

Sign up for GitHub

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

Draft
GAlexIHU wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: error messages and names #3005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 23 additions & 17 deletions openmeter/productcatalog/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (

const ErrCodePlanAddonIncompatibleStatus models.ErrorCode = "plan_addon_incompatible_status"

// TODO: we need to add the Plan and Addon statuses to the validation issues (sent through HTTP response)
var ErrPlanAddonIncompatibleStatus = models.NewValidationIssue(
ErrCodePlanAddonIncompatibleStatus,
"plan status is incompatible with the addon status",
Expand All @@ -25,9 +26,9 @@ const ErrCodePlanAddonMaxQuantityMustBeSet models.ErrorCode = "plan_addon_max_qu

var ErrPlanAddonMaxQuantityMustBeSet = models.NewValidationIssue(
ErrCodePlanAddonMaxQuantityMustBeSet,
"maximum quantity must be set to positive number for add-on with multiple instance type",
"if a maximum quantity is set, it must be a positive number",
models.WithFieldString("maxQuantity"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodePlanAddonMaxQuantityMustNotBeSet models.ErrorCode = "plan_addon_max_quantity_must_not_be_set"
Expand All @@ -36,7 +37,7 @@ var ErrPlanAddonMaxQuantityMustNotBeSet = models.NewValidationIssue(
ErrCodePlanAddonMaxQuantityMustNotBeSet,
"maximum quantity must not be set for add-on with single instance type",
models.WithFieldString("maxQuantity"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodePlanAddonCurrencyMismatch models.ErrorCode = "plan_addon_currency_mismatch"
Expand All @@ -45,11 +46,12 @@ var ErrPlanAddonCurrencyMismatch = models.NewValidationIssue(
ErrCodePlanAddonCurrencyMismatch,
"currency of the plan and addon must match",
models.WithFieldString("currency"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodePlanAddonUnknownPlanPhaseKey models.ErrorCode = "plan_addon_unknown_plan_phase_key"

// TODO: show the invalid phase in the error message
var ErrPlanAddonUnknownPlanPhaseKey = models.NewValidationIssue(
ErrCodePlanAddonUnknownPlanPhaseKey,
"add-on must define valid/existing plan phase key from which the add-on is available for purchase",
Expand All @@ -65,20 +67,21 @@ var ErrRateCardKeyMismatch = models.NewValidationIssue(
ErrCodeRateCardKeyMismatch,
"key must match",
models.WithFieldString("key"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodeRateCardPriceTypeMismatch models.ErrorCode = "rate_card_price_type_mismatch"

var ErrRateCardPriceTypeMismatch = models.NewValidationIssue(
ErrCodeRateCardPriceTypeMismatch,
"price type must match",
"price model type must match",
models.WithFieldString("price"),
models.WithWarningSeverity(),
)

const ErrCodeRateCardPricePaymentTermMismatch models.ErrorCode = "rate_card_price_payment_term_mismatch"

// TODO: lets show the two payent terms (differentiate which is which in attributes)
var ErrRateCardPricePaymentTermMismatch = models.NewValidationIssue(
ErrCodeRateCardPricePaymentTermMismatch,
"price payment term must match",
Expand All @@ -90,7 +93,7 @@ const ErrCodeRateCardOnlyFlatPriceAllowed models.ErrorCode = "rate_card_only_fla

var ErrRateCardOnlyFlatPriceAllowed = models.NewValidationIssue(
ErrCodeRateCardOnlyFlatPriceAllowed,
"only flat price is allowed",
"only flat fee pricing model is allowed",
models.WithFieldString("price"),
models.WithWarningSeverity(),
)
Expand All @@ -99,7 +102,7 @@ const ErrCodeRateCardFeatureIDMismatch models.ErrorCode = "rate_card_feature_id_

var ErrRateCardFeatureIDMismatch = models.NewValidationIssue(
ErrCodeRateCardFeatureIDMismatch,
"feature identifiers id must match",
"feature id must match",
models.WithFieldString("featureId"),
models.WithWarningSeverity(),
)
Expand Down Expand Up @@ -135,7 +138,7 @@ const ErrCodeRateCardStaticEntitlementTemplateNotAllowed models.ErrorCode = "rat

var ErrRateCardStaticEntitlementTemplateNotAllowed = models.NewValidationIssue(
ErrCodeRateCardStaticEntitlementTemplateNotAllowed,
"static entitlement template is not allowed",
"static entitlement is not allowed",
models.WithFieldString("type"),
models.WithWarningSeverity(),
)
Expand All @@ -153,25 +156,26 @@ const ErrCodeRateCardPercentageDiscountNotAllowed models.ErrorCode = "rate_card_

var ErrRateCardPercentageDiscountNotAllowed = models.NewValidationIssue(
ErrCodeRateCardPercentageDiscountNotAllowed,
"percentage discount is not allowed",
"ratecards cannot both contain percentage discount",
models.WithFieldString("percentage"),
models.WithWarningSeverity(),
)

const ErrCodeRateCardDuplicatedKey models.ErrorCode = "rate_card_duplicated_key"

// TODO: lets add
var ErrRateCardDuplicatedKey = models.NewValidationIssue(
ErrCodeRateCardDuplicatedKey,
"duplicated key",
models.WithFieldString("key"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodeRateCardEntitlementTemplateWithNoFeature models.ErrorCode = "entitlement_template_with_no_feature"

var ErrRateCardEntitlementTemplateWithNoFeature = models.NewValidationIssue(
ErrCodeRateCardEntitlementTemplateWithNoFeature,
"entitlement template requires feature to be associated with",
"entitlement template requires feature",
models.WithFieldString("featureKey"),
models.WithWarningSeverity(),
)
Expand Down Expand Up @@ -263,7 +267,7 @@ var ErrUsageDiscountNegativeQuantity = models.NewValidationIssue(
ErrCodeUsageDiscountNegativeQuantity,
"usage must be greater than 0",
models.WithFieldString("quantity"),
models.WithWarningSeverity(),
models.WithCriticalSeverity(),
)

const ErrCodeUsageDiscountWithFlatPrice models.ErrorCode = "usage_discount_with_flat_price"
Expand Down Expand Up @@ -332,6 +336,7 @@ var ErrAddonInvalidInstanceType = models.NewValidationIssue(

const ErrCodeAddonInvalidStatus models.ErrorCode = "addon_invalid_status"

// TODO: add what the allowed statuses are as this error is reused for multiple statuses
var ErrAddonInvalidStatus = models.NewValidationIssue(
ErrCodeAddonInvalidStatus,
"invalid status",
Expand Down Expand Up @@ -446,6 +451,7 @@ var ErrPlanPhaseDurationLessThenAnHour = models.NewValidationIssue(

const ErrCodePlanInvalidStatus models.ErrorCode = "plan_invalid_status"

// TODO: lets show the status and the allowed values
var ErrPlanInvalidStatus = models.NewValidationIssue(
ErrCodePlanInvalidStatus,
"invalid status",
Expand Down Expand Up @@ -489,11 +495,11 @@ var ErrPlanPhaseHasNoRateCards = models.NewValidationIssue(
models.WithWarningSeverity(),
)

const ErrCodePlanHasIncompatibleAddon models.ErrorCode = "plan_has_incompatible_addon"
const ErrCodePlanCannotBePublishedWithAddonAssignmentErrors models.ErrorCode = "plan_cannot_be_published_with_addon_assignment_errors"

var ErrPlanHasIncompatibleAddon = models.NewValidationIssue(
ErrCodePlanHasIncompatibleAddon,
"plan has incompatible add-on assignment",
var ErrPlanCannotBePublishedWithAddonAssignmentErrors = models.NewValidationIssue(
ErrCodePlanCannotBePublishedWithAddonAssignmentErrors,
"plan cannot be published with incompatible add-ons",
models.WithWarningSeverity(),
)

Expand Down
2 changes: 1 addition & 1 deletion openmeter/productcatalog/plan/service/plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ func (s service) PublishPlan(ctx context.Context, params plan.PublishPlanInput)

if err = planAddon.Validate(); err != nil {
errs = append(errs, fmt.Errorf("incompatible add-on assignement [id=%s, key=%s, version=%d]: %w",
addon.ID, addon.Key, addon.Version, productcatalog.ErrPlanHasIncompatibleAddon),
addon.ID, addon.Key, addon.Version, productcatalog.ErrPlanCannotBePublishedWithAddonAssignmentErrors),
)
}
}
Expand Down
2 changes: 2 additions & 0 deletions openmeter/productcatalog/ratecard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ func (r *FlatFeeRateCard) Validate() error {
}

// Billing Cadence has to be at least 1 hour
// FIXME: using per.Sign() is invalid
if per, err := r.BillingCadence.Subtract(isodate.NewPeriod(0, 0, 0, 0, 1, 0, 0)); err == nil && per.Sign() == -1 {
errs = append(errs, ErrBillingCadenceInvalidValue)
}
Expand Down Expand Up @@ -482,6 +483,7 @@ func (r *UsageBasedRateCard) Validate() error {
}

// Billing Cadence has to be at least 1 hour
// FIXME: using per.Sign() is invalid
if per, err := r.BillingCadence.Subtract(isodate.NewPeriod(0, 0, 0, 0, 1, 0, 0)); err == nil && per.Sign() == -1 {
errs = append(errs, ErrBillingCadenceInvalidValue)
}
Expand Down
Loading