-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Create OrganizationContributors table in region dbs #146
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Generated by Django 5.2.8 on 2025-11-21 00:00 | ||
|
|
||
| import django.db.models.deletion | ||
| from django.db import migrations, models | ||
|
|
||
| import sentry.db.models.fields.bounded | ||
| import sentry.db.models.fields.foreignkey | ||
| import sentry.db.models.fields.hybrid_cloud_foreign_key | ||
| from sentry.new_migrations.migrations import CheckedMigration | ||
|
|
||
|
|
||
| class Migration(CheckedMigration): | ||
| # This flag is used to mark that a migration shouldn't be automatically run in production. | ||
| # This should only be used for operations where it's safe to run the migration after your | ||
| # code has deployed. So this should not be used for most operations that alter the schema | ||
| # of a table. | ||
| # Here are some things that make sense to mark as post deployment: | ||
| # - Large data migrations. Typically we want these to be run manually so that they can be | ||
| # monitored and not block the deploy for a long period of time while they run. | ||
| # - Adding indexes to large tables. Since this can take a long time, we'd generally prefer to | ||
| # run this outside deployments so that we don't block them. Note that while adding an index | ||
| # is a schema change, it's completely safe to run the operation after the code has deployed. | ||
| # Once deployed, run these manually via: https://develop.sentry.dev/database-migrations/#migration-deployment | ||
|
|
||
| is_post_deployment = False | ||
|
|
||
| dependencies = [ | ||
| ("sentry", "1007_cleanup_failed_safe_deletes"), | ||
| ] | ||
|
|
||
| operations = [ | ||
| migrations.CreateModel( | ||
| name="OrganizationContributors", | ||
| fields=[ | ||
| ( | ||
| "id", | ||
| sentry.db.models.fields.bounded.BoundedBigAutoField( | ||
| primary_key=True, serialize=False | ||
| ), | ||
| ), | ||
| ("external_identifier", models.CharField(db_index=True, max_length=255)), | ||
| ("alias", models.CharField(blank=True, max_length=255, null=True)), | ||
| ("num_actions", sentry.db.models.fields.bounded.BoundedIntegerField(default=0)), | ||
| ("date_added", models.DateTimeField(auto_now_add=True)), | ||
| ("date_updated", models.DateTimeField(auto_now=True)), | ||
| ( | ||
| "organization", | ||
| sentry.db.models.fields.foreignkey.FlexibleForeignKey( | ||
| on_delete=django.db.models.deletion.CASCADE, | ||
| to="sentry.organization", | ||
| ), | ||
| ), | ||
| ( | ||
| "integration_id", | ||
| sentry.db.models.fields.hybrid_cloud_foreign_key.HybridCloudForeignKey( | ||
| "sentry.Integration", | ||
| on_delete="CASCADE", | ||
| ), | ||
| ), | ||
| ], | ||
| options={ | ||
| "db_table": "sentry_organizationcontributors", | ||
| "constraints": [ | ||
| models.UniqueConstraint( | ||
| fields=("organization_id", "integration_id", "external_identifier"), | ||
| name="sentry_organizationcontributors_unique_org_contributor", | ||
| ) | ||
| ], | ||
| "indexes": [ | ||
| models.Index(fields=("date_updated",)), | ||
| ], | ||
| }, | ||
| ), | ||
| ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from django.db import models | ||
|
|
||
| from sentry.backup.scopes import RelocationScope | ||
| from sentry.db.models import BoundedIntegerField, FlexibleForeignKey, Model, region_silo_model | ||
| from sentry.db.models.fields.hybrid_cloud_foreign_key import HybridCloudForeignKey | ||
|
|
||
|
|
||
| @region_silo_model | ||
| class OrganizationContributors(Model): | ||
| """ | ||
| Tracks external contributors and their activity for an organization. | ||
| This model stores information about contributors associated with an | ||
| integration for a specific organization, including their external identity | ||
| and how many actions they have taken. | ||
| """ | ||
|
|
||
| __relocation_scope__ = RelocationScope.Excluded | ||
|
|
||
| organization = FlexibleForeignKey("sentry.Organization", on_delete=models.CASCADE) | ||
|
|
||
| integration_id = HybridCloudForeignKey("sentry.Integration", on_delete="CASCADE") | ||
|
|
||
| external_identifier = models.CharField(max_length=255) | ||
| alias = models.CharField(max_length=255, null=True, blank=True) | ||
| num_actions = BoundedIntegerField(default=0) | ||
| date_added = models.DateTimeField(auto_now_add=True) | ||
| date_updated = models.DateTimeField(auto_now=True) | ||
|
|
||
| class Meta: | ||
| app_label = "sentry" | ||
| db_table = "sentry_organizationcontributors" | ||
| constraints = [ | ||
| models.UniqueConstraint( | ||
| fields=["organization_id", "integration_id", "external_identifier"], | ||
| name="sentry_organizationcontributors_unique_org_contributor", | ||
| ), | ||
| ] | ||
| indexes = [ | ||
| models.Index(fields=["date_updated"]), | ||
|
Comment on lines
+40
to
+41
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [PerformanceOptimization] Missing index on Consider adding an index if you'll be running queries like:
If such queries are needed, add to the model's Meta: indexes = [
models.Index(fields=["date_updated"]),
models.Index(fields=["num_actions"]),
]Context for Agents |
||
| ] | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[BestPractice]
The migration defines
external_identifierwithdb_index=True(line 41), but the model definition (line 25 inorganizationcontributors.py) doesn't include this parameter. This inconsistency means the model and migration are out of sync.The
external_identifierfield is part of a unique constraint, so it will be indexed as part of that constraint. However, if you need a separate index for queries that filter only byexternal_identifier, you should adddb_index=Trueto the model:Or if the unique constraint index is sufficient, remove
db_index=Truefrom the migration.Context for Agents