Add missing indexes for commonly used Foreign Keys (#10545)

* Add missing indexes for commonly used Foreign Keys

These aren't automatically created, so for many of these large tables we are doing sequential scans when accessing the relation

* lint

Author: ewdurbin

warehouse/accounts/models.py

@@ -188,6 +188,7 @@ class WebAuthn(db.Model):
         UUID(as_uuid=True),
         ForeignKey("users.id", deferrable=True, initially="DEFERRED"),
         nullable=False,
+        index=True,
     )
     label = Column(String, nullable=False)
     credential_id = Column(String, unique=True, nullable=False)
@@ -202,6 +203,7 @@ class RecoveryCode(db.Model):
         UUID(as_uuid=True),
         ForeignKey("users.id", deferrable=True, initially="DEFERRED"),
         nullable=False,
+        index=True,
     )
     code = Column(String(length=128), nullable=False)
     generated = Column(DateTime, nullable=False, server_default=sql.func.now())
@@ -214,6 +216,7 @@ class UserEvent(db.Model):
         UUID(as_uuid=True),
         ForeignKey("users.id", deferrable=True, initially="DEFERRED"),
         nullable=False,
+        index=True,
     )
     tag = Column(String, nullable=False)
     time = Column(DateTime, nullable=False, server_default=sql.func.now())

warehouse/integrations/vulnerabilities/models.py

@@ -23,6 +23,7 @@
         "release_id",
         ForeignKey("releases.id", onupdate="CASCADE", ondelete="CASCADE"),
         nullable=False,
+        index=True,
     ),
     Column(
         "vulnerability_source",

warehouse/macaroons/models.py

@@ -42,7 +42,9 @@ class Macaroon(db.Model):
     # All of our Macaroons belong to a specific user, because a caveat-less
     # Macaroon should act the same as their password does, instead of as a
     # global permission to upload files.
-    user_id = Column(UUID(as_uuid=True), ForeignKey("users.id"), nullable=False)
+    user_id = Column(
+        UUID(as_uuid=True), ForeignKey("users.id"), nullable=False, index=True
+    )
 
     # Store some information about the Macaroon to give users some mechanism
     # to differentiate between them.

warehouse/migrations/versions/1b97443dea8a_create_missing_fk_indexes.py

@@ -0,0 +1,114 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+create missing FK indexes
+
+Revision ID: 1b97443dea8a
+Revises: d18d443f89f0
+Create Date: 2022-01-03 20:52:20.615419
+"""
+
+from alembic import op
+
+revision = "1b97443dea8a"
+down_revision = "d18d443f89f0"
+
+
+def upgrade():
+    # CREATE INDEX CONCURRENTLY cannot happen inside a transaction. We'll close
+    # our transaction here and issue the statement.
+    op.execute("COMMIT")
+
+    op.create_index(
+        op.f("ix_macaroons_user_id"),
+        "macaroons",
+        ["user_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_project_events_project_id"),
+        "project_events",
+        ["project_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_release_vulnerabilities_release_id"),
+        "release_vulnerabilities",
+        ["release_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_releases_description_id"),
+        "releases",
+        ["description_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_role_invitations_project_id"),
+        "role_invitations",
+        ["project_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_role_invitations_user_id"),
+        "role_invitations",
+        ["user_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_user_events_user_id"),
+        "user_events",
+        ["user_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_user_recovery_codes_user_id"),
+        "user_recovery_codes",
+        ["user_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+    op.create_index(
+        op.f("ix_user_security_keys_user_id"),
+        "user_security_keys",
+        ["user_id"],
+        unique=False,
+        postgresql_concurrently=True,
+    )
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(
+        op.f("ix_user_security_keys_user_id"), table_name="user_security_keys"
+    )
+    op.drop_index(
+        op.f("ix_user_recovery_codes_user_id"), table_name="user_recovery_codes"
+    )
+    op.drop_index(op.f("ix_user_events_user_id"), table_name="user_events")
+    op.drop_index(op.f("ix_role_invitations_user_id"), table_name="role_invitations")
+    op.drop_index(op.f("ix_role_invitations_project_id"), table_name="role_invitations")
+    op.drop_index(op.f("ix_releases_description_id"), table_name="releases")
+    op.drop_index(
+        op.f("ix_release_vulnerabilities_release_id"),
+        table_name="release_vulnerabilities",
+    )
+    op.drop_index(op.f("ix_project_events_project_id"), table_name="project_events")
+    op.drop_index(op.f("ix_macaroons_user_id"), table_name="macaroons")
+    # ### end Alembic commands ###

warehouse/packaging/models.py

@@ -105,11 +105,14 @@ class RoleInvitation(db.Model):
     )
     token = Column(Text, nullable=False)
     user_id = Column(
-        ForeignKey("users.id", onupdate="CASCADE", ondelete="CASCADE"), nullable=False
+        ForeignKey("users.id", onupdate="CASCADE", ondelete="CASCADE"),
+        nullable=False,
+        index=True,
     )
     project_id = Column(
         ForeignKey("projects.id", onupdate="CASCADE", ondelete="CASCADE"),
         nullable=False,
+        index=True,
     )
 
     user = orm.relationship(User, lazy=False)
@@ -279,6 +282,7 @@ class ProjectEvent(db.Model):
             "projects.id", deferrable=True, initially="DEFERRED", ondelete="CASCADE"
         ),
         nullable=False,
+        index=True,
     )
     tag = Column(String, nullable=False)
     time = Column(DateTime, nullable=False, server_default=sql.func.now())
@@ -380,6 +384,7 @@ def __table_args__(cls):  # noqa
     description_id = Column(
         ForeignKey("release_descriptions.id", onupdate="CASCADE", ondelete="CASCADE"),
         nullable=False,
+        index=True,
     )
     description = orm.relationship(
         "Description",