Introduce a session property to print the before and after plan node of specified optimizations

presto-main/src/main/java/com/facebook/presto/Session.java

@@ -33,6 +33,7 @@
 import com.facebook.presto.spi.session.SessionPropertyConfigurationManager.SystemSessionPropertyConfiguration;
 import com.facebook.presto.spi.tracing.Tracer;
 import com.facebook.presto.sql.planner.optimizations.OptimizerInformationCollector;
+import com.facebook.presto.sql.planner.optimizations.OptimizerResultCollector;
 import com.facebook.presto.transaction.TransactionManager;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
@@ -93,6 +94,7 @@ public final class Session
 
     private final RuntimeStats runtimeStats = new RuntimeStats();
     private final OptimizerInformationCollector optimizerInformationCollector = new OptimizerInformationCollector();
+    private final OptimizerResultCollector optimizerResultCollector = new OptimizerResultCollector();
 
     public Session(
             QueryId queryId,
@@ -319,6 +321,11 @@ public OptimizerInformationCollector getOptimizerInformationCollector()
         return optimizerInformationCollector;
     }
 
+    public OptimizerResultCollector getOptimizerResultCollector()
+    {
+        return optimizerResultCollector;
+    }
+
     public Session beginTransactionId(TransactionId transactionId, TransactionManager transactionManager, AccessControl accessControl)
     {
         requireNonNull(transactionId, "transactionId is null");

presto-main/src/main/java/com/facebook/presto/SystemSessionProperties.java

@@ -239,6 +239,7 @@ public final class SystemSessionProperties
     public static final String DISTRIBUTED_TRACING_MODE = "distributed_tracing_mode";
     public static final String VERBOSE_RUNTIME_STATS_ENABLED = "verbose_runtime_stats_enabled";
     public static final String VERBOSE_OPTIMIZER_INFO_ENABLED = "verbose_optimizer_info_enabled";
+    public static final String VERBOSE_OPTIMIZER_RESULTS = "verbose_optimizer_results";
     public static final String STREAMING_FOR_PARTIAL_AGGREGATION_ENABLED = "streaming_for_partial_aggregation_enabled";
     public static final String MAX_STAGE_COUNT_FOR_EAGER_SCHEDULING = "max_stage_count_for_eager_scheduling";
     public static final String HYPERLOGLOG_STANDARD_ERROR_WARNING_THRESHOLD = "hyperloglog_standard_error_warning_threshold";
@@ -1302,6 +1303,16 @@ public SystemSessionProperties(
                         "Enable logging of verbose information about applied optimizations",
                         featuresConfig.isVerboseOptimizerInfoEnabled(),
                         false),
+                /**/
+                new PropertyMetadata<>(
+                        VERBOSE_OPTIMIZER_RESULTS,
+                        "Print result of selected optimizer(s), allowed values are ALL | NONE | <OptimizerClassName>[,<OptimizerClassName>...]",
+                        VARCHAR,
+                        VerboseOptimizerResultsProperty.class,
+                        VerboseOptimizerResultsProperty.disabled(),
+                        false,
+                        value -> VerboseOptimizerResultsProperty.valueOf((String) value),
+                        object -> object),
                 booleanProperty(
                         STREAMING_FOR_PARTIAL_AGGREGATION_ENABLED,
                         "Enable streaming for partial aggregation",
@@ -2485,6 +2496,16 @@ public static boolean isVerboseRuntimeStatsEnabled(Session session)
         return session.getSystemProperty(VERBOSE_RUNTIME_STATS_ENABLED, Boolean.class);
     }
 
+    public static boolean isVerboseOptimizerResults(Session session)
+    {
+        return session.getSystemProperty(VERBOSE_OPTIMIZER_RESULTS, VerboseOptimizerResultsProperty.class).isEnabled();
+    }
+
+    public static boolean isVerboseOptimizerResults(Session session, String optimizer)
+    {
+        return session.getSystemProperty(VERBOSE_OPTIMIZER_RESULTS, VerboseOptimizerResultsProperty.class).containsOptimizer(optimizer);
+    }
+
     public static boolean isVerboseOptimizerInfoEnabled(Session session)
     {
         return session.getSystemProperty(VERBOSE_OPTIMIZER_INFO_ENABLED, Boolean.class);

presto-main/src/main/java/com/facebook/presto/VerboseOptimizerResultsProperty.java

@@ -0,0 +1,68 @@
+/*
+ * 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.
+ */
+package com.facebook.presto;
+
+import com.google.common.base.Splitter;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static java.util.Objects.requireNonNull;
+
+public class VerboseOptimizerResultsProperty
+{
+    private boolean isEnabled;
+    private boolean isDetailedAllOptimizerResults;
+    private List<String> optimizerNames;
+
+    public VerboseOptimizerResultsProperty(boolean isEnabled, boolean isDetailedAllOptimizerResults, List<String> optimizerNames)
+    {
+        this.isEnabled = isEnabled;
+        this.isDetailedAllOptimizerResults = isDetailedAllOptimizerResults;
+        this.optimizerNames = requireNonNull(optimizerNames, "optimizerNames is null");
+    }
+
+    public boolean isEnabled()
+    {
+        return isEnabled;
+    }
+
+    public boolean isDetailedAllOptimizerResults()
+    {
+        return isDetailedAllOptimizerResults;
+    }
+
+    public boolean containsOptimizer(String optimizerName)
+    {
+        return isDetailedAllOptimizerResults || optimizerNames.contains(optimizerName);
+    }
+
+    public static VerboseOptimizerResultsProperty disabled()
+    {
+        return new VerboseOptimizerResultsProperty(false, false, new ArrayList<>());
+    }
+
+    public static VerboseOptimizerResultsProperty valueOf(String value)
+    {
+        if (value.equalsIgnoreCase("none")) {
+            return disabled();
+        }
+        if (value.equalsIgnoreCase("all")) {
+            return new VerboseOptimizerResultsProperty(true, true, new ArrayList<>());
+        }
+
+        List<String> optimizerNames = Splitter.on(',').trimResults().omitEmptyStrings().splitToList(value);
+        return new VerboseOptimizerResultsProperty(true, false, optimizerNames);
+    }
+}

presto-main/src/main/java/com/facebook/presto/sql/Optimizer.java

@@ -31,6 +31,7 @@
 import com.facebook.presto.spi.plan.PlanNodeIdAllocator;
 import com.facebook.presto.sql.parser.SqlParser;
 import com.facebook.presto.sql.planner.Plan;
+import com.facebook.presto.sql.planner.PlannerUtils;
 import com.facebook.presto.sql.planner.TypeProvider;
 import com.facebook.presto.sql.planner.iterative.IterativeOptimizer;
 import com.facebook.presto.sql.planner.optimizations.PlanNodeSearcher;
@@ -45,6 +46,7 @@
 import static com.facebook.presto.SystemSessionProperties.getQueryAnalyzerTimeout;
 import static com.facebook.presto.SystemSessionProperties.isPrintStatsForNonJoinQuery;
 import static com.facebook.presto.SystemSessionProperties.isVerboseOptimizerInfoEnabled;
+import static com.facebook.presto.SystemSessionProperties.isVerboseOptimizerResults;
 import static com.facebook.presto.common.RuntimeUnit.NANO;
 import static com.facebook.presto.spi.StandardErrorCode.QUERY_PLANNING_TIMEOUT;
 import static com.facebook.presto.sql.Optimizer.PlanStage.OPTIMIZED;
@@ -113,7 +115,9 @@ public Plan validateAndOptimizePlan(PlanNode root, PlanStage stage)
                 if (enableVerboseRuntimeStats) {
                     session.getRuntimeStats().addMetricValue(String.format("optimizer%sTimeNanos", optimizer.getClass().getSimpleName()), NANO, System.nanoTime() - start);
                 }
-                collectOptimizerInformation(optimizer, root, newRoot);
+                TypeProvider types = TypeProvider.viewOf(variableAllocator.getVariables());
+
+                collectOptimizerInformation(optimizer, root, newRoot, types);
                 root = newRoot;
             }
         }
