feat: Create plans and tiers tables #467

RulaKhaled · 2025-01-09T11:18:40Z

To replace plans representation, we're making plans configurable through the DB.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

codecov · 2025-01-09T11:22:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.97%. Comparing base (d4ee906) to head (ec02329).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #467      +/-   ##
==========================================
- Coverage   90.55%   89.97%   -0.58%     
==========================================
  Files         404      324      -80     
  Lines       12562     9198    -3364     
  Branches     2107     1633     -474     
==========================================
- Hits        11375     8276    -3099     
+ Misses       1078      859     -219     
+ Partials      109       63      -46

Flag	Coverage Δ
shared-docker-uploader	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nora-codecov · 2025-01-09T17:06:20Z

shared/django_apps/codecov_auth/models.py

+
+class BillingRate(models.TextChoices):
+    MONTHLY = "monthly"
+    YEARLY = "yearly"


why not use PlanBillingRate?

this should be annually instead of yearly as well I think https://github.com/codecov/gazebo/blob/113a97f9e6a40ab9162576599308e123a25626aa/src/shared/utils/billing.ts#L29

didn't know we have it but i think we can't use enum.Enum directly in the choices argument of a Django model field, we'll have to do [(tag.value, tag.name) for tag in PlanBillingRate] which is not very clean.

I'll update to annually

nora-codecov · 2025-01-09T17:09:20Z

shared/django_apps/codecov_auth/models.py

+    tier = models.ForeignKey(
+        "Tiers", on_delete=models.CASCADE, related_name="plans", db_index=True
+    )


Suggested change

tier = models.ForeignKey(

"Tiers", on_delete=models.CASCADE, related_name="plans", db_index=True

)

tier = models.ForeignKey(

"Tiers", on_delete=models.SET_NULL, related_name="plans"

)

I removed the index, seems unnecessary for a small table, but up to you

Agreed with Nora, probably don't need an index here

makes sense, tbh i always like to use indexes you never know how big the table will grow to be

nora-codecov · 2025-01-09T17:10:27Z

shared/django_apps/codecov_auth/models.py

+    tier = models.ForeignKey(
+        "Tiers", on_delete=models.CASCADE, related_name="plans", db_index=True
+    )
+    base_unit_price = models.IntegerField(default=0)


Suggested change

base_unit_price = models.IntegerField(default=0)

base_unit_price = models.IntegerField(default=0, blank=True)

I think this one should always have a value, assuming blank=True means nullable

blank true means it can be null in the DB but it can't be optional in a form

i think it makes sense if we are ever updating free plans

no, blank=True means you don't have to supply a value in a form/when you create the object, it's independent from nullable. it has to do with the field in code, not db. docs
if you have blank=False, you need to manually include a value for this field even if it's the default value
if you have blank=True, you don't need to explicitly set this field, if you leave it blank, it will use the default value. Because of this, I put blank=True on almost any field that has a default value so that I get the behavior I want.

nora-codecov · 2025-01-09T17:12:36Z

shared/django_apps/codecov_auth/models.py

+    plan_name = models.CharField(max_length=255, unique=True)
+
+    class Meta:
+        db_table = "plans"


is this needed?

what does this do? :O

it's just a clean way of naming the database

nora-codecov · 2025-01-09T17:18:58Z

shared/django_apps/codecov_auth/models.py

+    private_repo_support = models.BooleanField(default=False)
+
+    class Meta:
+        db_table = "tiers"


prob not needed for a new table unless there's naming overlap with another table

nora-codecov

looking good! left some comments, happy to discuss any if you want :)

I think @ajay-sentry said that there will be a lot of django admin use of these tables - I would make those pages now and test them to make sure your fields are the way you want. Same with factories.

ajay-sentry · 2025-01-09T18:42:24Z

shared/django_apps/codecov_auth/models.py

+    max_seats = models.IntegerField(null=True, blank=True)
+    monthly_uploads_limit = models.IntegerField(null=True, blank=True)
+    paid_plan = models.BooleanField(default=False)
+    plan_name = models.CharField(max_length=255, unique=True)


