Skip to content

Move back to default price #694

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
epompeii wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft

Move back to default price #694

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
138 changes: 9 additions & 129 deletions plus/bencher_billing/src/biller.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
use std::{
collections::{HashMap, HashSet},
fmt,
};
use std::{collections::HashMap, fmt};

use bencher_json::{
Email, Entitlements, LicensedPlanId, MeteredPlanId, OrganizationUuid, PlanLevel, PlanStatus,
Expand Down Expand Up @@ -36,7 +33,7 @@ use stripe_payment::{
CreatePaymentMethodCardDetailsParams, CreatePaymentMethodType,
},
};
use stripe_product::{Price, PriceId};
use stripe_product::Price;
use stripe_shared::{Customer, CustomerId};
use stripe_types::{Currency, Expandable};

Expand Down Expand Up @@ -430,13 +427,8 @@ impl Biller {
.parse()
.map_err(|e| BillingError::BadOrganizationUuid(organization.clone(), e))?;

let preferred_price_ids = self.products.preferred_price_ids(METRICS_METER_EVENT_NAME);
let subscription_items = Self::filter_subscription_items(
subscription_id,
subscription.items.data,
&preferred_price_ids,
)?;
let subscription_item = Self::get_subscription_item(subscription_id, subscription_items)?;
let subscription_item =
Self::get_subscription_item(subscription_id, subscription.items.data)?;

let current_period_start =
subscription_item
Expand Down Expand Up @@ -592,34 +584,6 @@ impl Biller {
}
}

// During the metered billing migration, a Stripe subscription may have
// multiple subscription items (old + new metered prices). This function
// filters subscription items to only those whose price ID matches one of
// the provided known price IDs, so that `get_subscription_item()` can still
// enforce its exactly-one invariant against the filtered set.
//
// Outside of migration, this is a no-op: subscriptions have one item whose
// price matches a known ID, so the filtered list is identical to the input.
fn filter_subscription_items(
subscription_id: &SubscriptionId,
subscription_items: Vec<SubscriptionItem>,
price_ids: &HashSet<&PriceId>,
) -> Result<Vec<SubscriptionItem>, BillingError> {
let total = subscription_items.len();
let filtered: Vec<_> = subscription_items
.into_iter()
.filter(|item| price_ids.contains(&item.price.id))
.collect();
if filtered.is_empty() {
Err(BillingError::NoMatchingSubscriptionItem(
subscription_id.clone(),
total,
))
} else {
Ok(filtered)
}
}

