Subscriptions Internal APIs #1732

GAlexIHU · 2024-10-21T13:58:42Z

Overview

Includes internal APIs for subscription Management

DB Entities

Subscription + SubscriptionPatch (with value type normalized)
Price
SubscriptionEntitlement

Interfaces

Subscription Package Connector with
- Create
- Get
- Expand
- Edit
- Cancel (no-op / panics)
"Patch" Commands for (name TBD) to be used with Create & Edit
- AddItem
- RemoveItem
- AddPhase
- RemovePhase
- ExtendPhase
SubscriptionXSpec & SubscriptionXView interfaces
- define create specifications and defacto state for Subscriptions & its subresources

Misc

Testutils for Subscriptions
Entitlement Annotations <= probably wrong implementation, annotation based Access Control checks for entitlements

TODO

Documentation
Self Review

GAlexIHU · 2024-11-03T16:31:22Z

pkg/framework/annotations/parser.go

@@ -0,0 +1,19 @@
+package annotations


This'll probably need quite a bit of changing...

The idea is, that Metadata Annotations could be used to store & pass info external to the current domain, e.g. store on an Entitlement that it belongs to a Subscription, while Entitlements in general might not have anything to do with Subscriptions...

Then, in the entitlementdriver we could check / use these annotations (in this case for disabling modifying&deleting entitlements that belong to subscriptions).

IMO the way it currently is is ugly and mostly nonsensical, at least in part its here as a placeholder, any inputs are welcome

hekike · 2024-11-04T21:58:34Z

openmeter/ent/schema/subscription_patch.go

