feat(migrations): Prevent new migrations from using RunSQL (getsent…

…ry#81003)

This adds in `allow_run_sql` to our `CheckedMigration` baseclass. We
want to prevent the use of `RunSQL` in most cases going forward, since
our migration safety framework doesn't know how to parse sql to ensure
safety.

Our main uses for this in the past were:
- Adding new columns with a default. We now can do this within the
framework by using `db_default` instead of `default`.
- Deleting columns/tables. Since we have to remove from state, deploy,
then delete we have to use raw sql to remove them from Postgres. I'll
follow this up with a pr to provide ways to handle these deletions
within our framework.

fixtures/safe_migrations_apps/bad_flow_run_sql_disabled_app/migrations/0001_initial.py

@@ -0,0 +1,16 @@
+# Generated by Django 3.1 on 2019-09-22 21:47
+
+from django.db import migrations
+
+from sentry.new_migrations.migrations import CheckedMigration
+
+
+class Migration(CheckedMigration):
+
+    initial = True
+
+    dependencies = []
+
+    allow_run_sql = False
+
+    operations = [migrations.RunSQL("select 1;")]

fixtures/safe_migrations_apps/bad_flow_run_sql_disabled_app/models.py

@@ -0,0 +1,5 @@
+from django.db import models
+
+
+class TestTable(models.Model):
+    field = models.IntegerField(default=0, null=False)

fixtures/safe_migrations_apps/good_flow_delete_model_state_app/migrations/0002_delete_model_state.py

@@ -1,8 +1,7 @@
 # Generated by Django 3.1 on 2019-09-22 21:47
-
-from django.db import migrations
-
 from sentry.new_migrations.migrations import CheckedMigration
+from sentry.new_migrations.monkey.models import SafeDeleteModel
+from sentry.new_migrations.monkey.state import DeletionAction
 
 
 class Migration(CheckedMigration):
@@ -12,11 +11,5 @@ class Migration(CheckedMigration):
     ]
 
     operations = [
-        migrations.SeparateDatabaseAndState(
-            state_operations=[
-                migrations.DeleteModel(
-                    name="TestTable",
-                ),
-            ]
-        )
+        SafeDeleteModel(name="TestTable", deletion_action=DeletionAction.MOVE_TO_PENDING),
     ]

fixtures/safe_migrations_apps/good_flow_delete_model_state_app/migrations/0003_delete_table.py

@@ -1,16 +1,15 @@
 # Generated by Django 3.1 on 2019-09-22 21:47
-
-from django.db import migrations
-
 from sentry.new_migrations.migrations import CheckedMigration
+from sentry.new_migrations.monkey.models import SafeDeleteModel
+from sentry.new_migrations.monkey.state import DeletionAction
 
 
 class Migration(CheckedMigration):
 
     dependencies = [
-        ("good_flow_delete_model_state_app", "0001_initial"),
+        ("good_flow_delete_model_state_app", "0002_delete_model_state"),
     ]
 
     operations = [
-        migrations.RunSQL('DROP TABLE "good_flow_delete_model_state_app_testtable";'),
+        SafeDeleteModel(name="TestTable", deletion_action=DeletionAction.DELETE),
     ]

fixtures/safe_migrations_apps/good_flow_run_sql_enabled_app/migrations/0001_initial.py

@@ -0,0 +1,16 @@
+# Generated by Django 3.1 on 2019-09-22 21:47
+
+from django.db import migrations
+
+from sentry.new_migrations.migrations import CheckedMigration
+
+
+class Migration(CheckedMigration):
+
+    initial = True
+
+    dependencies = []
+
+    allow_run_sql = True
+
+    operations = [migrations.RunSQL("select 1;")]

fixtures/safe_migrations_apps/good_flow_run_sql_enabled_app/models.py

@@ -0,0 +1,5 @@
+from django.db import models
+
+
+class TestTable(models.Model):
+    field = models.IntegerField(default=0, null=False)

src/sentry/hybridcloud/migrations/0003_add_scopes_to_api_key_replica.py

@@ -20,6 +20,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("hybridcloud", "0002_add_slug_reservation_replica_model"),
     ]

src/sentry/migrations/0001_squashed_0484_break_org_member_user_fk.py

@@ -54,6 +54,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     replaces = [
         ("sentry", "0001_squashed_0200_release_indices"),
         ("sentry", "0201_semver_package"),

src/sentry/migrations/0490_add_is_test_to_org.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0489_index_checkin_timeout"),
     ]

