Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

ref: Remove plan constants in shared, create properties on model instead of dataclass/DTO #509

Merged
merged 4 commits into from
Feb 11, 2025
Merged

ref: Remove plan constants in shared, create properties on model instead of dataclass/DTO #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f7bd82
init test
ajay-sentry Feb 10, 2025
db8938b
fix tests
ajay-sentry Feb 11, 2025
0576a1e
add is_trial_plan
ajay-sentry Feb 11, 2025
77588fe
update plan service to reflect new props
ajay-sentry Feb 11, 2025
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
29 changes: 28 additions & 1 deletion shared/django_apps/codecov_auth/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
from shared.django_apps.codecov_auth.managers import OwnerManager
from shared.django_apps.core.managers import RepositoryManager
from shared.django_apps.core.models import DateTimeWithoutTZField, Repository
from shared.plan.constants import PlanName, TrialDaysAmount
from shared.plan.constants import PlanName, TierName, TrialDaysAmount

# Added to avoid 'doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS' error\
# Needs to be called the same as the API app
Expand Down Expand Up @@ -1045,6 +1045,33 @@ class Meta:
def __str__(self):
return self.name

@property
Copy link
Contributor

@RulaKhaled RulaKhaled Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we align these with properties we have in plan service? https://github.com/codecov/shared/blob/main/shared/plan/service.py#L326

Copy link
Contributor Author

@ajay-sentry ajay-sentry Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep def, good call

def is_free_plan(self):
return not self.paid_plan

@property
def is_pro_plan(self):
return (
self.tier.tier_name == TierName.PRO.value
or self.tier.tier_name == TierName.SENTRY.value
)

@property
def is_team_plan(self):
return self.tier.tier_name == TierName.TEAM.value

@property
def is_enterprise_plan(self):
return self.tier.tier_name == TierName.ENTERPRISE.value

@property
def is_sentry_plan(self):
return self.tier.tier_name == TierName.SENTRY.value

@property
def is_trial_plan(self):
return self.tier.tier_name == TierName.TRIAL.value


class Tier(BaseModel):
tier_name = models.CharField(max_length=255, unique=True)
Expand Down
340 changes: 0 additions & 340 deletions shared/plan/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import enum
from dataclasses import dataclass
from typing import List, Optional

from shared.django_apps.utils.config import RUN_ENV

Expand Down Expand Up @@ -83,343 +81,5 @@ class TierName(enum.Enum):
TRIAL = "trial"


def convert_to_DTO(plan) -> dict:
return {
"marketing_name": plan.marketing_name,
"value": plan.name,
"billing_rate": plan.billing_rate,
"base_unit_price": plan.base_unit_price,
"benefits": plan.benefits,
"tier_name": plan.tier.tier_name,
"monthly_uploads_limit": plan.monthly_uploads_limit,
"is_free_plan": not plan.paid_plan,
"is_pro_plan": plan.tier.tier_name == TierName.PRO.value,
"is_team_plan": plan.tier.tier_name == TierName.TEAM.value,
"is_enterprise_plan": plan.tier.tier_name == TierName.ENTERPRISE.value,
"is_trial_plan": plan.tier.tier_name == TierName.TRIAL.value,
"is_sentry_plan": plan.tier.tier_name == TierName.SENTRY.value,
}


@dataclass(repr=False)
class PlanData:
"""
Dataclass that represents plan related information
"""

marketing_name: PlanMarketingName
value: PlanName
billing_rate: Optional[PlanBillingRate]
base_unit_price: PlanPrice
benefits: List[str]
tier_name: TierName
monthly_uploads_limit: Optional[MonthlyUploadLimits]
trial_days: Optional[TrialDaysAmount]

def convert_to_DTO(self) -> dict:
return {
"marketing_name": self.marketing_name,
"value": self.value,
"billing_rate": self.billing_rate,
"base_unit_price": self.base_unit_price,
"benefits": self.benefits,
"tier_name": self.tier_name,
"monthly_uploads_limit": self.monthly_uploads_limit,
"is_free_plan": self.tier_name == TierName.BASIC.value,
"is_pro_plan": self.tier_name == TierName.PRO.value,
"is_team_plan": self.tier_name == TierName.TEAM.value,
"is_enterprise_plan": self.tier_name == TierName.ENTERPRISE.value,
"is_trial_plan": self.value == PlanName.TRIAL_PLAN_NAME.value,
"is_sentry_plan": self.value in SENTRY_PAID_USER_PLAN_REPRESENTATIONS,
}


