Constraint on normalized organization names (#17998)

* Constraint on normalized organization names

* Update tests

* Add test against org catalog name reuse prevention

Author: di

tests/unit/admin/views/test_organizations.py

@@ -372,7 +372,7 @@ def test_rename(self, db_request):
     @pytest.mark.usefixtures("_enable_organizations")
     def test_rename_fails_on_conflict(self, db_request):
         admin = UserFactory.create()
-        organization = OrganizationFactory.create(name="widget")
+        OrganizationFactory.create(name="widget")
         organization = OrganizationFactory.create(name="example")
 
         db_request.matchdict = {"organization_id": organization.id}

tests/unit/organizations/test_services.py

@@ -708,7 +708,7 @@ def test_rename_organization_back(self, organization_service, db_request):
             .count()
         ) == 1
 
-    def test_rename_fails_if_entry_exists_for_another_org(
+    def test_rename_fails_if_organization_name_in_use(
         self, organization_service, db_request
     ):
         conflicting_org = OrganizationFactory.create()
@@ -719,6 +719,17 @@ def test_rename_fails_if_entry_exists_for_another_org(
                 organization.id, conflicting_org.name
             )
 
+    def test_rename_fails_if_organization_name_previously_used(
+        self, organization_service, db_request
+    ):
+        conflicting_org = OrganizationFactory.create()
+        original_name = conflicting_org.name
+        organization_service.rename_organization(conflicting_org.id, "some_new_name")
+        organization = OrganizationFactory.create()
+
+        with pytest.raises(ValueError):  # noqa: PT011
+            organization_service.rename_organization(organization.id, original_name)
+
     def test_update_organization(self, organization_service, db_request):
         organization = OrganizationFactory.create()
 

warehouse/migrations/versions/f609b35e981b_unique_normalized_organization_names.py

@@ -0,0 +1,64 @@
+# 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.
+"""
+Unique normalized organization names
+
+Revision ID: f609b35e981b
+Revises: 4f8982e60deb
+Create Date: 2025-04-21 16:23:05.015207
+"""
+
+import sqlalchemy as sa
+
+from alembic import op
+
+revision = "f609b35e981b"
+down_revision = "4f8982e60deb"
+
+
+def upgrade():
+    op.add_column(
+        "organizations", sa.Column("normalized_name", sa.String(), nullable=True)
+    )
+    op.execute(
+        """
+        UPDATE organizations
+        SET normalized_name = normalize_pep426_name(name)
+        """
+    )
+    op.alter_column("organizations", "normalized_name", nullable=False)
+    op.create_unique_constraint(None, "organizations", ["normalized_name"])
+
+    op.execute(
+        """ CREATE OR REPLACE FUNCTION maintain_organizations_normalized_name()
+            RETURNS TRIGGER AS $$
+                BEGIN
+                    NEW.normalized_name :=  normalize_pep426_name(NEW.name);
+                    RETURN NEW;
+                END;
+            $$
+            LANGUAGE plpgsql
+        """
+    )
+
+    op.execute(
+        """ CREATE TRIGGER organizations_update_normalized_name
+            BEFORE INSERT OR UPDATE OF name ON organizations
+            FOR EACH ROW
+            EXECUTE PROCEDURE maintain_organizations_normalized_name()
+        """
+    )
+
+
+def downgrade():
+    op.drop_constraint(None, "organizations", type_="unique")
+    op.drop_column("organizations", "normalized_name")

warehouse/organizations/models.py

@@ -22,6 +22,7 @@
 from sqlalchemy import (
     CheckConstraint,
     Enum,
+    FetchedValue,
     ForeignKey,
     Index,
     UniqueConstraint,
@@ -276,10 +277,6 @@ def __table_args__(cls):  # noqa: N805
 
     name: Mapped[str] = mapped_column(comment="The account name used in URLS")
 
-    @declared_attr
-    def normalized_name(cls):  # noqa: N805
-        return column_property(func.normalize_pep426_name(cls.name))
-
     display_name: Mapped[str] = mapped_column(comment="Display name used in UI")
     orgtype: Mapped[enum.Enum] = mapped_column(
         Enum(OrganizationType, values_callable=lambda x: [e.value for e in x]),
@@ -299,6 +296,11 @@ class Organization(OrganizationMixin, HasEvents, db.Model):
 
     __repr__ = make_repr("name")
 
+    normalized_name: Mapped[str] = mapped_column(
+        unique=True,
+        server_default=FetchedValue(),
+        server_onupdate=FetchedValue(),
+    )
     is_active: Mapped[bool_false] = mapped_column(
         comment="When True, the organization is active and all features are available.",
     )
@@ -538,6 +540,10 @@ class OrganizationApplication(OrganizationMixin, HasObservations, db.Model):
     __tablename__ = "organization_applications"
     __repr__ = make_repr("name")
 
+    @declared_attr
+    def normalized_name(cls):  # noqa: N805
+        return column_property(func.normalize_pep426_name(cls.name))
+
     submitted_by_id: Mapped[UUID] = mapped_column(
         PG_UUID,
         ForeignKey(

warehouse/organizations/services.py

@@ -12,7 +12,7 @@
 import datetime
 
 from sqlalchemy import delete, func, orm, select
-from sqlalchemy.exc import NoResultFound
+from sqlalchemy.exc import IntegrityError, NoResultFound
 from zope.interface import implementer
 
 from warehouse.accounts.models import TermsOfServiceEngagement, User
@@ -524,8 +524,11 @@ def rename_organization(self, organization_id, name):
         organization = self.get_organization(organization_id)
         organization.name = name
 
-        self.db.flush()  # flush db now so organization.normalized_name available
-        self.add_catalog_entry(organization_id)
+        try:
+            self.db.flush()  # flush db now so organization.normalized_name available
+            self.add_catalog_entry(organization_id)
+        except IntegrityError:
+            raise ValueError(f'Organization name "{name}" has been used')
 
         return organization