From 7ef97a54e2197167161e16a4dfd65d68df8b9928 Mon Sep 17 00:00:00 2001
From: Ville Brofeldt <33317356+villebro@users.noreply.github.com>
Date: Wed, 4 Aug 2021 22:12:20 +0300
Subject: [PATCH] feat(explore): add automatic conditional formatter to pivot
 table v2 (#16045)

---
 .../ConditionalFormattingControl.tsx          |   2 +
 .../FormattingPopoverContent.tsx              |  14 ++-
 .../ConditionalFormattingControl/types.ts     |   1 +
 ...migrate_pivot_table_v2_heatmaps_to_new_.py | 108 ++++++++++++++++++
 4 files changed, 123 insertions(+), 2 deletions(-)
 create mode 100644 superset/migrations/versions/143b6f2815da_migrate_pivot_table_v2_heatmaps_to_new_.py

diff --git a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/ConditionalFormattingControl.tsx b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/ConditionalFormattingControl.tsx
index bc72f983a..401364e0d 100644
--- a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/ConditionalFormattingControl.tsx
+++ b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/ConditionalFormattingControl.tsx
@@ -125,6 +125,8 @@ const ConditionalFormattingControl = ({
   }: ConditionalFormattingConfig) => {
     const columnName = (column && verboseMap?.[column]) ?? column;
     switch (operator) {
+      case COMPARATOR.NONE:
+        return `${columnName}`;
       case COMPARATOR.BETWEEN:
         return `${targetValueLeft} ${COMPARATOR.LESS_THAN} ${columnName} ${COMPARATOR.LESS_THAN} ${targetValueRight}`;
       case COMPARATOR.BETWEEN_OR_EQUAL:
diff --git a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/FormattingPopoverContent.tsx b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/FormattingPopoverContent.tsx
index 571131509..b23b456c4 100644
--- a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/FormattingPopoverContent.tsx
+++ b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/FormattingPopoverContent.tsx
@@ -44,6 +44,7 @@ const colorSchemeOptions = [
 ];
 
 const operatorOptions = [
+  { value: COMPARATOR.NONE, label: 'None' },
   { value: COMPARATOR.GREATER_THAN, label: '>' },
   { value: COMPARATOR.LESS_THAN, label: '<' },
   { value: COMPARATOR.GREATER_OR_EQUAL, label: '≥' },
@@ -68,6 +69,9 @@ export const FormattingPopoverContent = ({
   const isOperatorMultiValue = (operator?: COMPARATOR) =>
     operator && MULTIPLE_VALUE_COMPARATORS.includes(operator);
 
+  const isOperatorNone = (operator?: COMPARATOR) =>
+    !operator || operator === COMPARATOR.NONE;
+
   const operatorField = useMemo(
     () => (
       <FormItem
@@ -146,12 +150,18 @@ export const FormattingPopoverContent = ({
           prevValues: ConditionalFormattingConfig,
           currentValues: ConditionalFormattingConfig,
         ) =>
+          isOperatorNone(prevValues.operator) !==
+            isOperatorNone(currentValues.operator) ||
           isOperatorMultiValue(prevValues.operator) !==
-          isOperatorMultiValue(currentValues.operator)
+            isOperatorMultiValue(currentValues.operator)
         }
       >
         {({ getFieldValue }) =>
-          isOperatorMultiValue(getFieldValue('operator')) ? (
+          isOperatorNone(getFieldValue('operator')) ? (
+            <Row gutter={12}>
+              <Col span={6}>{operatorField}</Col>
+            </Row>
+          ) : isOperatorMultiValue(getFieldValue('operator')) ? (
             <Row gutter={12}>
               <Col span={9}>
                 <FormItem
diff --git a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/types.ts b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/types.ts
index e9a3e6eb3..99f2da1e9 100644
--- a/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/types.ts
+++ b/superset-frontend/src/explore/components/controls/ConditionalFormattingControl/types.ts
@@ -22,6 +22,7 @@ import { PopoverProps } from 'antd/lib/popover';
 import { ControlComponentProps } from '@superset-ui/chart-controls/lib/shared-controls/components/types';
 
 export enum COMPARATOR {
+  NONE = 'None',
   GREATER_THAN = '>',
   LESS_THAN = '<',
   GREATER_OR_EQUAL = '≥',
diff --git a/superset/migrations/versions/143b6f2815da_migrate_pivot_table_v2_heatmaps_to_new_.py b/superset/migrations/versions/143b6f2815da_migrate_pivot_table_v2_heatmaps_to_new_.py
new file mode 100644
index 000000000..888925a88
--- /dev/null
+++ b/superset/migrations/versions/143b6f2815da_migrate_pivot_table_v2_heatmaps_to_new_.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.
+"""migrate pivot table v2 heatmaps to new format
+
+Revision ID: 143b6f2815da
+Revises: e323605f370a
+Create Date: 2021-08-03 15:36:35.925420
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "143b6f2815da"
+down_revision = "e323605f370a"
+
+import json
+from typing import Any, Dict, List, Tuple
+
+from alembic import op
+from sqlalchemy import and_, Column, Integer, String, Text
+from sqlalchemy.ext.declarative import declarative_base
+
+from superset import db
+
+Base = declarative_base()
+
+
+class Slice(Base):
+    __tablename__ = "slices"
+    id = Column(Integer, primary_key=True)
+    viz_type = Column(String(250))
+    params = Column(Text)
+
+
+VALID_RENDERERS = (
+    "Table With Subtotal",
+    "Table With Subtotal Heatmap",
+    "Table With Subtotal Col Heatmap",
+    "Table With Subtotal Row Heatmap",
+    "Table With Subtotal Barchart",
+    "Table With Subtotal Col Barchart",
+    "Table With Subtotal Row Barchart",
+)
+
+
+def upgrade():
+    bind = op.get_bind()
+    session = db.Session(bind=bind)
+
+    slices = (
+        session.query(Slice)
+        .filter(
+            and_(
+                Slice.viz_type == "pivot_table_v2",
+                Slice.params.like('%"tableRenderer%'),
+            )
+        )
+        .all()
+    )
+    changed_slices = 0
+    for slice in slices:
+        try:
+            params = json.loads(slice.params)
+            table_renderer = params.pop("tableRenderer", None)
+            conditional_formatting = params.get("conditional_formatting")
+
+            # don't update unless table_renderer is valid and
+            # conditional_formatting is undefined
+            if table_renderer in VALID_RENDERERS and conditional_formatting is None:
+                metric_labels = [
+                    metric if isinstance(metric, str) else metric["label"]
+                    for metric in params.get("metrics")
+                ]
+                params["conditional_formatting"] = [
+                    {
+                        "colorScheme": "rgb(255,0,0)",
+                        "column": metric_label,
+                        "operator": "None",
+                    }
+                    for metric_label in metric_labels
+                ]
+                changed_slices += 1
+                slice.params = json.dumps(params, sort_keys=True)
+        except Exception as e:
+            print(f"Parsing json_metadata for slice {slice.id} failed.")
+            raise e
+
+    session.commit()
+    session.close()
+    print(f"Upgraded {changed_slices} slices.")
+
+
+def downgrade():
+    # slices can't be downgraded
+    pass