@@ -139,21 +143,28 @@ private StatsAndCosts computeStats(PlanNode root, TypeProvider types)
         return StatsAndCosts.empty();
     }
 
-    private void collectOptimizerInformation(PlanOptimizer optimizer, PlanNode oldNode, PlanNode newNode)
+    private void collectOptimizerInformation(PlanOptimizer optimizer, PlanNode oldNode, PlanNode newNode, TypeProvider types)
     {
         if (optimizer instanceof IterativeOptimizer) {
             // iterative optimizers do their own recording of what rules got triggered
             return;
         }
 
+        String optimizerName = optimizer.getClass().getSimpleName();
         boolean isTriggered = (oldNode != newNode);
         boolean isApplicable =
                 isTriggered ||
                 !optimizer.isEnabled(session) && isVerboseOptimizerInfoEnabled(session) &&
                         optimizer.isApplicable(oldNode, session, TypeProvider.viewOf(variableAllocator.getVariables()), variableAllocator, idAllocator, warningCollector);
 
         if (isTriggered || isApplicable) {
-            session.getOptimizerInformationCollector().addInformation(new PlanOptimizerInformation(optimizer.getClass().getSimpleName(), isTriggered, Optional.of(isApplicable)));
+            session.getOptimizerInformationCollector().addInformation(new PlanOptimizerInformation(optimizerName, isTriggered, Optional.of(isApplicable)));
+        }
+
+        if (isTriggered && isVerboseOptimizerResults(session, optimizerName)) {
+            String oldNodeStr = PlannerUtils.getPlanString(oldNode, session, types, metadata, false);
+            String newNodeStr = PlannerUtils.getPlanString(newNode, session, types, metadata, false);
+            session.getOptimizerResultCollector().addOptimizerResult(optimizerName, oldNodeStr, newNodeStr);
         }
     }
 }

presto-main/src/main/java/com/facebook/presto/sql/analyzer/QueryExplainer.java

@@ -46,6 +46,7 @@
 import java.util.Map;
 import java.util.Optional;
 
+import static com.facebook.presto.SystemSessionProperties.isVerboseOptimizerInfoEnabled;
 import static com.facebook.presto.common.RuntimeMetricName.LOGICAL_PLANNER_TIME_NANOS;
 import static com.facebook.presto.common.RuntimeMetricName.OPTIMIZER_TIME_NANOS;
 import static com.facebook.presto.spi.StandardErrorCode.NOT_SUPPORTED;
@@ -133,7 +134,7 @@ public String getPlan(Session session, Statement statement, Type planType, List<
         switch (planType) {
             case LOGICAL:
                 Plan plan = getLogicalPlan(session, statement, parameters, warningCollector);
-                return PlanPrinter.textLogicalPlan(plan.getRoot(), plan.getTypes(), plan.getStatsAndCosts(), metadata.getFunctionAndTypeManager(), session, 0, verbose);
+                return PlanPrinter.textLogicalPlan(plan.getRoot(), plan.getTypes(), plan.getStatsAndCosts(), metadata.getFunctionAndTypeManager(), session, 0, verbose, isVerboseOptimizerInfoEnabled(session));
             case DISTRIBUTED:
                 SubPlan subPlan = getDistributedPlan(session, statement, parameters, warningCollector);
                 return PlanPrinter.textDistributedPlan(subPlan, metadata.getFunctionAndTypeManager(), session, verbose);