pub async fn get_metered_plan_status(
&self,
metered_plan_id: &MeteredPlanId,
Expand Down Expand Up @@ -716,11 +680,9 @@ fn into_payment_card(card: JsonCard) -> CreatePaymentMethodCardDetailsParams {

#[cfg(test)]
mod tests {
use std::collections::HashSet;

use bencher_json::{
Entitlements, MeteredPlanId, OrganizationUuid, PlanLevel, PlanStatus, UserUuid,
organization::plan::{DEFAULT_PRICE_NAME, METRICS_METER_EVENT_NAME},
organization::plan::DEFAULT_PRICE_NAME,
system::{
config::{JsonBilling, JsonProduct, JsonProducts},
payment::{JsonCard, JsonCustomer},
Expand All @@ -746,8 +708,7 @@ mod tests {
team: JsonProduct {
id: "prod_NKz5B9dGhDiSY1".into(),
metered: hmap! {
"default".to_owned() => "price_1McW12Kal5vzTlmhoPltpBAW".to_owned(),
"metrics".to_owned() => "price_1T8NRdKal5vzTlmhBfL9IdMi".to_owned(),
"default".to_owned() => "price_1T8NRdKal5vzTlmhBfL9IdMi".to_owned(),
},
licensed: hmap! {
"default".to_owned() => "price_1O4XlwKal5vzTlmh0n0wtplQ".to_owned(),
Expand All @@ -756,8 +717,7 @@ mod tests {
enterprise: JsonProduct {
id: "prod_NLC7fDet2C8Nmk".into(),
metered: hmap! {
"default".to_owned() => "price_1McW2eKal5vzTlmhECLIyVQz".to_owned(),
"metrics".to_owned() => "price_1T8NStKal5vzTlmhPBxy2izR".to_owned(),
"default".to_owned() => "price_1T8NStKal5vzTlmhPBxy2izR".to_owned(),
},
licensed: hmap! {
"default".to_owned() => "price_1O4Xo1Kal5vzTlmh1KrcEbq0".to_owned(),
Expand Down Expand Up @@ -940,86 +900,6 @@ mod tests {
}
}

#[test]
fn filter_subscription_items_single_match() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let known: stripe_product::PriceId = "price_known".parse().unwrap();
let items = vec![
make_subscription_item("price_known"),
make_subscription_item("price_unknown"),
];
let price_ids = HashSet::from([&known]);
let filtered = Biller::filter_subscription_items(&sub_id, items, &price_ids).unwrap();
assert_eq!(filtered.len(), 1);
assert_eq!(filtered.first().unwrap().price.id, known);
}

#[test]
fn filter_subscription_items_no_match() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let known: stripe_product::PriceId = "price_known".parse().unwrap();
let items = vec![
make_subscription_item("price_a"),
make_subscription_item("price_b"),
];
let price_ids = HashSet::from([&known]);
let err = Biller::filter_subscription_items(&sub_id, items, &price_ids).unwrap_err();
assert!(
matches!(err, crate::BillingError::NoMatchingSubscriptionItem(id, 2) if id == sub_id)
);
}

#[test]
fn filter_subscription_items_empty_input() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let known: stripe_product::PriceId = "price_known".parse().unwrap();
let price_ids = HashSet::from([&known]);
let err = Biller::filter_subscription_items(&sub_id, vec![], &price_ids).unwrap_err();
assert!(
matches!(err, crate::BillingError::NoMatchingSubscriptionItem(id, 0) if id == sub_id)
);
}

#[test]
fn filter_subscription_items_all_match() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let known: stripe_product::PriceId = "price_known".parse().unwrap();
let items = vec![make_subscription_item("price_known")];
let price_ids = HashSet::from([&known]);
let filtered = Biller::filter_subscription_items(&sub_id, items, &price_ids).unwrap();
assert_eq!(filtered.len(), 1);
assert_eq!(filtered.first().unwrap().price.id, known);
}

#[test]
fn filter_subscription_items_multiple_known_ids() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let known_a: stripe_product::PriceId = "price_a".parse().unwrap();
let known_b: stripe_product::PriceId = "price_b".parse().unwrap();
let items = vec![
make_subscription_item("price_a"),
make_subscription_item("price_b"),
make_subscription_item("price_c"),
];
let price_ids = HashSet::from([&known_a, &known_b]);
let filtered = Biller::filter_subscription_items(&sub_id, items, &price_ids).unwrap();
assert_eq!(filtered.len(), 2);
}

#[test]
fn get_subscription_item_after_filter() {
let known: stripe_product::PriceId = "price_known".parse().unwrap();
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
let items = vec![
make_subscription_item("price_known"),
make_subscription_item("price_old_meter"),
];
let price_ids = HashSet::from([&known]);
let filtered = Biller::filter_subscription_items(&sub_id, items, &price_ids).unwrap();
let result = Biller::get_subscription_item(&sub_id, filtered).unwrap();
assert_eq!(result.price.id, known);
}

#[test]
fn get_subscription_item_no_items() {
let sub_id: stripe_billing::SubscriptionId = "sub_test".parse().unwrap();
Expand Down Expand Up @@ -1103,7 +983,7 @@ mod tests {
customer_id.clone(),
payment_method_id.clone(),
PlanLevel::Team,
METRICS_METER_EVENT_NAME.into(),
DEFAULT_PRICE_NAME.into(),
10,
)
.await;
Expand All @@ -1129,7 +1009,7 @@ mod tests {
customer_id.clone(),
payment_method_id.clone(),
PlanLevel::Enterprise,
METRICS_METER_EVENT_NAME.into(),
DEFAULT_PRICE_NAME.into(),
25,
)
.await;
Expand Down
2 changes: 0 additions & 2 deletions plus/bencher_billing/src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ pub enum BillingError {
MultipleSubscriptionItems(SubscriptionId, Box<SubscriptionItem>, Vec<SubscriptionItem>),
#[error("No subscription item for {0}")]
NoSubscriptionItem(SubscriptionId),
#[error("No matching subscription item for {0} (filtered {1} items)")]
NoMatchingSubscriptionItem(SubscriptionId, usize),
#[error("No organization for {0}")]
NoOrganization(SubscriptionId),
#[error("Failed to parse date/time for {0} {1}: {2}")]
Expand Down
41 changes: 2 additions & 39 deletions plus/bencher_billing/src/products.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
use std::collections::{HashMap, HashSet};
use std::collections::HashMap;

use bencher_json::{
organization::plan::DEFAULT_PRICE_NAME,
system::config::{JsonProduct, JsonProducts},
};
use bencher_json::system::config::{JsonProduct, JsonProducts};
use stripe::Client as StripeClient;
use stripe_product::{
Price as StripePrice, PriceId, Product as StripeProduct, ProductId, price::RetrievePrice,
Expand All @@ -26,23 +23,6 @@ impl Products {
enterprise: Product::new(client, enterprise).await?,
})
}

// During the metered billing migration, a subscription may temporarily have
// multiple subscription items (old metered + new metered). The config holds
// both price IDs under different keys: the currently-active price under
// "default" and the upcoming price under "metrics".
//
// This method returns only the price IDs for the given `preferred` key,
// falling back to "default" if the preferred key is not found.
// Once the migration cutover is complete and the old subscription items are
// removed, this filtering becomes a no-op (one item in, one item out).
pub fn preferred_price_ids(&self, preferred: &str) -> HashSet<&PriceId> {
self.team
.preferred_price_ids(preferred)
.into_iter()
.chain(self.enterprise.preferred_price_ids(preferred))
.collect()
}
}

pub struct Product {
Expand Down Expand Up @@ -72,23 +52,6 @@ impl Product {
})
}

// Returns the price IDs for the given `preferred` key, falling back to
// "default" if the preferred key is not found.
// See `Products::preferred_price_ids` for migration context.
fn preferred_price_ids(&self, preferred: &str) -> Vec<&PriceId> {
let metered_id = self
.metered
.get(preferred)
.or_else(|| self.metered.get(DEFAULT_PRICE_NAME))
.map(|p| &p.id);
let licensed_id = self
.licensed
.get(preferred)
.or_else(|| self.licensed.get(DEFAULT_PRICE_NAME))
.map(|p| &p.id);
metered_id.into_iter().chain(licensed_id).collect()
}

async fn pricing(
client: &StripeClient,
pricing: HashMap<String, String>,
Expand Down
Loading