NON_PR_AUTHOR_PAID_USER_PLAN_REPRESENTATIONS = {
PlanName.CODECOV_PRO_MONTHLY_LEGACY.value: PlanData(
marketing_name=PlanMarketingName.CODECOV_PRO.value,
value=PlanName.CODECOV_PRO_MONTHLY_LEGACY.value,
billing_rate=PlanBillingRate.MONTHLY.value,
base_unit_price=PlanPrice.MONTHLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.PRO.value,
monthly_uploads_limit=None,
trial_days=None,
),
PlanName.CODECOV_PRO_YEARLY_LEGACY.value: PlanData(
marketing_name=PlanMarketingName.CODECOV_PRO.value,
value=PlanName.CODECOV_PRO_YEARLY_LEGACY.value,
billing_rate=PlanBillingRate.YEARLY.value,
base_unit_price=PlanPrice.YEARLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.PRO.value,
monthly_uploads_limit=None,
trial_days=None,
),
}


PR_AUTHOR_PAID_USER_PLAN_REPRESENTATIONS = {
PlanName.CODECOV_PRO_MONTHLY.value: PlanData(
marketing_name=PlanMarketingName.CODECOV_PRO.value,
value=PlanName.CODECOV_PRO_MONTHLY.value,
billing_rate=PlanBillingRate.MONTHLY.value,
base_unit_price=PlanPrice.MONTHLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.PRO.value,
monthly_uploads_limit=None,
trial_days=None,
),
PlanName.CODECOV_PRO_YEARLY.value: PlanData(
marketing_name=PlanMarketingName.CODECOV_PRO.value,
value=PlanName.CODECOV_PRO_YEARLY.value,
billing_rate=PlanBillingRate.YEARLY.value,
base_unit_price=PlanPrice.YEARLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.PRO.value,
monthly_uploads_limit=None,
trial_days=None,
),
}