+	"github.com/openmeterio/openmeter/pkg/framework/entutils"
+)
+
+type SubscriptionPatch struct {


nit: SubscriptionPlanOverride rhymes better to me

hekike · 2024-11-04T22:00:23Z

openmeter/ent/schema/subscription_patch.go

+func (SubscriptionPatch) Fields() []ent.Field {
+	return []ent.Field{
+		field.String("subscription_id").NotEmpty().Immutable(),
+		field.Time("applied_at").Immutable(),


is applied_at necessary if we have created_at? Can these differ?

Yes. appliedAt is programmatic time, it's kept constant through the entire use case prior creating the record and when reading the record. In practice, appliedAt will be the exact same for those in the same batch, and probably some ms / ns before createdAt

hekike · 2024-11-04T22:00:39Z

openmeter/ent/schema/subscription_patch.go

+		field.String("subscription_id").NotEmpty().Immutable(),
+		field.Time("applied_at").Immutable(),
+		field.Int("batch_index").Immutable(),
+		field.String("operation").NotEmpty().Immutable(),


should this be a type of Go enum like?
field.String("type").GoType(appentitybase.AppType("")).Immutable(),

hekike · 2024-11-04T22:02:11Z

openmeter/ent/schema/subscription_patch.go

+		field.Bool("create_entitlement_is_soft_limit").Optional().Nillable().Immutable(),
+		field.Bool("create_entitlement_preserve_overage_at_reset").Optional().Nillable().Immutable(),
+		field.String("create_entitlement_usage_period_iso_duration").Optional().Nillable().Immutable(),
+		field.JSON("create_entitlement_config", []byte{}).SchemaType(map[string]string{


can we normalize this?

This is the config of static entitlements, it cannot be normalized.

openmeter/ent/schema/subscription_patch.go

openmeter/subscription/adapter/mapping.go

hekike · 2024-11-04T22:18:28Z

openmeter/subscription/connector.go

+			return def, err
+		}
+	} else {
+		return def, &models.GenericUserError{Message: "customer already has a subscription"}


should this be a specific error?

could be a Conflict instead of a BadRequest

hekike · 2024-11-04T22:20:21Z

openmeter/subscription/entitlement/repository.go

@@ -0,0 +1,223 @@
+package subscriptionentitlement


I thought we moved to adapter and serviceinsead of repository.

hekike · 2024-11-04T22:21:39Z

openmeter/ent/schema/subscription_entitlement.go

+		index.Fields("namespace", "id"),
+		index.Fields("namespace", "entitlement_id"),
+		index.Fields("namespace", "subscription_id"),
+		index.Fields("namespace", "subscription_id", "subscription_phase_key", "subscription_item_key"),


if I'm not mistaken, PG can use partial indexes and may above not require.
But I'm fine optimizing indexes later.

I'm not sure what you mean here. I think "Partial Index" officially refers to indexes with where clauses pretty much. If you mean why all the prefixing and not just have separate indexes, it can use multiple indexes

I didn't put too much thought into this, just added the exact indexes for the queries that will be run. I don't have a preference here at this point.

tothandras

Discuss patch db before merging @hekike

feat: subscription creation wireframing refactor: move subscriptions out of productcatalog refactor: fresh start feat(subs): define interfaces and subpackages

feat: implement patch serialization feat: db structure for patches

fix: date use in subscription patches chore: uncomment methods fix: fix rebase issues

feat: add entitlement annotations feat: write patch saving feat: subscriptionView feat: write db schema for patches feat(subs): write entity mappings for repository

feat: implement price test: write command and query builders test: subscription creation without customizations test(subs): test creation with customizations

feat: test editing and fix rebase errors

hekike · 2024-11-08T17:45:41Z

openmeter/ent/schema/price.go

+	"github.com/openmeterio/openmeter/pkg/framework/entutils"
+)
+
+type Price struct {


Prefix please to SubscriptionPrice

hekike · 2024-11-08T17:46:18Z

openmeter/subscription/price.go

@@ -0,0 +1,73 @@
+package subscription


Move these to entity sub pkg please similar to:

https://github.com/openmeterio/openmeter/tree/main/openmeter/app
https://github.com/openmeterio/openmeter/tree/main/openmeter/billing
https://github.com/openmeterio/openmeter/tree/main/openmeter/customer

hekike · 2024-11-08T17:47:19Z

openmeter/subscription/connector.go

@@ -0,0 +1,388 @@
+package subscription


apply please adapter-service-entity pattern similar to:

https://github.com/openmeterio/openmeter/tree/main/openmeter/app
https://github.com/openmeterio/openmeter/tree/main/openmeter/billing
https://github.com/openmeterio/openmeter/tree/main/openmeter/customer

hekike · 2024-11-08T17:48:21Z

openmeter/ent/schema/subscription_patch.go

@@ -0,0 +1,216 @@
+package schema


we discussed internally to apply patch at write time instead of read time and store final state in db

GAlexIHU force-pushed the feat/subscriptions branch 2 times, most recently from b3e0052 to e3fb3f4 Compare November 3, 2024 16:16

GAlexIHU changed the title ~~Subscriptions P1~~ Subscriptions Internal APIs Nov 3, 2024

GAlexIHU commented Nov 3, 2024

View reviewed changes

GAlexIHU added kind/feature New feature or request release-note/feature Release note: Exciting New Features area/entitlements area/product-catalog labels Nov 3, 2024

GAlexIHU marked this pull request as ready for review November 3, 2024 16:46

GAlexIHU requested review from turip and chrisgacsal November 4, 2024 11:50

GAlexIHU force-pushed the feat/subscriptions branch from 8196f54 to b56723e Compare November 4, 2024 11:54

hekike reviewed Nov 4, 2024

View reviewed changes

tothandras requested changes Nov 5, 2024

View reviewed changes

GAlexIHU added 13 commits November 6, 2024 12:24

feat(subs): define interfaces and subpackages

0209a25

feat: subscription creation wireframing refactor: move subscriptions out of productcatalog refactor: fresh start feat(subs): define interfaces and subpackages

feat(subs): write individual patches

bb48848

feat: implement patch serialization feat: db structure for patches

fix(subs): date use in patches

e5e0b84

fix: date use in subscription patches chore: uncomment methods fix: fix rebase issues

feat(subs): subscription creation and patch saving

04082f7

feat: add entitlement annotations feat: write patch saving feat: subscriptionView feat: write db schema for patches feat(subs): write entity mappings for repository

feat(subs): implement and test create and read

c2fa00e

feat: implement price test: write command and query builders test: subscription creation without customizations test(subs): test creation with customizations

refactor(sub): marry command and query

212eb61

feat(subs): write syncing

256c9e3

test: test entity syncing

f6bf81d

feat: test editing and fix rebase errors

chore: generate migrations

ca00463

chore: remove dangling execs

0ec4a7a

fix: use patch timestamp instead of operation timestamp for validations

6fad015

chore: remove dead code

4986de4

fix(lint): fix lint errors

03dc5ef

GAlexIHU force-pushed the feat/subscriptions branch from fc3f402 to 03dc5ef Compare November 6, 2024 11:35

feat: incorporate new price types

213296f

hekike reviewed Nov 8, 2024

View reviewed changes

GAlexIHU mentioned this pull request Nov 14, 2024

Subscription Internals V2 #1851

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subscriptions Internal APIs #1732

Subscriptions Internal APIs #1732

GAlexIHU commented Oct 21, 2024 •

edited

Loading

GAlexIHU Nov 3, 2024

hekike Nov 4, 2024

hekike Nov 4, 2024

GAlexIHU Nov 5, 2024

hekike Nov 4, 2024

hekike Nov 4, 2024

GAlexIHU Nov 5, 2024

hekike Nov 4, 2024

GAlexIHU Nov 5, 2024

hekike Nov 4, 2024 •

edited

Loading

hekike Nov 4, 2024

GAlexIHU Nov 5, 2024

tothandras left a comment

hekike Nov 8, 2024

hekike Nov 8, 2024

hekike Nov 8, 2024

hekike Nov 8, 2024 •

edited

Loading

Subscriptions Internal APIs #1732

Are you sure you want to change the base?

Subscriptions Internal APIs #1732

Conversation

GAlexIHU commented Oct 21, 2024 • edited Loading

Overview

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hekike Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tothandras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hekike Nov 8, 2024 • edited Loading

Choose a reason for hiding this comment

GAlexIHU commented Oct 21, 2024 •

edited

Loading

hekike Nov 4, 2024 •

edited

Loading

hekike Nov 8, 2024 •

edited

Loading