mikebridge commented on code in PR #40128: URL: https://github.com/apache/superset/pull/40128#discussion_r3508851965
########## superset/migrations/versions/2026-05-08_12-05_9e1f3b8c4d2a_add_deleted_at_to_dashboards.py: ########## @@ -0,0 +1,201 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""Add deleted_at + partial unique slug index for soft-delete. + +Adds to the ``dashboards`` table: +- a nullable ``deleted_at`` column for soft-delete state +- an index ``ix_dashboards_deleted_at`` for the visibility-filter listener +- a partial unique index ``ix_dashboards_active_slug`` enforcing slug + uniqueness only among active (non-soft-deleted) rows + +Drops: +- the existing full unique constraint on ``slug`` (named + ``idx_unique_slug``, created in migration 1a48a5411020) + +The constraint change makes the ``slug`` field reusable after soft-delete: +soft-deleted rows no longer reserve their slug for the lifetime of the +row. ``RestoreDashboardCommand`` handles the reverse case (restoring a +dashboard whose slug has since been claimed by another active row) with +an explicit conflict error. See UPDATING.md for the user-facing change. + +Dialect support for the partial index: +- PostgreSQL: native ``WHERE deleted_at IS NULL`` partial index +- MySQL 8.0+: functional index over + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` +- MySQL <8.0: keeps the original full unique constraint (documented + limitation; functional indexes are not supported on these versions) +- SQLite: keeps the original full unique constraint (column-level + ``UNIQUE`` cannot be dropped without recreating the table, which is + not worth the migration complexity for a test-only dialect). Tests + that need to verify the partial-index behaviour run only on + PostgreSQL and MySQL 8+. + +Revision ID: 9e1f3b8c4d2a +Revises: 78a40c08b4be +Create Date: 2026-05-08 12:05:00.000000 +""" + +from alembic import op +from sqlalchemy import Column, DateTime +from sqlalchemy.engine import Connection + +from superset.migrations.shared.utils import ( + add_columns, + create_index, + drop_columns, + drop_index, + table_has_index, +) + +# revision identifiers, used by Alembic. +revision = "9e1f3b8c4d2a" +down_revision = "78a40c08b4be" + +TABLE_NAME = "dashboards" +DELETED_AT_INDEX_NAME = f"ix_{TABLE_NAME}_deleted_at" +PARTIAL_SLUG_INDEX_NAME = f"ix_{TABLE_NAME}_active_slug" +# The original full unique constraint on ``slug`` was created with an +# explicit name in migration 1a48a5411020 (2015-12-04). Same name on +# PostgreSQL (constraint) and MySQL (index). +LEGACY_SLUG_INDEX_NAME = "idx_unique_slug" + + +def _mysql_supports_functional_index(bind: Connection) -> bool: + """Return True iff the connected MySQL is 8.0.13+ (supports functional indexes). + + MySQL added functional key parts in 8.0.13; 8.0.0–8.0.12 reject the + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` expression at index + creation time, so deployments on those patch releases must keep the + original full slug constraint. See + https://dev.mysql.com/doc/mysql/8.0/en/create-index.html for the + 8.0.13 minimum. + + Excludes MariaDB even at server version ``>= (10, x)`` because MariaDB + reports through the same ``server_version_info`` attribute but uses + different functional-index semantics around ``CASE`` expressions. + Uses SQLAlchemy's parsed ``server_version_info`` rather than ``SELECT + VERSION()`` to avoid an extra round-trip and brittle string parsing. + """ + if getattr(bind.dialect, "is_mariadb", False): + return False + return (bind.dialect.server_version_info or ()) >= (8, 0, 13) + + +def upgrade() -> None: + bind = op.get_bind() + _add_deleted_at_column() + _replace_slug_constraint_with_partial_index(bind) + + +def downgrade() -> None: + bind = op.get_bind() + _restore_slug_constraint(bind) + _drop_deleted_at_column() + + +def _add_deleted_at_column() -> None: + add_columns(TABLE_NAME, Column("deleted_at", DateTime(), nullable=True)) + create_index(TABLE_NAME, DELETED_AT_INDEX_NAME, ["deleted_at"]) + + +def _drop_deleted_at_column() -> None: + drop_index(TABLE_NAME, DELETED_AT_INDEX_NAME) + drop_columns(TABLE_NAME, "deleted_at") + + +def _replace_slug_constraint_with_partial_index(bind: Connection) -> None: + """Swap the full UNIQUE on ``slug`` for a partial index where supported. + + The original constraint is named ``idx_unique_slug`` from migration + 1a48a5411020 — same name on PostgreSQL (constraint) and MySQL (index). + + SQLite and MySQL <8.0 are no-ops here: they keep the original full + unique constraint. See the module docstring for the rationale. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"DROP CONSTRAINT IF EXISTS {LEGACY_SLUG_INDEX_NAME}" + ) + # Some installations may have the unique enforced as a plain + # index rather than a constraint. Both DROPs are IF EXISTS, so + # whichever path applies cleans up. + op.execute(f"DROP INDEX IF EXISTS {LEGACY_SLUG_INDEX_NAME}") Review Comment: The raw DDL is intentional and dialect-specific: it creates a **partial** unique index (`WHERE deleted_at IS NULL` on PostgreSQL) / a **functional** index (`CASE WHEN deleted_at IS NULL THEN slug END` on MySQL 8.0.13+), neither of which the shared `create_index`/`drop_index` helper can express (no WHERE-predicate or functional-key-part support). Verified up/down on PostgreSQL. Declining. ########## superset/migrations/versions/2026-05-08_12-05_9e1f3b8c4d2a_add_deleted_at_to_dashboards.py: ########## @@ -0,0 +1,201 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""Add deleted_at + partial unique slug index for soft-delete. + +Adds to the ``dashboards`` table: +- a nullable ``deleted_at`` column for soft-delete state +- an index ``ix_dashboards_deleted_at`` for the visibility-filter listener +- a partial unique index ``ix_dashboards_active_slug`` enforcing slug + uniqueness only among active (non-soft-deleted) rows + +Drops: +- the existing full unique constraint on ``slug`` (named + ``idx_unique_slug``, created in migration 1a48a5411020) + +The constraint change makes the ``slug`` field reusable after soft-delete: +soft-deleted rows no longer reserve their slug for the lifetime of the +row. ``RestoreDashboardCommand`` handles the reverse case (restoring a +dashboard whose slug has since been claimed by another active row) with +an explicit conflict error. See UPDATING.md for the user-facing change. + +Dialect support for the partial index: +- PostgreSQL: native ``WHERE deleted_at IS NULL`` partial index +- MySQL 8.0+: functional index over + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` +- MySQL <8.0: keeps the original full unique constraint (documented + limitation; functional indexes are not supported on these versions) +- SQLite: keeps the original full unique constraint (column-level + ``UNIQUE`` cannot be dropped without recreating the table, which is + not worth the migration complexity for a test-only dialect). Tests + that need to verify the partial-index behaviour run only on + PostgreSQL and MySQL 8+. + +Revision ID: 9e1f3b8c4d2a +Revises: 78a40c08b4be +Create Date: 2026-05-08 12:05:00.000000 +""" + +from alembic import op +from sqlalchemy import Column, DateTime +from sqlalchemy.engine import Connection + +from superset.migrations.shared.utils import ( + add_columns, + create_index, + drop_columns, + drop_index, + table_has_index, +) + +# revision identifiers, used by Alembic. +revision = "9e1f3b8c4d2a" +down_revision = "78a40c08b4be" + +TABLE_NAME = "dashboards" +DELETED_AT_INDEX_NAME = f"ix_{TABLE_NAME}_deleted_at" +PARTIAL_SLUG_INDEX_NAME = f"ix_{TABLE_NAME}_active_slug" +# The original full unique constraint on ``slug`` was created with an +# explicit name in migration 1a48a5411020 (2015-12-04). Same name on +# PostgreSQL (constraint) and MySQL (index). +LEGACY_SLUG_INDEX_NAME = "idx_unique_slug" + + +def _mysql_supports_functional_index(bind: Connection) -> bool: + """Return True iff the connected MySQL is 8.0.13+ (supports functional indexes). + + MySQL added functional key parts in 8.0.13; 8.0.0–8.0.12 reject the + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` expression at index + creation time, so deployments on those patch releases must keep the + original full slug constraint. See + https://dev.mysql.com/doc/mysql/8.0/en/create-index.html for the + 8.0.13 minimum. + + Excludes MariaDB even at server version ``>= (10, x)`` because MariaDB + reports through the same ``server_version_info`` attribute but uses + different functional-index semantics around ``CASE`` expressions. + Uses SQLAlchemy's parsed ``server_version_info`` rather than ``SELECT + VERSION()`` to avoid an extra round-trip and brittle string parsing. + """ + if getattr(bind.dialect, "is_mariadb", False): + return False + return (bind.dialect.server_version_info or ()) >= (8, 0, 13) + + +def upgrade() -> None: + bind = op.get_bind() + _add_deleted_at_column() + _replace_slug_constraint_with_partial_index(bind) + + +def downgrade() -> None: + bind = op.get_bind() + _restore_slug_constraint(bind) + _drop_deleted_at_column() + + +def _add_deleted_at_column() -> None: + add_columns(TABLE_NAME, Column("deleted_at", DateTime(), nullable=True)) + create_index(TABLE_NAME, DELETED_AT_INDEX_NAME, ["deleted_at"]) + + +def _drop_deleted_at_column() -> None: + drop_index(TABLE_NAME, DELETED_AT_INDEX_NAME) + drop_columns(TABLE_NAME, "deleted_at") + + +def _replace_slug_constraint_with_partial_index(bind: Connection) -> None: + """Swap the full UNIQUE on ``slug`` for a partial index where supported. + + The original constraint is named ``idx_unique_slug`` from migration + 1a48a5411020 — same name on PostgreSQL (constraint) and MySQL (index). + + SQLite and MySQL <8.0 are no-ops here: they keep the original full + unique constraint. See the module docstring for the rationale. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"DROP CONSTRAINT IF EXISTS {LEGACY_SLUG_INDEX_NAME}" + ) + # Some installations may have the unique enforced as a plain + # index rather than a constraint. Both DROPs are IF EXISTS, so + # whichever path applies cleans up. + op.execute(f"DROP INDEX IF EXISTS {LEGACY_SLUG_INDEX_NAME}") + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} (slug) WHERE deleted_at IS NULL" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Create the functional replacement BEFORE dropping the legacy unique + # index. MySQL autocommits each DDL statement (unlike PostgreSQL's + # transactional DDL above, where a failed CREATE rolls back the DROP), + # so a drop-then-create ordering would leave the table with no slug + # uniqueness if the CREATE failed. Creating first keeps the stricter + # existing uniqueness in place until the replacement is confirmed. + # Both statements are guarded by ``table_has_index`` because MySQL has + # no ``IF [NOT] EXISTS`` for indexes and DDL autocommits: an unguarded + # run on a table missing the legacy index (it was created inside + # ``try/except: pass`` in 2015's ``1a48a5411020``) would fail AFTER + # the partial index was committed, wedging the migration — the re-run + # would then die on the duplicate partial index. The guards make the + # migration re-runnable from any partial state. + if not table_has_index(TABLE_NAME, PARTIAL_SLUG_INDEX_NAME): + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} ((CASE WHEN deleted_at IS NULL THEN slug END))" + ) + if table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute(f"ALTER TABLE {TABLE_NAME} DROP INDEX {LEGACY_SLUG_INDEX_NAME}") Review Comment: The raw DDL is intentional and dialect-specific: it creates a **partial** unique index (`WHERE deleted_at IS NULL` on PostgreSQL) / a **functional** index (`CASE WHEN deleted_at IS NULL THEN slug END` on MySQL 8.0.13+), neither of which the shared `create_index`/`drop_index` helper can express (no WHERE-predicate or functional-key-part support). Verified up/down on PostgreSQL. Declining. ########## superset/migrations/versions/2026-05-08_12-05_9e1f3b8c4d2a_add_deleted_at_to_dashboards.py: ########## @@ -0,0 +1,201 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""Add deleted_at + partial unique slug index for soft-delete. + +Adds to the ``dashboards`` table: +- a nullable ``deleted_at`` column for soft-delete state +- an index ``ix_dashboards_deleted_at`` for the visibility-filter listener +- a partial unique index ``ix_dashboards_active_slug`` enforcing slug + uniqueness only among active (non-soft-deleted) rows + +Drops: +- the existing full unique constraint on ``slug`` (named + ``idx_unique_slug``, created in migration 1a48a5411020) + +The constraint change makes the ``slug`` field reusable after soft-delete: +soft-deleted rows no longer reserve their slug for the lifetime of the +row. ``RestoreDashboardCommand`` handles the reverse case (restoring a +dashboard whose slug has since been claimed by another active row) with +an explicit conflict error. See UPDATING.md for the user-facing change. + +Dialect support for the partial index: +- PostgreSQL: native ``WHERE deleted_at IS NULL`` partial index +- MySQL 8.0+: functional index over + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` +- MySQL <8.0: keeps the original full unique constraint (documented + limitation; functional indexes are not supported on these versions) +- SQLite: keeps the original full unique constraint (column-level + ``UNIQUE`` cannot be dropped without recreating the table, which is + not worth the migration complexity for a test-only dialect). Tests + that need to verify the partial-index behaviour run only on + PostgreSQL and MySQL 8+. + +Revision ID: 9e1f3b8c4d2a +Revises: 78a40c08b4be +Create Date: 2026-05-08 12:05:00.000000 +""" + +from alembic import op +from sqlalchemy import Column, DateTime +from sqlalchemy.engine import Connection + +from superset.migrations.shared.utils import ( + add_columns, + create_index, + drop_columns, + drop_index, + table_has_index, +) + +# revision identifiers, used by Alembic. +revision = "9e1f3b8c4d2a" +down_revision = "78a40c08b4be" + +TABLE_NAME = "dashboards" +DELETED_AT_INDEX_NAME = f"ix_{TABLE_NAME}_deleted_at" +PARTIAL_SLUG_INDEX_NAME = f"ix_{TABLE_NAME}_active_slug" +# The original full unique constraint on ``slug`` was created with an +# explicit name in migration 1a48a5411020 (2015-12-04). Same name on +# PostgreSQL (constraint) and MySQL (index). +LEGACY_SLUG_INDEX_NAME = "idx_unique_slug" + + +def _mysql_supports_functional_index(bind: Connection) -> bool: + """Return True iff the connected MySQL is 8.0.13+ (supports functional indexes). + + MySQL added functional key parts in 8.0.13; 8.0.0–8.0.12 reject the + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` expression at index + creation time, so deployments on those patch releases must keep the + original full slug constraint. See + https://dev.mysql.com/doc/mysql/8.0/en/create-index.html for the + 8.0.13 minimum. + + Excludes MariaDB even at server version ``>= (10, x)`` because MariaDB + reports through the same ``server_version_info`` attribute but uses + different functional-index semantics around ``CASE`` expressions. + Uses SQLAlchemy's parsed ``server_version_info`` rather than ``SELECT + VERSION()`` to avoid an extra round-trip and brittle string parsing. + """ + if getattr(bind.dialect, "is_mariadb", False): + return False + return (bind.dialect.server_version_info or ()) >= (8, 0, 13) + + +def upgrade() -> None: + bind = op.get_bind() + _add_deleted_at_column() + _replace_slug_constraint_with_partial_index(bind) + + +def downgrade() -> None: + bind = op.get_bind() + _restore_slug_constraint(bind) + _drop_deleted_at_column() + + +def _add_deleted_at_column() -> None: + add_columns(TABLE_NAME, Column("deleted_at", DateTime(), nullable=True)) + create_index(TABLE_NAME, DELETED_AT_INDEX_NAME, ["deleted_at"]) + + +def _drop_deleted_at_column() -> None: + drop_index(TABLE_NAME, DELETED_AT_INDEX_NAME) + drop_columns(TABLE_NAME, "deleted_at") + + +def _replace_slug_constraint_with_partial_index(bind: Connection) -> None: + """Swap the full UNIQUE on ``slug`` for a partial index where supported. + + The original constraint is named ``idx_unique_slug`` from migration + 1a48a5411020 — same name on PostgreSQL (constraint) and MySQL (index). + + SQLite and MySQL <8.0 are no-ops here: they keep the original full + unique constraint. See the module docstring for the rationale. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"DROP CONSTRAINT IF EXISTS {LEGACY_SLUG_INDEX_NAME}" + ) + # Some installations may have the unique enforced as a plain + # index rather than a constraint. Both DROPs are IF EXISTS, so + # whichever path applies cleans up. + op.execute(f"DROP INDEX IF EXISTS {LEGACY_SLUG_INDEX_NAME}") + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} (slug) WHERE deleted_at IS NULL" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Create the functional replacement BEFORE dropping the legacy unique + # index. MySQL autocommits each DDL statement (unlike PostgreSQL's + # transactional DDL above, where a failed CREATE rolls back the DROP), + # so a drop-then-create ordering would leave the table with no slug + # uniqueness if the CREATE failed. Creating first keeps the stricter + # existing uniqueness in place until the replacement is confirmed. + # Both statements are guarded by ``table_has_index`` because MySQL has + # no ``IF [NOT] EXISTS`` for indexes and DDL autocommits: an unguarded + # run on a table missing the legacy index (it was created inside + # ``try/except: pass`` in 2015's ``1a48a5411020``) would fail AFTER + # the partial index was committed, wedging the migration — the re-run + # would then die on the duplicate partial index. The guards make the + # migration re-runnable from any partial state. + if not table_has_index(TABLE_NAME, PARTIAL_SLUG_INDEX_NAME): + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} ((CASE WHEN deleted_at IS NULL THEN slug END))" + ) + if table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute(f"ALTER TABLE {TABLE_NAME} DROP INDEX {LEGACY_SLUG_INDEX_NAME}") + + +def _restore_slug_constraint(bind: Connection) -> None: + """Restore the full UNIQUE on ``slug`` from the partial index. + + Symmetric counterpart to ``_replace_slug_constraint_with_partial_index``. + No-op on dialects that never received the partial index. + + Pre-condition: each value of ``slug`` (other than NULL) must appear at + most once across the entire ``dashboards`` table. The partial-index + window allowed an active row and a soft-deleted row to share a slug; + rebuilding the full unique constraint will abort with a + ``UniqueViolation`` if any such pair still exists. Before downgrading, + hard-delete the soft-deleted duplicates (or rename one side of each + pair) so the constraint can be added cleanly. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute(f"DROP INDEX IF EXISTS {PARTIAL_SLUG_INDEX_NAME}") Review Comment: The raw DDL is intentional and dialect-specific: it creates a **partial** unique index (`WHERE deleted_at IS NULL` on PostgreSQL) / a **functional** index (`CASE WHEN deleted_at IS NULL THEN slug END` on MySQL 8.0.13+), neither of which the shared `create_index`/`drop_index` helper can express (no WHERE-predicate or functional-key-part support). Verified up/down on PostgreSQL. Declining. ########## superset/models/dashboard.py: ########## @@ -192,6 +202,27 @@ class Dashboard(CoreDashboard, AuditMixinNullable, ImportExportMixin): ] extra_import_fields = ["is_managed_externally", "external_url", "theme_id"] + @classmethod + def _unique_constraints(cls) -> list[set[str]]: + """Import identity keys for ``import_from_dict``. + + ``slug`` lost its column-level ``unique=True`` when the full unique + constraint was replaced by a partial (active-rows-only) index for + soft-delete. ``ImportExportMixin._unique_constraints`` derives import + lookup keys from unique columns/constraints, so without this override a + re-import whose UUID differs but whose ``slug`` matches an existing + active dashboard would no longer be matched-and-updated by slug — it + would fall through to an insert and collide on the partial active-slug + index at flush. Re-add ``{"slug"}`` here so import keeps matching by + slug (the pre-soft-delete behaviour) while DB-level uniqueness stays + partial. A ``NULL`` slug is skipped by the importer's filter builder, + so this only adds a real lookup when the imported config carries a slug. + """ + constraints = super()._unique_constraints() + if {"slug"} not in constraints: + constraints.append({"slug"}) + return constraints Review Comment: Verified this does **not** reproduce on SQLAlchemy 1.4 (this repo's pinned version). The importer skips null-valued keys when building each constraint clause (`helpers.py`: `if dict_rep.get(k) is not None`), and SA then **drops the resulting empty `and_()` from the `or_`** — `or_(<real clause>, and_())` compiles to just `<real clause>`, not `TRUE`. So a slug-less import does not broaden the lookup and cannot raise `MultipleResultsFound`. This empty-clause handling is the pre-existing behaviour for every nullable unique-constraint key, not something this PR introduces. The `_unique_constraints` comment is accurate. Declining. ########## superset/translations/pt/LC_MESSAGES/messages.po: ########## @@ -4401,6 +4401,9 @@ msgstr "Não foi possível gravar a sua query" msgid "Dashboard could not be deleted." msgstr "Não foi possível gravar a sua query" +msgid "Dashboard could not be restored." +msgstr "" Review Comment: An empty `msgstr` is expected for newly-extracted strings — the `.po` catalogs carry the new message ids with empty translations until translators fill them in; an untranslated string falls back to the source text and is not a defect. Declining. ########## superset/migrations/versions/2026-05-08_12-05_9e1f3b8c4d2a_add_deleted_at_to_dashboards.py: ########## @@ -0,0 +1,201 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""Add deleted_at + partial unique slug index for soft-delete. + +Adds to the ``dashboards`` table: +- a nullable ``deleted_at`` column for soft-delete state +- an index ``ix_dashboards_deleted_at`` for the visibility-filter listener +- a partial unique index ``ix_dashboards_active_slug`` enforcing slug + uniqueness only among active (non-soft-deleted) rows + +Drops: +- the existing full unique constraint on ``slug`` (named + ``idx_unique_slug``, created in migration 1a48a5411020) + +The constraint change makes the ``slug`` field reusable after soft-delete: +soft-deleted rows no longer reserve their slug for the lifetime of the +row. ``RestoreDashboardCommand`` handles the reverse case (restoring a +dashboard whose slug has since been claimed by another active row) with +an explicit conflict error. See UPDATING.md for the user-facing change. + +Dialect support for the partial index: +- PostgreSQL: native ``WHERE deleted_at IS NULL`` partial index +- MySQL 8.0+: functional index over + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` +- MySQL <8.0: keeps the original full unique constraint (documented + limitation; functional indexes are not supported on these versions) +- SQLite: keeps the original full unique constraint (column-level + ``UNIQUE`` cannot be dropped without recreating the table, which is + not worth the migration complexity for a test-only dialect). Tests + that need to verify the partial-index behaviour run only on + PostgreSQL and MySQL 8+. + +Revision ID: 9e1f3b8c4d2a +Revises: 78a40c08b4be +Create Date: 2026-05-08 12:05:00.000000 +""" + +from alembic import op +from sqlalchemy import Column, DateTime +from sqlalchemy.engine import Connection + +from superset.migrations.shared.utils import ( + add_columns, + create_index, + drop_columns, + drop_index, + table_has_index, +) + +# revision identifiers, used by Alembic. +revision = "9e1f3b8c4d2a" +down_revision = "78a40c08b4be" + +TABLE_NAME = "dashboards" +DELETED_AT_INDEX_NAME = f"ix_{TABLE_NAME}_deleted_at" +PARTIAL_SLUG_INDEX_NAME = f"ix_{TABLE_NAME}_active_slug" +# The original full unique constraint on ``slug`` was created with an +# explicit name in migration 1a48a5411020 (2015-12-04). Same name on +# PostgreSQL (constraint) and MySQL (index). +LEGACY_SLUG_INDEX_NAME = "idx_unique_slug" + + +def _mysql_supports_functional_index(bind: Connection) -> bool: + """Return True iff the connected MySQL is 8.0.13+ (supports functional indexes). + + MySQL added functional key parts in 8.0.13; 8.0.0–8.0.12 reject the + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` expression at index + creation time, so deployments on those patch releases must keep the + original full slug constraint. See + https://dev.mysql.com/doc/mysql/8.0/en/create-index.html for the + 8.0.13 minimum. + + Excludes MariaDB even at server version ``>= (10, x)`` because MariaDB + reports through the same ``server_version_info`` attribute but uses + different functional-index semantics around ``CASE`` expressions. + Uses SQLAlchemy's parsed ``server_version_info`` rather than ``SELECT + VERSION()`` to avoid an extra round-trip and brittle string parsing. + """ + if getattr(bind.dialect, "is_mariadb", False): + return False + return (bind.dialect.server_version_info or ()) >= (8, 0, 13) + + +def upgrade() -> None: + bind = op.get_bind() + _add_deleted_at_column() + _replace_slug_constraint_with_partial_index(bind) + + +def downgrade() -> None: + bind = op.get_bind() + _restore_slug_constraint(bind) + _drop_deleted_at_column() + + +def _add_deleted_at_column() -> None: + add_columns(TABLE_NAME, Column("deleted_at", DateTime(), nullable=True)) + create_index(TABLE_NAME, DELETED_AT_INDEX_NAME, ["deleted_at"]) + + +def _drop_deleted_at_column() -> None: + drop_index(TABLE_NAME, DELETED_AT_INDEX_NAME) + drop_columns(TABLE_NAME, "deleted_at") + + +def _replace_slug_constraint_with_partial_index(bind: Connection) -> None: + """Swap the full UNIQUE on ``slug`` for a partial index where supported. + + The original constraint is named ``idx_unique_slug`` from migration + 1a48a5411020 — same name on PostgreSQL (constraint) and MySQL (index). + + SQLite and MySQL <8.0 are no-ops here: they keep the original full + unique constraint. See the module docstring for the rationale. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"DROP CONSTRAINT IF EXISTS {LEGACY_SLUG_INDEX_NAME}" + ) + # Some installations may have the unique enforced as a plain + # index rather than a constraint. Both DROPs are IF EXISTS, so + # whichever path applies cleans up. + op.execute(f"DROP INDEX IF EXISTS {LEGACY_SLUG_INDEX_NAME}") + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} (slug) WHERE deleted_at IS NULL" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Create the functional replacement BEFORE dropping the legacy unique + # index. MySQL autocommits each DDL statement (unlike PostgreSQL's + # transactional DDL above, where a failed CREATE rolls back the DROP), + # so a drop-then-create ordering would leave the table with no slug + # uniqueness if the CREATE failed. Creating first keeps the stricter + # existing uniqueness in place until the replacement is confirmed. + # Both statements are guarded by ``table_has_index`` because MySQL has + # no ``IF [NOT] EXISTS`` for indexes and DDL autocommits: an unguarded + # run on a table missing the legacy index (it was created inside + # ``try/except: pass`` in 2015's ``1a48a5411020``) would fail AFTER + # the partial index was committed, wedging the migration — the re-run + # would then die on the duplicate partial index. The guards make the + # migration re-runnable from any partial state. + if not table_has_index(TABLE_NAME, PARTIAL_SLUG_INDEX_NAME): + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} ((CASE WHEN deleted_at IS NULL THEN slug END))" + ) + if table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute(f"ALTER TABLE {TABLE_NAME} DROP INDEX {LEGACY_SLUG_INDEX_NAME}") + + +def _restore_slug_constraint(bind: Connection) -> None: + """Restore the full UNIQUE on ``slug`` from the partial index. + + Symmetric counterpart to ``_replace_slug_constraint_with_partial_index``. + No-op on dialects that never received the partial index. + + Pre-condition: each value of ``slug`` (other than NULL) must appear at + most once across the entire ``dashboards`` table. The partial-index + window allowed an active row and a soft-deleted row to share a slug; + rebuilding the full unique constraint will abort with a + ``UniqueViolation`` if any such pair still exists. Before downgrading, + hard-delete the soft-deleted duplicates (or rename one side of each + pair) so the constraint can be added cleanly. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute(f"DROP INDEX IF EXISTS {PARTIAL_SLUG_INDEX_NAME}") + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"ADD CONSTRAINT {LEGACY_SLUG_INDEX_NAME} UNIQUE (slug)" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Symmetric to the upgrade: add the full unique index before dropping + # the partial one, so a failed ADD leaves the partial uniqueness intact + # rather than no uniqueness (MySQL autocommits each DDL statement). + # Guarded like the upgrade so the downgrade is re-runnable from any + # partial state — including a deployment that migrated on a pre-8.0.13 + # server (no-op upgrade branch, legacy index still present) and later + # upgraded the server, where the unguarded ADD would collide. + if not table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"ADD UNIQUE INDEX {LEGACY_SLUG_INDEX_NAME} (slug)" + ) Review Comment: The raw DDL is intentional and dialect-specific: it creates a **partial** unique index (`WHERE deleted_at IS NULL` on PostgreSQL) / a **functional** index (`CASE WHEN deleted_at IS NULL THEN slug END` on MySQL 8.0.13+), neither of which the shared `create_index`/`drop_index` helper can express (no WHERE-predicate or functional-key-part support). Verified up/down on PostgreSQL. Declining. ########## superset/migrations/versions/2026-05-08_12-05_9e1f3b8c4d2a_add_deleted_at_to_dashboards.py: ########## @@ -0,0 +1,201 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +"""Add deleted_at + partial unique slug index for soft-delete. + +Adds to the ``dashboards`` table: +- a nullable ``deleted_at`` column for soft-delete state +- an index ``ix_dashboards_deleted_at`` for the visibility-filter listener +- a partial unique index ``ix_dashboards_active_slug`` enforcing slug + uniqueness only among active (non-soft-deleted) rows + +Drops: +- the existing full unique constraint on ``slug`` (named + ``idx_unique_slug``, created in migration 1a48a5411020) + +The constraint change makes the ``slug`` field reusable after soft-delete: +soft-deleted rows no longer reserve their slug for the lifetime of the +row. ``RestoreDashboardCommand`` handles the reverse case (restoring a +dashboard whose slug has since been claimed by another active row) with +an explicit conflict error. See UPDATING.md for the user-facing change. + +Dialect support for the partial index: +- PostgreSQL: native ``WHERE deleted_at IS NULL`` partial index +- MySQL 8.0+: functional index over + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` +- MySQL <8.0: keeps the original full unique constraint (documented + limitation; functional indexes are not supported on these versions) +- SQLite: keeps the original full unique constraint (column-level + ``UNIQUE`` cannot be dropped without recreating the table, which is + not worth the migration complexity for a test-only dialect). Tests + that need to verify the partial-index behaviour run only on + PostgreSQL and MySQL 8+. + +Revision ID: 9e1f3b8c4d2a +Revises: 78a40c08b4be +Create Date: 2026-05-08 12:05:00.000000 +""" + +from alembic import op +from sqlalchemy import Column, DateTime +from sqlalchemy.engine import Connection + +from superset.migrations.shared.utils import ( + add_columns, + create_index, + drop_columns, + drop_index, + table_has_index, +) + +# revision identifiers, used by Alembic. +revision = "9e1f3b8c4d2a" +down_revision = "78a40c08b4be" + +TABLE_NAME = "dashboards" +DELETED_AT_INDEX_NAME = f"ix_{TABLE_NAME}_deleted_at" +PARTIAL_SLUG_INDEX_NAME = f"ix_{TABLE_NAME}_active_slug" +# The original full unique constraint on ``slug`` was created with an +# explicit name in migration 1a48a5411020 (2015-12-04). Same name on +# PostgreSQL (constraint) and MySQL (index). +LEGACY_SLUG_INDEX_NAME = "idx_unique_slug" + + +def _mysql_supports_functional_index(bind: Connection) -> bool: + """Return True iff the connected MySQL is 8.0.13+ (supports functional indexes). + + MySQL added functional key parts in 8.0.13; 8.0.0–8.0.12 reject the + ``(CASE WHEN deleted_at IS NULL THEN slug END)`` expression at index + creation time, so deployments on those patch releases must keep the + original full slug constraint. See + https://dev.mysql.com/doc/mysql/8.0/en/create-index.html for the + 8.0.13 minimum. + + Excludes MariaDB even at server version ``>= (10, x)`` because MariaDB + reports through the same ``server_version_info`` attribute but uses + different functional-index semantics around ``CASE`` expressions. + Uses SQLAlchemy's parsed ``server_version_info`` rather than ``SELECT + VERSION()`` to avoid an extra round-trip and brittle string parsing. + """ + if getattr(bind.dialect, "is_mariadb", False): + return False + return (bind.dialect.server_version_info or ()) >= (8, 0, 13) + + +def upgrade() -> None: + bind = op.get_bind() + _add_deleted_at_column() + _replace_slug_constraint_with_partial_index(bind) + + +def downgrade() -> None: + bind = op.get_bind() + _restore_slug_constraint(bind) + _drop_deleted_at_column() + + +def _add_deleted_at_column() -> None: + add_columns(TABLE_NAME, Column("deleted_at", DateTime(), nullable=True)) + create_index(TABLE_NAME, DELETED_AT_INDEX_NAME, ["deleted_at"]) + + +def _drop_deleted_at_column() -> None: + drop_index(TABLE_NAME, DELETED_AT_INDEX_NAME) + drop_columns(TABLE_NAME, "deleted_at") + + +def _replace_slug_constraint_with_partial_index(bind: Connection) -> None: + """Swap the full UNIQUE on ``slug`` for a partial index where supported. + + The original constraint is named ``idx_unique_slug`` from migration + 1a48a5411020 — same name on PostgreSQL (constraint) and MySQL (index). + + SQLite and MySQL <8.0 are no-ops here: they keep the original full + unique constraint. See the module docstring for the rationale. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"DROP CONSTRAINT IF EXISTS {LEGACY_SLUG_INDEX_NAME}" + ) + # Some installations may have the unique enforced as a plain + # index rather than a constraint. Both DROPs are IF EXISTS, so + # whichever path applies cleans up. + op.execute(f"DROP INDEX IF EXISTS {LEGACY_SLUG_INDEX_NAME}") + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} (slug) WHERE deleted_at IS NULL" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Create the functional replacement BEFORE dropping the legacy unique + # index. MySQL autocommits each DDL statement (unlike PostgreSQL's + # transactional DDL above, where a failed CREATE rolls back the DROP), + # so a drop-then-create ordering would leave the table with no slug + # uniqueness if the CREATE failed. Creating first keeps the stricter + # existing uniqueness in place until the replacement is confirmed. + # Both statements are guarded by ``table_has_index`` because MySQL has + # no ``IF [NOT] EXISTS`` for indexes and DDL autocommits: an unguarded + # run on a table missing the legacy index (it was created inside + # ``try/except: pass`` in 2015's ``1a48a5411020``) would fail AFTER + # the partial index was committed, wedging the migration — the re-run + # would then die on the duplicate partial index. The guards make the + # migration re-runnable from any partial state. + if not table_has_index(TABLE_NAME, PARTIAL_SLUG_INDEX_NAME): + op.execute( + f"CREATE UNIQUE INDEX {PARTIAL_SLUG_INDEX_NAME} " + f"ON {TABLE_NAME} ((CASE WHEN deleted_at IS NULL THEN slug END))" + ) + if table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute(f"ALTER TABLE {TABLE_NAME} DROP INDEX {LEGACY_SLUG_INDEX_NAME}") + + +def _restore_slug_constraint(bind: Connection) -> None: + """Restore the full UNIQUE on ``slug`` from the partial index. + + Symmetric counterpart to ``_replace_slug_constraint_with_partial_index``. + No-op on dialects that never received the partial index. + + Pre-condition: each value of ``slug`` (other than NULL) must appear at + most once across the entire ``dashboards`` table. The partial-index + window allowed an active row and a soft-deleted row to share a slug; + rebuilding the full unique constraint will abort with a + ``UniqueViolation`` if any such pair still exists. Before downgrading, + hard-delete the soft-deleted duplicates (or rename one side of each + pair) so the constraint can be added cleanly. + """ + dialect = bind.dialect.name + if dialect == "postgresql": + op.execute(f"DROP INDEX IF EXISTS {PARTIAL_SLUG_INDEX_NAME}") + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"ADD CONSTRAINT {LEGACY_SLUG_INDEX_NAME} UNIQUE (slug)" + ) + elif dialect == "mysql" and _mysql_supports_functional_index(bind): + # Symmetric to the upgrade: add the full unique index before dropping + # the partial one, so a failed ADD leaves the partial uniqueness intact + # rather than no uniqueness (MySQL autocommits each DDL statement). + # Guarded like the upgrade so the downgrade is re-runnable from any + # partial state — including a deployment that migrated on a pre-8.0.13 + # server (no-op upgrade branch, legacy index still present) and later + # upgraded the server, where the unguarded ADD would collide. + if not table_has_index(TABLE_NAME, LEGACY_SLUG_INDEX_NAME): + op.execute( + f"ALTER TABLE {TABLE_NAME} " + f"ADD UNIQUE INDEX {LEGACY_SLUG_INDEX_NAME} (slug)" + ) + if table_has_index(TABLE_NAME, PARTIAL_SLUG_INDEX_NAME): + op.execute(f"ALTER TABLE {TABLE_NAME} DROP INDEX {PARTIAL_SLUG_INDEX_NAME}") Review Comment: The raw DDL is intentional and dialect-specific: it creates a **partial** unique index (`WHERE deleted_at IS NULL` on PostgreSQL) / a **functional** index (`CASE WHEN deleted_at IS NULL THEN slug END` on MySQL 8.0.13+), neither of which the shared `create_index`/`drop_index` helper can express (no WHERE-predicate or functional-key-part support). Verified up/down on PostgreSQL. Declining. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
