Subscription Internals V2

[GAlexIHU]

Overview

Supersedes #1732

Includes internal service for subscription management.

Notes for reviewer

• PR is pending until Plan types have been extracted to models. They affect a significant portion of the types, and migrations cannot be generated without them present.
• None of openmeter/subscriptions is included in application startup.

[hekike]

Do we need a key for it, isn't ID enaough? Do we expect users to name subscription items manually?

[GAlexIHU]

To avoid linking I'll copy from relevant docs

SubscriptionItem can be identified, it has a reference:

• If a Feature is associated with the SubscriptionItem, it is identified by the Feature
  • It can be an ID reference, for an exact version of the Feature (Features can change across versions)
  • It can be a Key reference, which always refers to the latest (active or inactive) version of a Feature
• If a Feature is not associated with the SubscriptionItem, it is referenced by the Price
  • We say “referenced by the Price” regardless of how a price itself is referenced, it colloquially makes sense to say “paying the same price for the same thing”
    In practice this will need an ID (key) being generated

Keys are used for identifying the "same thing" across different instances (with different IDs)

[hekike]

why isn't this a reference to plan_rate_card table?

[GAlexIHU]

It's not a direct reference to an actual plan's actual ratecard, it will only hold the same contents as a ratecard does.

[hekike]

why do we need annotations instead of just adding a readonly or editable flag like: field.Bool("readonly").NotEmpty().Immutable().Default(false) ?

[GAlexIHU]

I'm not sure I understand the question.

// pkg/models/model.go
type AnnotatedModel struct {
	Metadata map[string]string `json:"metadata,omitempty"`
}

// pkg/framework/entutils/mixin.go
// MetadataAnnotationsMixin adds metadata to the schema
type MetadataAnnotationsMixin struct {
	mixin.Schema
}

// Fields of the IDMixin.
func (MetadataAnnotationsMixin) Fields() []ent.Field {
	return []ent.Field{
		field.JSON("metadata", map[string]string{}).
			Optional().
			SchemaType(map[string]string{
				dialect.Postgres: "jsonb",
			}),
	}
}