Browse Source

feat(code-mappings): Add flag for auto-generated mappings (#40593)

Scott Cooper 2 years ago
parent
commit
08cee74780

+ 1 - 1
migrations_lockfile.txt

@@ -6,5 +6,5 @@ To resolve this, rebase against latest master and regenerate your migration. Thi
 will then be regenerated, and you should be able to merge without conflicts.
 
 nodestore: 0002_nodestore_no_dictfield
-sentry: 0333_remove_app_id
+sentry: 0334_repositorypath_automatically_generated
 social_auth: 0001_initial

+ 51 - 0
src/sentry/migrations/0334_repositorypath_automatically_generated.py

@@ -0,0 +1,51 @@
+# Generated by Django 2.2.28 on 2022-10-26 17:50
+
+from django.db import migrations, models
+
+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. For
+    # the most part, 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 dangerous:
+    # - Large data migrations. Typically we want these to be run manually by ops 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
+    #   have ops run this and not block the deploy. Note that while adding an index is a schema
+    #   change, it's completely safe to run the operation after the code has deployed.
+    is_dangerous = False
+
+    # This flag is used to decide whether to run this migration in a transaction or not. Generally
+    # we don't want to run in a transaction here, since for long running operations like data
+    # back-fills this results in us locking an increasing number of rows until we finally commit.
+    atomic = False
+
+    dependencies = [
+        ("sentry", "0333_remove_app_id"),
+    ]
+
+    operations = [
+        migrations.SeparateDatabaseAndState(
+            database_operations=[
+                migrations.RunSQL(
+                    """
+                    ALTER TABLE "sentry_repositoryprojectpathconfig" ADD COLUMN "automatically_generated" BOOLEAN NOT NULL DEFAULT false;
+                    """,
+                    reverse_sql="""
+                    ALTER TABLE "sentry_repositoryprojectpathconfig" DROP COLUMN "automatically_generated";
+                    """,
+                    hints={"tables": ["sentry_repositoryprojectpathconfig"]},
+                ),
+            ],
+            state_operations=[
+                migrations.AddField(
+                    model_name="repositoryprojectpathconfig",
+                    name="automatically_generated",
+                    field=models.BooleanField(default=False),
+                ),
+            ],
+        )
+    ]

+ 2 - 0
src/sentry/models/integrations/repository_project_path_config.py

@@ -16,6 +16,8 @@ class RepositoryProjectPathConfig(DefaultFieldsModel):
     stack_root = models.TextField()
     source_root = models.TextField()
     default_branch = models.TextField(null=True)
+    # Indicates if Sentry created this mapping
+    automatically_generated = models.BooleanField(default=False)
 
     class Meta:
         app_label = "sentry"