fix: Migration to fix out of sync schema_perm in charts and datasets (#24884)

superset/migrations/versions/2023-08-02_15-23_0769ef90fddd_fix_schema_perm_for_datasets.py

@@ -0,0 +1,108 @@
+# 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.
+"""Fix schema perm for datasets
+
+Revision ID: 0769ef90fddd
+Revises: ee179a490af9
+Create Date: 2023-08-02 15:23:58.242396
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "0769ef90fddd"
+down_revision = "ee179a490af9"
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects.sqlite.base import SQLiteDialect
+from sqlalchemy.ext.declarative import declarative_base
+
+from superset import db
+
+Base = declarative_base()
+
+
+class SqlaTable(Base):
+    __tablename__ = "tables"
+
+    id = sa.Column(sa.Integer, primary_key=True)
+    schema = sa.Column(sa.String(255))
+    schema_perm = sa.Column(sa.String(1000))
+    database_id = sa.Column(sa.Integer, sa.ForeignKey("dbs.id"))
+
+
+class Slice(Base):
+    __tablename__ = "slices"
+
+    id = sa.Column(sa.Integer, primary_key=True)
+    schema_perm = sa.Column(sa.String(1000))
+    datasource_id = sa.Column(sa.Integer)
+
+
+class Database(Base):
+    __tablename__ = "dbs"
+
+    id = sa.Column(sa.Integer, primary_key=True)
+    database_name = sa.Column(sa.String(250))
+
+
+def fix_datasets_schema_perm(session):
+    for result in (
+        session.query(SqlaTable, Database.database_name)
+        .join(Database)
+        .filter(SqlaTable.schema.isnot(None))
+        .filter(
+            SqlaTable.schema_perm
+            != sa.func.concat("[", Database.database_name, "].[", SqlaTable.schema, "]")
+        )
+    ):
+        result.SqlaTable.schema_perm = (
+            f"[{result.database_name}].[{result.SqlaTable.schema}]"
+        )
+
+
+def fix_charts_schema_perm(session):
+    for result in (
+        session.query(Slice, SqlaTable, Database.database_name)
+        .join(SqlaTable, Slice.datasource_id == SqlaTable.id)
+        .join(Database, SqlaTable.database_id == Database.id)
+        .filter(SqlaTable.schema.isnot(None))
+        .filter(
+            Slice.schema_perm
+            != sa.func.concat("[", Database.database_name, "].[", SqlaTable.schema, "]")
+        )
+    ):
+        result.Slice.schema_perm = (
+            f"[{result.database_name}].[{result.SqlaTable.schema}]"
+        )
+
+
+def upgrade():
+    bind = op.get_bind()
+    session = db.Session(bind=bind)
+    if isinstance(bind.dialect, SQLiteDialect):
+        return  # sqlite doesn't have a concat function
+
+    fix_datasets_schema_perm(session)
+    fix_charts_schema_perm(session)
+
+    session.commit()
+    session.close()
+
+
+def downgrade():
+    pass

tests/integration_tests/migrations/0769ef90fddd_fix_schema_perm_for_datasets__tests.py

@@ -0,0 +1,56 @@
+# 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.
+from importlib import import_module
+
+import pytest
+
+from superset import db
+from superset.connectors.sqla.models import SqlaTable
+from superset.models.slice import Slice
+from superset.utils.core import backend, get_example_default_schema
+from tests.integration_tests.fixtures.birth_names_dashboard import (
+    load_birth_names_dashboard_with_slices,
+    load_birth_names_data,
+)
+
+migration_module = import_module(
+    "superset.migrations.versions."
+    "2023-08-02_15-23_0769ef90fddd_fix_schema_perm_for_datasets"
+)
+
+fix_datasets_schema_perm = migration_module.fix_datasets_schema_perm
+fix_charts_schema_perm = migration_module.fix_charts_schema_perm
+
+
+@pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+def test_fix_schema_perm():
+    if backend() == "sqlite":
+        return
+
+    dataset = db.session.query(SqlaTable).filter_by(table_name="birth_names").one()
+    chart = db.session.query(Slice).filter_by(slice_name="Girls").one()
+    dataset.schema_perm = "wrong"
+    chart.schema_perm = "wrong"
+    db.session.commit()
+
+    fix_datasets_schema_perm(db.session)
+    db.session.commit()
+    assert dataset.schema_perm == f"[examples].[{get_example_default_schema()}]"
+
+    fix_charts_schema_perm(db.session)
+    db.session.commit()
+    assert chart.schema_perm == f"[examples].[{get_example_default_schema()}]"