[GitHub] [superset] villebro commented on a diff in pull request #22248: chore: Add a migration that removes filter_bar_orientation from dashboard's json_metadata

[GitBox <gi...@apache.org>]

villebro commented on code in PR #22248:
URL: https://github.com/apache/superset/pull/22248#discussion_r1034547165


##########
superset/migrations/versions/2022-11-28_17-51_4ce1d9b25135_remove_filter_bar_orientation.py:
##########
@@ -0,0 +1,67 @@
+# 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.
+"""remove_filter_bar_orientation
+
+Revision ID: 4ce1d9b25135
+Revises: deb4c9d4a4ef
+Create Date: 2022-11-28 17:51:08.954439
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "4ce1d9b25135"
+down_revision = "deb4c9d4a4ef"
+
+import json
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.ext.declarative import declarative_base
+
+from superset import db
+
+Base = declarative_base()
+
+
+class Dashboard(Base):
+    __tablename__ = "dashboards"
+    id = sa.Column(sa.Integer, primary_key=True)
+    json_metadata = sa.Column(sa.Text)
+
+
+def upgrade():
+    pass
+
+
+def downgrade():
+    bind = op.get_bind()
+    session = db.Session(bind=bind)
+
+    dashboards = (
+        session.query(Dashboard)
+        .filter(Dashboard.json_metadata.like('%"filter_bar_orientation"%'))
+        .all()
+    )
+    for dashboard in dashboards:
+        try:
+            json_meta = json.loads(dashboard.json_metadata)
+            json_meta.pop("filter_bar_orientation", None)
+            dashboard.json_metadata = json.dumps(json_meta)

Review Comment:
   nit: To avoid unnecessarily updating the metadata if someone *happens* to have the text `filter_bar_orientation` in one of the titles, descriptions or similar (highly likely 😄), maybe add this as a precaution:
   ```suggestion
               filter_bar_orientation = json_meta.pop("filter_bar_orientation", None)
               if filter_bar_orientation:
                   dashboard.json_metadata = json.dumps(json_meta)
   ```



-- 
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: notifications-unsubscribe@superset.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org