You've already forked AstralRinth
forked from didirus/AstralRinth
Add revenue split to affiliate codes v2 (#4672)
* wip: affiliate payouts again * Implement affiliate payout queue * Deactivate subscription affiliations on cancellation * Remove a test that never compiled in the first place * Update sqlx cache * address some PR comments * more comments * wip: handle refund charges * cargo sqlx prepare * Address PR comments * cargo sqlx prepare
This commit is contained in:
aecsocket
@@ -5,6 +5,7 @@ use crate::database::models::products_tax_identifier_item::DBProductsTaxIdentifi
|
||||
use crate::database::models::user_item::DBUser;
|
||||
use crate::database::models::user_subscription_item::DBUserSubscription;
|
||||
use crate::database::models::users_redeemals::UserRedeemal;
|
||||
use crate::database::models::users_subscriptions_affiliations::DBUsersSubscriptionsAffiliations;
|
||||
use crate::database::models::{DatabaseError, ids::*};
|
||||
use crate::database::models::{
|
||||
product_item, user_subscription_item, users_redeemals,
|
||||
@@ -22,6 +23,7 @@ use crate::routes::internal::billing::payments::*;
|
||||
use crate::util::anrok;
|
||||
use crate::util::archon::ArchonClient;
|
||||
use crate::util::archon::{CreateServerRequest, Specs};
|
||||
use crate::util::error::Context;
|
||||
use ariadne::ids::base62_impl::to_base62;
|
||||
use chrono::Utc;
|
||||
use futures::FutureExt;
|
||||
@@ -937,6 +939,15 @@ async fn unprovision_subscriptions(
|
||||
if unprovisioned {
|
||||
subscription.status = SubscriptionStatus::Unprovisioned;
|
||||
subscription.upsert(&mut transaction).await?;
|
||||
|
||||
DBUsersSubscriptionsAffiliations::deactivate(
|
||||
subscription.id,
|
||||
&mut *transaction,
|
||||
)
|
||||
.await
|
||||
.wrap_internal_err(
|
||||
"failed to deactivate subscription affiliation",
|
||||
)?;
|
||||
}
|
||||
|
||||
clear_cache_users.push(user.id);
|
||||
|
||||
272
apps/labrinth/src/queue/payouts/affiliate.rs
Normal file
272
apps/labrinth/src/queue/payouts/affiliate.rs
Normal file
@@ -0,0 +1,272 @@
|
||||
use chrono::{Datelike, Duration, TimeZone, Utc};
|
||||
use eyre::{Context, Result, eyre};
|
||||
use rust_decimal::{Decimal, dec};
|
||||
use sqlx::PgPool;
|
||||
use tracing::warn;
|
||||
|
||||
use crate::database::models::{DBAffiliateCodeId, DBUserId};
|
||||
|
||||
pub async fn process_affiliate_payouts(postgres: &PgPool) -> Result<()> {
|
||||
// process:
|
||||
// - get any subscriptions which are in `users_subscriptions_affiliations`
|
||||
// - for those subscriptions, get any charges which are not in `users_subscriptions_affiliations_payouts`
|
||||
// - for each of those charges,
|
||||
// - get the subscription's `affiliate_code`
|
||||
// - get the affiliate user of that code
|
||||
// - add a payout for that affiliate user, proportional to the `net - tax` of the charge
|
||||
// - add a record of this into `users_subscriptions_affiliations_payouts`
|
||||
|
||||
let mut txn = postgres
|
||||
.begin()
|
||||
.await
|
||||
.wrap_err("failed to begin transaction")?;
|
||||
|
||||
let charges = sqlx::query!(
|
||||
r#"
|
||||
SELECT
|
||||
c.id as charge_id,
|
||||
c.subscription_id as "subscription_id!",
|
||||
c.net as charge_net,
|
||||
c.tax_amount as charge_tax_amount,
|
||||
c.last_attempt as charge_last_attempt,
|
||||
c.currency_code,
|
||||
usa.affiliate_code,
|
||||
ac.affiliate as affiliate_user_id,
|
||||
ac.revenue_split
|
||||
-- get any charges...
|
||||
FROM charges c
|
||||
-- ...which have a subscription...
|
||||
INNER JOIN users_subscriptions_affiliations usa
|
||||
ON c.subscription_id = usa.subscription_id
|
||||
AND c.subscription_id IS NOT NULL
|
||||
AND (usa.deactivated_at IS NULL OR c.last_attempt < usa.deactivated_at)
|
||||
-- ...which have an affiliate code...
|
||||
INNER JOIN affiliate_codes ac
|
||||
ON usa.affiliate_code = ac.id
|
||||
-- ...and where no payout to an affiliate has been made for this charge yet
|
||||
LEFT JOIN users_subscriptions_affiliations_payouts usap
|
||||
ON c.id = usap.charge_id
|
||||
WHERE
|
||||
c.status = 'succeeded'
|
||||
AND c.net > 0
|
||||
AND usap.id IS NULL
|
||||
-- exclude charges that have refund charges
|
||||
AND NOT EXISTS (
|
||||
SELECT 1
|
||||
FROM charges refund_charges
|
||||
WHERE refund_charges.parent_charge_id = c.id
|
||||
)
|
||||
"#
|
||||
)
|
||||
.fetch_all(&mut *txn)
|
||||
.await
|
||||
.wrap_err("failed to fetch charges awaiting affiliate payout")?;
|
||||
|
||||
let default_affiliate_revenue_split =
|
||||
dotenvy::var("DEFAULT_AFFILIATE_REVENUE_SPLIT")
|
||||
.wrap_err("no env var `DEFAULT_AFFILIATE_REVENUE_SPLIT`")?
|
||||
.parse::<Decimal>()
|
||||
.wrap_err("`DEFAULT_AFFILIATE_REVENUE_SPLIT` is not a decimal")?;
|
||||
|
||||
let (
|
||||
mut insert_usap_charges,
|
||||
mut insert_usap_subscriptions,
|
||||
mut insert_usap_affiliate_codes,
|
||||
mut insert_usap_payout_values,
|
||||
) = (Vec::new(), Vec::new(), Vec::new(), Vec::new());
|
||||
|
||||
for row in charges {
|
||||
let Some(net) = row.charge_net else {
|
||||
warn!(
|
||||
"Charge {} has no net amount; cannot calculate affiliate payout",
|
||||
row.charge_id
|
||||
);
|
||||
continue;
|
||||
};
|
||||
let net = Decimal::new(net, 2);
|
||||
let tax_amount = Decimal::new(row.charge_tax_amount, 2);
|
||||
|
||||
let Some(last_attempt) = row.charge_last_attempt else {
|
||||
warn!(
|
||||
"Charge {} has no last attempt; cannot calculate affiliate payout",
|
||||
row.charge_id
|
||||
);
|
||||
continue;
|
||||
};
|
||||
|
||||
// affiliate payouts are Net 60 from the end of the month
|
||||
// this is net 60 relative to the time of the charge's last attempt, not from now
|
||||
let available = {
|
||||
let year = last_attempt.year();
|
||||
let month = last_attempt.month();
|
||||
|
||||
// get the first day of the next month
|
||||
let last_day_of_month = if month == 12 {
|
||||
Utc.with_ymd_and_hms(year + 1, 1, 1, 0, 0, 0).unwrap()
|
||||
} else {
|
||||
Utc.with_ymd_and_hms(year, month + 1, 1, 0, 0, 0).unwrap()
|
||||
};
|
||||
|
||||
last_day_of_month + Duration::days(59)
|
||||
};
|
||||
|
||||
let revenue_split = row
|
||||
.revenue_split
|
||||
.and_then(Decimal::from_f64_retain)
|
||||
.unwrap_or(default_affiliate_revenue_split);
|
||||
if !(Decimal::from(0)..=Decimal::from(1)).contains(&revenue_split) {
|
||||
warn!(
|
||||
"Charge {} has revenue split {revenue_split} which is out of range",
|
||||
row.charge_id,
|
||||
);
|
||||
continue;
|
||||
}
|
||||
|
||||
let affiliate_cut = (net - tax_amount) * revenue_split;
|
||||
if affiliate_cut < dec!(0.01) {
|
||||
continue;
|
||||
}
|
||||
|
||||
let affiliate_user_id = DBUserId(row.affiliate_user_id);
|
||||
let affiliate_code_id = DBAffiliateCodeId(row.affiliate_code);
|
||||
|
||||
// don't batch up affiliate code payouts into one big payout per (user, affiliate code)
|
||||
// because we want to associate 1 payout to an affiliate, with 1 concrete charge
|
||||
|
||||
let payout_value_id = sqlx::query!(
|
||||
"
|
||||
INSERT INTO payouts_values
|
||||
(user_id, amount, created,
|
||||
date_available, affiliate_code_source)
|
||||
VALUES ($1, $2, $3, $4, $5)
|
||||
RETURNING id
|
||||
",
|
||||
affiliate_user_id as _,
|
||||
affiliate_cut,
|
||||
last_attempt,
|
||||
available,
|
||||
affiliate_code_id as _,
|
||||
)
|
||||
.fetch_one(&mut *txn)
|
||||
.await
|
||||
.wrap_err_with(|| eyre!("failed to insert payout value for ({affiliate_user_id:?}, {affiliate_code_id:?})"))?
|
||||
.id;
|
||||
|
||||
insert_usap_charges.push(row.charge_id);
|
||||
insert_usap_subscriptions.push(row.subscription_id);
|
||||
insert_usap_affiliate_codes.push(affiliate_code_id.0);
|
||||
insert_usap_payout_values.push(payout_value_id);
|
||||
}
|
||||
|
||||
sqlx::query!(
|
||||
"
|
||||
INSERT INTO users_subscriptions_affiliations_payouts
|
||||
(charge_id, subscription_id,
|
||||
affiliate_code, payout_value_id)
|
||||
SELECT * FROM UNNEST($1::bigint[], $2::bigint[], $3::bigint[], $4::bigint[])
|
||||
",
|
||||
&insert_usap_charges[..],
|
||||
&insert_usap_subscriptions[..],
|
||||
&insert_usap_affiliate_codes[..],
|
||||
&insert_usap_payout_values[..],
|
||||
)
|
||||
.execute(&mut *txn)
|
||||
.await
|
||||
.wrap_err("failed to associate charges with affiliate payouts")?;
|
||||
|
||||
txn.commit()
|
||||
.await
|
||||
.wrap_err("failed to commit transaction")?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn remove_payouts_for_refunded_charges(
|
||||
postgres: &PgPool,
|
||||
) -> Result<()> {
|
||||
// process:
|
||||
// - find refund charges
|
||||
// - which have a parent charge
|
||||
// - where that parent charge has a `usap` row
|
||||
// - where the `usap.payout_value_id` is not available as of `now()`
|
||||
// - (don't revoke payout values which have already been issued to the affiliate)
|
||||
// - delete the `usap` and `usap.payout_value_id` row
|
||||
|
||||
let mut txn = postgres
|
||||
.begin()
|
||||
.await
|
||||
.wrap_err("failed to begin transaction")?;
|
||||
|
||||
// note: this may return duplicate `usap_id` rows
|
||||
// it's fine here, since we delete them all anyway
|
||||
let refundable_payouts = sqlx::query!(
|
||||
r#"
|
||||
SELECT
|
||||
usap.id as usap_id,
|
||||
usap.payout_value_id
|
||||
FROM charges refund_charges
|
||||
-- find original charges that have been refunded
|
||||
INNER JOIN charges original_charges
|
||||
ON original_charges.id = refund_charges.parent_charge_id
|
||||
-- find affiliate payouts for those original charges
|
||||
INNER JOIN users_subscriptions_affiliations_payouts usap
|
||||
ON usap.charge_id = original_charges.id
|
||||
-- only include payouts that haven't been issued yet (not available as of now)
|
||||
INNER JOIN payouts_values pv
|
||||
ON pv.id = usap.payout_value_id
|
||||
AND pv.date_available > NOW()
|
||||
WHERE
|
||||
refund_charges.status = 'succeeded'
|
||||
-- make sure it's actually a refund charge
|
||||
AND refund_charges.charge_type = 'refund'
|
||||
"#
|
||||
)
|
||||
.fetch_all(&mut *txn)
|
||||
.await
|
||||
.wrap_err("failed to fetch refundable affiliate payouts")?;
|
||||
|
||||
if refundable_payouts.is_empty() {
|
||||
txn.commit()
|
||||
.await
|
||||
.wrap_err("failed to commit transaction")?;
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
let mut usap_ids = Vec::new();
|
||||
let mut payout_value_ids = Vec::new();
|
||||
|
||||
for payout in refundable_payouts {
|
||||
usap_ids.push(payout.usap_id);
|
||||
payout_value_ids.push(payout.payout_value_id);
|
||||
}
|
||||
|
||||
// Delete the affiliate payout associations
|
||||
sqlx::query!(
|
||||
"
|
||||
DELETE FROM users_subscriptions_affiliations_payouts
|
||||
WHERE id = ANY($1::bigint[])
|
||||
",
|
||||
&usap_ids[..]
|
||||
)
|
||||
.execute(&mut *txn)
|
||||
.await
|
||||
.wrap_err("failed to delete affiliate payout associations")?;
|
||||
|
||||
// Delete the payout values
|
||||
sqlx::query!(
|
||||
"
|
||||
DELETE FROM payouts_values
|
||||
WHERE id = ANY($1::bigint[])
|
||||
",
|
||||
&payout_value_ids[..]
|
||||
)
|
||||
.execute(&mut *txn)
|
||||
.await
|
||||
.wrap_err("failed to delete payout values")?;
|
||||
|
||||
txn.commit()
|
||||
.await
|
||||
.wrap_err("failed to commit transaction")?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -36,6 +36,11 @@ use tracing::{error, info, warn};
|
||||
|
||||
pub mod mural;
|
||||
|
||||
mod affiliate;
|
||||
pub use affiliate::{
|
||||
process_affiliate_payouts, remove_payouts_for_refunded_charges,
|
||||
};
|
||||
|
||||
pub struct PayoutsQueue {
|
||||
credential: RwLock<Option<PayPalCredentials>>,
|
||||
payout_options: RwLock<Option<PayoutMethods>>,
|
||||
|
||||
Reference in New Issue
Block a user