SENTRY_PAID_USER_PLAN_REPRESENTATIONS = {
PlanName.SENTRY_MONTHLY.value: PlanData(
marketing_name=PlanMarketingName.SENTRY_PRO.value,
value=PlanName.SENTRY_MONTHLY.value,
billing_rate=PlanBillingRate.MONTHLY.value,
base_unit_price=PlanPrice.MONTHLY.value,
benefits=[
"Includes 5 seats",
"$12 per additional seat",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.SENTRY.value,
trial_days=TrialDaysAmount.CODECOV_SENTRY.value,
monthly_uploads_limit=None,
),
PlanName.SENTRY_YEARLY.value: PlanData(
marketing_name=PlanMarketingName.SENTRY_PRO.value,
value=PlanName.SENTRY_YEARLY.value,
billing_rate=PlanBillingRate.YEARLY.value,
base_unit_price=PlanPrice.YEARLY.value,
benefits=[
"Includes 5 seats",
"$10 per additional seat",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.SENTRY.value,
trial_days=TrialDaysAmount.CODECOV_SENTRY.value,
monthly_uploads_limit=None,
),
}

# TODO: Update these values
ENTERPRISE_CLOUD_USER_PLAN_REPRESENTATIONS = {
PlanName.ENTERPRISE_CLOUD_MONTHLY.value: PlanData(
marketing_name=PlanMarketingName.ENTERPRISE_CLOUD.value,
value=PlanName.ENTERPRISE_CLOUD_MONTHLY.value,
billing_rate=PlanBillingRate.MONTHLY.value,
base_unit_price=PlanPrice.MONTHLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.ENTERPRISE.value,
trial_days=None,
monthly_uploads_limit=None,
),
PlanName.ENTERPRISE_CLOUD_YEARLY.value: PlanData(
marketing_name=PlanMarketingName.ENTERPRISE_CLOUD.value,
value=PlanName.ENTERPRISE_CLOUD_YEARLY.value,
billing_rate=PlanBillingRate.YEARLY.value,
base_unit_price=PlanPrice.YEARLY.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.ENTERPRISE.value,
trial_days=None,
monthly_uploads_limit=None,
),
}

GHM_PLAN_REPRESENTATION = {
PlanName.GHM_PLAN_NAME.value: PlanData(
marketing_name=PlanMarketingName.GITHUB_MARKETPLACE.value,
value=PlanName.GHM_PLAN_NAME.value,
billing_rate=None,
base_unit_price=PlanPrice.GHM_PRICE.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
],
tier_name=TierName.PRO.value,
trial_days=None,
monthly_uploads_limit=None,
)
}

BASIC_PLAN = PlanData(
marketing_name=PlanMarketingName.BASIC.value,
value=PlanName.BASIC_PLAN_NAME.value,
billing_rate=None,
base_unit_price=PlanPrice.CODECOV_BASIC.value,
benefits=[
"Up to 1 user",
"Unlimited public repositories",
"Unlimited private repositories",
],
tier_name=TierName.BASIC.value,
monthly_uploads_limit=MonthlyUploadLimits.CODECOV_FREE_PLAN.value,
trial_days=None,
)

FREE_PLAN = PlanData(
marketing_name=PlanMarketingName.FREE.value,
value=PlanName.FREE_PLAN_NAME.value,
billing_rate=None,
base_unit_price=PlanPrice.CODECOV_FREE.value,
benefits=[
"Up to 1 user",
"Unlimited public repositories",
"Unlimited private repositories",
],
tier_name=TierName.BASIC.value,
trial_days=None,
monthly_uploads_limit=None,
)

DEVELOPER_PLAN = PlanData(
marketing_name=PlanMarketingName.FREE.value,
value=DEFAULT_FREE_PLAN,
billing_rate=None,
base_unit_price=PlanPrice.CODECOV_FREE.value,
benefits=[
"Up to 1 user",
"Unlimited public repositories",
"Unlimited private repositories",
],
tier_name=TierName.TEAM.value,
trial_days=None,
monthly_uploads_limit=250,
)

FREE_PLAN_REPRESENTATIONS = {
PlanName.FREE_PLAN_NAME.value: FREE_PLAN,
PlanName.BASIC_PLAN_NAME.value: BASIC_PLAN,
DEFAULT_FREE_PLAN: DEVELOPER_PLAN,
}

TEAM_PLAN_REPRESENTATIONS = {
PlanName.TEAM_MONTHLY.value: PlanData(
marketing_name=PlanMarketingName.TEAM.value,
value=PlanName.TEAM_MONTHLY.value,
billing_rate=PlanBillingRate.MONTHLY.value,
base_unit_price=PlanPrice.TEAM_MONTHLY.value,
benefits=[
"Up to 10 users",
"Unlimited repositories",
"2500 private repo uploads",
"Patch coverage analysis",
],
tier_name=TierName.TEAM.value,
trial_days=None,
monthly_uploads_limit=MonthlyUploadLimits.CODECOV_TEAM_PLAN.value,
),
PlanName.TEAM_YEARLY.value: PlanData(
marketing_name=PlanMarketingName.TEAM.value,
value=PlanName.TEAM_YEARLY.value,
billing_rate=PlanBillingRate.YEARLY.value,
base_unit_price=PlanPrice.TEAM_YEARLY.value,
benefits=[
"Up to 10 users",
"Unlimited repositories",
"2500 private repo uploads",
"Patch coverage analysis",
],
tier_name=TierName.TEAM.value,
trial_days=None,
monthly_uploads_limit=MonthlyUploadLimits.CODECOV_TEAM_PLAN.value,
),
}

TRIAL_PLAN_REPRESENTATION = {
PlanName.TRIAL_PLAN_NAME.value: PlanData(
marketing_name=PlanMarketingName.TRIAL.value,
value=PlanName.TRIAL_PLAN_NAME.value,
billing_rate=None,
base_unit_price=PlanPrice.CODECOV_TRIAL.value,
benefits=[
"Configurable # of users",
"Unlimited public repositories",
"Unlimited private repositories",
"Priority Support",
],
tier_name=TierName.TRIAL.value,
trial_days=None,
monthly_uploads_limit=None,
),
}

PAID_PLANS = {
**PR_AUTHOR_PAID_USER_PLAN_REPRESENTATIONS,
**SENTRY_PAID_USER_PLAN_REPRESENTATIONS,
**ENTERPRISE_CLOUD_USER_PLAN_REPRESENTATIONS,
**TEAM_PLAN_REPRESENTATIONS,
}

TRIAL_PLANS = {**TRIAL_PLAN_REPRESENTATION}

TEAM_PLANS = {**TEAM_PLAN_REPRESENTATIONS}


USER_PLAN_REPRESENTATIONS = {
**FREE_PLAN_REPRESENTATIONS,
**NON_PR_AUTHOR_PAID_USER_PLAN_REPRESENTATIONS,
**GHM_PLAN_REPRESENTATION,
**PAID_PLANS,
**TRIAL_PLANS,
**TEAM_PLANS,
}

PLANS_THAT_CAN_TRIAL = [
DEFAULT_FREE_PLAN,
PlanName.FREE_PLAN_NAME.value,
PlanName.BASIC_PLAN_NAME.value,
PlanName.CODECOV_PRO_MONTHLY.value,
PlanName.CODECOV_PRO_YEARLY.value,
PlanName.SENTRY_MONTHLY.value,
PlanName.SENTRY_YEARLY.value,
PlanName.TRIAL_PLAN_NAME.value,
]

TRIAL_PLAN_SEATS = 1000
TEAM_PLAN_MAX_USERS = 10
Loading