just a thought here, should we just call this "name?" since it's already on the plan 🤔

ajay-sentry · 2025-01-09T18:43:06Z

shared/django_apps/codecov_auth/models.py

+    bundle_analysis = models.BooleanField(default=False)
+    test_analytics = models.BooleanField(default=False)
+    flaky_test_detection = models.BooleanField(default=False)
+    patch_coverage = models.BooleanField(default=False)


This should be project coverage right?

yes good catch

nora-codecov · 2025-01-13T17:09:24Z

shared/django_apps/codecov_auth/tests/factories.py

+    test_analytics = False
+    flaky_test_detection = False
+    project_coverage = False
+    private_repo_support = False


if you had blank=True on the bool fields on the model, you wouldn't need to name any of these fields, they would automatically be False when you make an obj with the factory

does it default to False or None in that case?

This stack overflow page seems to give a mixed view -- https://stackoverflow.com/questions/8609192/what-is-the-difference-between-null-true-and-blank-true-in-django

I realize now that we already had default=False on the model too 🤦‍♂️

RulaKhaled added 2 commits January 9, 2025 13:16

first pass to the plans and tiers tables

d90351b

remove comments

2767d12

fix linting

606857e

nora-codecov reviewed Jan 9, 2025

View reviewed changes

ajay-sentry reviewed Jan 9, 2025

View reviewed changes

RulaKhaled added 4 commits January 10, 2025 13:16

resolve comments

b132006

update with migration

ba51c68

update with correct name

33f51ff

create factories

2af3938

nora-codecov reviewed Jan 13, 2025

View reviewed changes

ajay-sentry and others added 2 commits January 13, 2025 16:53

add app-label back

0ded145

update name of tables

ec02329

ajay-sentry approved these changes Jan 14, 2025

View reviewed changes

nora-codecov approved these changes Jan 14, 2025

View reviewed changes

RulaKhaled added this pull request to the merge queue Jan 15, 2025

Merged via the queue into main with commit d5d7c20 Jan 15, 2025
6 checks passed

RulaKhaled deleted the plans-tiers-tables branch January 15, 2025 09:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create plans and tiers tables #467

feat: Create plans and tiers tables #467

RulaKhaled commented Jan 9, 2025

codecov bot commented Jan 9, 2025 •

edited

Loading

nora-codecov Jan 9, 2025

ajay-sentry Jan 9, 2025

RulaKhaled Jan 10, 2025

nora-codecov Jan 9, 2025 •

edited

Loading

ajay-sentry Jan 9, 2025

RulaKhaled Jan 10, 2025 •

edited

Loading

nora-codecov Jan 9, 2025

ajay-sentry Jan 9, 2025

RulaKhaled Jan 10, 2025

RulaKhaled Jan 10, 2025

nora-codecov Jan 13, 2025

nora-codecov Jan 9, 2025

ajay-sentry Jan 9, 2025

RulaKhaled Jan 10, 2025

nora-codecov Jan 9, 2025

nora-codecov left a comment •

edited

Loading

ajay-sentry Jan 9, 2025

ajay-sentry Jan 9, 2025

RulaKhaled Jan 10, 2025

nora-codecov Jan 13, 2025

ajay-sentry Jan 13, 2025

ajay-sentry Jan 14, 2025

ajay-sentry Jan 14, 2025

	base_unit_price = models.IntegerField(default=0)
	base_unit_price = models.IntegerField(default=0, blank=True)

feat: Create plans and tiers tables #467

feat: Create plans and tiers tables #467

Conversation

RulaKhaled commented Jan 9, 2025

Legal Boilerplate

codecov bot commented Jan 9, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nora-codecov Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RulaKhaled Jan 10, 2025 • edited Loading

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

Choose a reason for hiding this comment

nora-codecov left a comment • edited Loading

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

codecov bot commented Jan 9, 2025 •

edited

Loading

nora-codecov Jan 9, 2025 •

edited

Loading

RulaKhaled Jan 10, 2025 •

edited

Loading

nora-codecov left a comment •

edited

Loading