Shared: Migrate to Plan / Tier Tables (#479)

* shared stuff should be migrated with this, first try with available_plans

* boilerplate updates, better way to do the plan searches

* update logic a bit to work with new plan, and types as well, start fixing tests

* 43 tests failing locally

* fix some tests:

* uncomment stuff

* more tests fixing

* 5 more to go

* wrap up tests in test_plan

* resolve all tests

* update test imports and helper, remove trial_days from DTO, start offboarding the consts

* lint

* Update with pretty plan changes

* setupClass from setUp and clean up a bunch of the available plan tests

* remove ttestcase if not needed

* print

* use cached property, remove setter

* missed a couple prefetch references

---------

Co-authored-by: RulaKhaled <[email protected]>

Author: ajay-sentry

shared/django_apps/codecov_auth/models.py

@@ -2,7 +2,6 @@
 import logging
 import os
 import uuid
-from dataclasses import asdict
 from datetime import datetime
 from hashlib import md5
 from typing import Optional, Self
@@ -30,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 USER_PLAN_REPRESENTATIONS, PlanName
+from shared.plan.constants import PlanName, 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
@@ -221,10 +220,22 @@ def pretty_plan(self) -> dict | None:
         This is how we represent the details of a plan to a user, see plan.constants.py
         We inject quantity to make plan management easier on api, see PlanSerializer
         """
-        if self.plan in USER_PLAN_REPRESENTATIONS:
-            plan_details = asdict(USER_PLAN_REPRESENTATIONS[self.plan])
-            plan_details.update({"quantity": self.plan_seat_count})
-            return plan_details
+        plan_details = Plan.objects.select_related("tier").get(name=self.plan)
+        if plan_details:
+            return {
+                "marketing_name": plan_details.marketing_name,
+                "value": plan_details.name,
+                "billing_rate": plan_details.billing_rate,
+                "base_unit_price": plan_details.base_unit_price,
+                "benefits": plan_details.benefits,
+                "tier_name": plan_details.tier.tier_name,
+                "monthly_uploads_limit": plan_details.monthly_uploads_limit,
+                "trial_days": TrialDaysAmount.CODECOV_SENTRY.value
+                if plan_details.name == PlanName.TRIAL_PLAN_NAME.value
+                else None,
+                "quantity": self.plan_seat_count,
+            }
+        return None
 
     def can_activate_user(self, user: User | None = None) -> bool:
         """
@@ -593,16 +604,23 @@ def avatar_url(self, size=DEFAULT_AVATAR_SIZE):
     def pretty_plan(self):
         if self.account:
             return self.account.pretty_plan
-        if self.plan in USER_PLAN_REPRESENTATIONS:
-            plan_details = asdict(USER_PLAN_REPRESENTATIONS[self.plan])
 
-            # update with quantity they've purchased
-            # allows api users to update the quantity
-            # by modifying the "plan", sidestepping
-            # some iffy data modeling
-
-            plan_details.update({"quantity": self.plan_user_count})
-            return plan_details
+        plan_details = Plan.objects.select_related("tier").get(name=self.plan)
+        if plan_details:
+            return {
+                "marketing_name": plan_details.marketing_name,
+                "value": plan_details.name,
+                "billing_rate": plan_details.billing_rate,
+                "base_unit_price": plan_details.base_unit_price,
+                "benefits": plan_details.benefits,
+                "tier_name": plan_details.tier.tier_name,
+                "monthly_uploads_limit": plan_details.monthly_uploads_limit,
+                "trial_days": TrialDaysAmount.CODECOV_SENTRY.value
+                if plan_details.name == PlanName.TRIAL_PLAN_NAME.value
+                else None,
+                "quantity": self.plan_user_count,
+            }
+        return None
 
     def can_activate_user(self, owner_user: Self) -> bool:
         owner_org = self

shared/django_apps/codecov_auth/services/org_level_token_service.py

@@ -5,8 +5,7 @@
 from django.dispatch import receiver
 from django.forms import ValidationError
 
-from shared.django_apps.codecov_auth.models import OrganizationLevelToken, Owner
-from shared.plan.constants import USER_PLAN_REPRESENTATIONS
+from shared.django_apps.codecov_auth.models import OrganizationLevelToken, Owner, Plan
 
 log = logging.getLogger(__name__)
 
@@ -18,9 +17,10 @@ class OrgLevelTokenService(object):
         -- only 1 token per Owner
     """
 
+    # MIGHT BE ABLE TO REMOVE THIS AND SUBSEQUENT DOWNSTREAM STUFF
     @classmethod
     def org_can_have_upload_token(cls, org: Owner):
-        return org.plan in USER_PLAN_REPRESENTATIONS
+        return Plan.objects.filter(name=org.plan, is_active=True).exists()
 
     @classmethod
     def get_or_create_org_token(cls, org: Owner):

shared/django_apps/codecov_auth/tests/factories.py

@@ -23,7 +23,7 @@
     UserToken,
 )
 from shared.encryption.oauth import get_encryptor_from_configuration
-from shared.plan.constants import TrialStatus
+from shared.plan.constants import PlanName, TierName, TrialStatus
 
 encryptor = get_encryptor_from_configuration()
 
@@ -177,20 +177,26 @@ class TierFactory(DjangoModelFactory):
     class Meta:
         model = Tier
 
-    tier_name = factory.Faker("name")
+    tier_name = TierName.BASIC.value
+    bundle_analysis = False
+    test_analytics = False
+    flaky_test_detection = False
+    project_coverage = False
+    private_repo_support = False
 
 
 class PlanFactory(DjangoModelFactory):
     class Meta:
         model = Plan
 
-    base_unit_price = factory.Faker("pyint")
-    benefits = []
+    tier = factory.SubFactory(TierFactory)
+    base_unit_price = 0
+    benefits = factory.LazyFunction(lambda: ["Benefit 1", "Benefit 2", "Benefit 3"])
     billing_rate = None
     is_active = True
-    marketing_name = factory.Faker("name")
-    max_seats = None
+    marketing_name = factory.Faker("catch_phrase")
+    max_seats = 1
     monthly_uploads_limit = None
-    paid_plan = True
-    name = factory.Faker("name")
-    tier = factory.SubFactory(TierFactory)
+    name = PlanName.BASIC_PLAN_NAME.value
+    paid_plan = False
+    stripe_id = None

shared/plan/constants.py

@@ -73,6 +73,26 @@ class TierName(enum.Enum):
     TEAM = "team"
     PRO = "pro"
     ENTERPRISE = "enterprise"
+    SENTRY = "sentry"
+    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)
@@ -99,7 +119,6 @@ def convert_to_DTO(self) -> dict:
             "benefits": self.benefits,
             "tier_name": self.tier_name,
             "monthly_uploads_limit": self.monthly_uploads_limit,
-            "trial_days": self.trial_days,
             "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,
@@ -189,7 +208,7 @@ def convert_to_DTO(self) -> dict:
             "Unlimited private repositories",
             "Priority Support",
         ],
-        tier_name=TierName.PRO.value,
+        tier_name=TierName.SENTRY.value,
         trial_days=TrialDaysAmount.CODECOV_SENTRY.value,
         monthly_uploads_limit=None,
     ),
@@ -205,7 +224,7 @@ def convert_to_DTO(self) -> dict:
             "Unlimited private repositories",
             "Priority Support",
         ],
-        tier_name=TierName.PRO.value,
+        tier_name=TierName.SENTRY.value,
         trial_days=TrialDaysAmount.CODECOV_SENTRY.value,
         monthly_uploads_limit=None,
     ),
@@ -342,7 +361,7 @@ def convert_to_DTO(self) -> dict:
             "Unlimited private repositories",
             "Priority Support",
         ],
-        tier_name=TierName.PRO.value,
+        tier_name=TierName.TRIAL.value,
         trial_days=None,
         monthly_uploads_limit=None,
     ),