src/sentry/migrations/0491_remove_orgmemmap_unique_constraints.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0490_add_is_test_to_org"),
     ]

src/sentry/migrations/0505_debugfile_date_accessed.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0504_add_artifact_bundle_index"),
     ]

src/sentry/migrations/0526_pr_comment_type_column.py

@@ -21,6 +21,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0525_add_next_checkin_latest"),
     ]

src/sentry/migrations/0535_add_created_date_to_outbox_model.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0534_add_notification_uuid_to_rule_fire_history"),
     ]

src/sentry/migrations/0544_remove_groupsubscription_columns.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0543_add_team_id_to_groupsubscription"),
     ]

src/sentry/migrations/0545_add_last_verified_auth_ident_replica.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0544_remove_groupsubscription_columns"),
     ]

src/sentry/migrations/0548_add_is_unclaimed_boolean_to_user.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0547_add_commitfilechange_language_column"),
     ]

src/sentry/migrations/0549_re_add_groupsubscription_columns.py

@@ -20,6 +20,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = True
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0548_add_is_unclaimed_boolean_to_user"),
     ]

src/sentry/migrations/0556_organizationmapping_replicate_require_2fa.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0555_set_neglectedrule_email_date_columns_nullable"),
     ]

src/sentry/migrations/0564_commitfilechange_delete_language_column.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0563_commitfilechange_drop_language_column"),
     ]

src/sentry/migrations/0570_repository_add_languages_column.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0569_dashboard_widgets_indicator"),
     ]

src/sentry/migrations/0583_add_early_adopter_to_organization_mapping.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0582_add_status_indexes_checkins"),
     ]

src/sentry/migrations/0590_add_metadata_to_sentry_app.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0589_add_commit_date_added_indices"),
     ]

src/sentry/migrations/0591_remove_relocation_hybrid_cloud_foreign_keys.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0590_add_metadata_to_sentry_app"),
     ]

src/sentry/migrations/0592_delete_relocation_hybrid_cloud_foreign_keys.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0591_remove_relocation_hybrid_cloud_foreign_keys"),
     ]

src/sentry/migrations/0607_drop_externalactor_actorid.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0606_update_user_to_optional_organization_slug_reservation"),
     ]

src/sentry/migrations/0610_remove_notification_setting_table.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0609_remove_notification_setting_model"),
     ]

src/sentry/migrations/0617_monitor_boolean_fields_muted_disabled.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0616_drop_event_user_id_from_userreport_table_step_1"),
     ]

src/sentry/migrations/0618_drop_event_user_id_from_userreport_table_step_2.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0617_monitor_boolean_fields_muted_disabled"),
     ]

src/sentry/migrations/0624_add_is_muted_monitorenvironment.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0623_increase_regression_fingerprint_length"),
     ]

src/sentry/migrations/0631_add_priority_columns_to_groupedmessage.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0630_better_monitor_latest_index"),
     ]

src/sentry/migrations/0633_add_priority_locked_at_to_groupedmessage.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0632_apitoken_backfill_last_chars"),
     ]

src/sentry/migrations/0637_remove_pr_comment_pr_id_constraint.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0636_monitor_incident_env_resolving_index"),
     ]

src/sentry/migrations/0638_add_date_added_to_dashboard_widget_on_demand.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0637_remove_pr_comment_pr_id_constraint"),
     ]

src/sentry/migrations/0643_add_date_modified_col_dashboard_widget_query.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0642_index_together_release"),
     ]

src/sentry/migrations/0651_enable_activated_alert_rules.py

@@ -23,6 +23,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0650_create_sentryshot"),
     ]

src/sentry/migrations/0657_add_status_column_for_alert_rule_trigger_action.py

@@ -19,6 +19,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0656_add_discover_dataset_split_dashboard"),
     ]

src/sentry/migrations/0658_projectkey_usecase.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0657_add_status_column_for_alert_rule_trigger_action"),
     ]

src/sentry/migrations/0663_artifactbundleindex_cleanup_step3.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0662_monitor_drop_last_state_change"),
     ]

src/sentry/migrations/0665_monitor_drop_last_state_change_db.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0664_create_new_broken_monitor_detection_table"),
     ]

src/sentry/migrations/0678_add_is_hidden_dashboard_widget_query.py

@@ -18,6 +18,8 @@ class Migration(CheckedMigration):
     #   change, it's completely safe to run the operation after the code has deployed.
     is_post_deployment = False
 
+    allow_run_sql = True
+
     dependencies = [
         ("sentry", "0677_unpickle_project_options_again"),
     ]