[WIP] Add SPI for custom plan checker and plugin for native plan validation #23596

BryanCutler · 2024-09-06T00:10:05Z

Description

This adds a new SPI to create a custom plan checker that will integrate with the built-in plan checkers to validate plans at intermediate, final and fragmented stages. A new plugin is added that provides a native plan checker that will send a plan fragment to the native sidecar where it is validated by performing a conversion to a Velox plan.

A new endpoint is added to the native worker to accept the plan node fragment and return an ok response if the conversion is successful and an error response if failed. The plugin has a configuration to fail the query by throwing an exception on an error, or only log the failure and continue.

In order to allow the query to fail fast, before execution begins, an optional system setting configuration is added that will eagerly build the plan async, so validation can be done early and the query can be removed from the queue without taking up worker resources.

RFC for this addition has been discussed and merged at https://github.com/prestodb/rfcs/blob/main/RFC-0008-plan-checker.md

Motivation and Context

This is a useful addition to help fail queries that are incompatible with Velox before execution begins and cluster resources have been allocated.

Impact

Adds an SPI for a custom plan checker.

Test Plan

Added unit tests for Java and C++, as well as manual testing of queries that currently fail on a native worker.

Contributor checklist

Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
Documented new properties (with its default value), SQL syntax, functions, or other functionality.
If release notes are required, they follow the release notes guidelines.
Adequate tests were added if applicable.
CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== RELEASE NOTES ==

General Changes
* ... :pr:`12345`
* ... :pr:`12345`

Hive Connector Changes
* ... :pr:`12345`
* ... :pr:`12345`

If release note is NOT required, use:

== NO RELEASE NOTE ==

linux-foundation-easycla · 2024-09-06T00:10:12Z

The committers listed above are authorized under a signed CLA.

✅ login: BryanCutler / name: Bryan Cutler (c5bfd3b, 486737b, baf8253, 27b0c2e, 9375271)

BryanCutler · 2024-09-06T00:12:45Z

Making this PR a draft as recent discussions will likely require a change to send the PlanFragment instead of only the PlanNode portion, and the response from the native endpoint would be more useful to also return the converted Velox plan.

cc @tdcmeehan @rschlussel

BryanCutler · 2024-09-13T21:38:38Z

I have separated out the first part of this, adding the session property to enable building and validating the plan eagerly at #23649

tdcmeehan

[Changes to SPI to support custom PlanChecker](https://github.com/prestodb/presto/pull/23596/commits/27b0c2ef2b4758de723712d8ad0cc142d9757b02) ✅

tdcmeehan

Changes to Java Presto main and server to support custom PlanChecker SPI ❓

tdcmeehan · 2024-09-18T14:52:40Z

presto-main/src/main/java/com/facebook/presto/server/ServerMainModule.java

@@ -371,6 +377,8 @@ else if (serverConfig.isCoordinator()) {
        driftClientBinder(binder).bindDriftClient(ThriftServerInfoClient.class, ForNodeManager.class)
                .withAddressSelector(((addressSelectorBinder, annotation, prefix) ->
                        addressSelectorBinder.bind(AddressSelector.class).annotatedWith(annotation).to(FixedAddressSelector.class)));
+        // NodeManager instance for plugins to use
+        binder.bind(NodeManager.class).to(ConnectorAwareNodeManager.class).in(Scopes.SINGLETON);


Rather than inject this, I would just construct it where needed.

tdcmeehan · 2024-09-18T15:06:27Z

presto-main/src/main/java/com/facebook/presto/sql/planner/sanity/PlanChecker.java

+    private Multimap<Stage, Checker> checkers;
+    private boolean providedInitialized;


Let's do the following:

Let's make checkers volatile. This will be accessed in a multithreaded environment, and the volatile keyword will ensure visibility after updates across multiple threads.

Let's remove providedInitialized, and instead add a method update which takes in a PlanCheckerProvider, which is called by the PlanCheckerProviderManager once the manager is initialized.

Now that the flow of communication is reversed, we don't need ensureProvidedInitialized.

Add a @GuardedBy("this") to the class to document the synchronization of this class.

tdcmeehan · 2024-09-18T15:07:53Z

...cebook/presto/sql/planner/sanity/plancheckerprovidermanagers/PlanCheckerProviderManager.java

+            properties = Collections.unmodifiableMap(new HashMap<>(loadProperties(PLAN_CHECKER_PROVIDER_CONFIG)));
+        }
+        else {
+            properties = Collections.emptyMap();


ImmutableMap.of()

tdcmeehan

Add plan checker provider and plugin for NativePlanChecker ❓

tdcmeehan · 2024-09-18T15:09:59Z

presto-plan-checker-providers/pom.xml

+        </dependency>
+
+        <dependency>
+            <groupId>org.mockito</groupId>


We don't use Mockito in the project. I'll update our development guidelines, but can you create the mocks by hand?

tdcmeehan · 2024-09-18T15:11:06Z

.../src/main/java/com/facebook/presto/plancheckerproviders/nativechecker/NativePlanChecker.java

+            else if (LOG.isDebugEnabled()) {
+                LOG.debug("Skipping Native Plan Validation for plan fragment id: %s", planFragment.getId());
+            }


I would remove LOG.isDebugEnabled

tdcmeehan · 2024-09-18T15:11:47Z

.../src/main/java/com/facebook/presto/plancheckerproviders/nativechecker/NativePlanChecker.java

+            }
+        }
+        catch (final PrestoException e) {
+            if (config.isQueryFailOnError()) {


What is the use case for not failing?

tdcmeehan · 2024-09-18T17:52:05Z

.../src/main/java/com/facebook/presto/plancheckerproviders/nativechecker/NativePlanChecker.java

+    private static final String PRESTO_SYSTEM_PROPERTY = "X-Presto-System-Property";
+    private static final String PRESTO_CATALOG_PROPERTY = "X-Presto-Catalog-Property";


tdcmeehan · 2024-09-18T17:53:14Z

...n/java/com/facebook/presto/plancheckerproviders/nativechecker/NativePlanCheckerProvider.java

+                Collections.singletonList(new NativePlanChecker(nodeManager, planFragmentJsonCodec, config)) :
+                Collections.emptyList();


Use ImmutableList

BryanCutler · 2024-09-18T21:51:22Z

presto-native-execution/presto_cpp/main/PrestoServer.cpp

+
+    // Create static taskId and empty TableWriteInfo needed for plan conversion
+    protocol::TaskId taskId = "velox-plan-conversion.0.0.0";
+    auto tableWriteInfo = std::make_shared<protocol::TableWriteInfo>();


TODO: this causes a problem for create table, need to address

BryanCutler force-pushed the native-fail-fast branch from 5b6bb75 to 9396c95 Compare September 10, 2024 02:30

BryanCutler added 5 commits September 12, 2024 17:10

Add system session property to build plan async

c5bfd3b

Changes to SPI to support custom PlanChecker

27b0c2e

Changes to Java Presto main and server to support custom PlanChecker SPI

486737b

Add plan checker provider and plugin for NativePlanChecker

baf8253

Changes to presto native to add plan conversion endpoint

9375271

BryanCutler mentioned this pull request Sep 13, 2024

Add property to enable eager building of plan as part of new native plan checker SPI #23649

Open

6 tasks

BryanCutler force-pushed the native-fail-fast branch from d5941a7 to 9375271 Compare September 13, 2024 21:37

tdcmeehan reviewed Sep 18, 2024

View reviewed changes

tdcmeehan requested changes Sep 18, 2024

View reviewed changes

tdcmeehan reviewed Sep 18, 2024

View reviewed changes

BryanCutler commented Sep 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add SPI for custom plan checker and plugin for native plan validation #23596

[WIP] Add SPI for custom plan checker and plugin for native plan validation #23596

BryanCutler commented Sep 6, 2024

linux-foundation-easycla bot commented Sep 6, 2024 •

edited

Loading

BryanCutler commented Sep 6, 2024

BryanCutler commented Sep 13, 2024

tdcmeehan left a comment

tdcmeehan left a comment

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

tdcmeehan left a comment

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

tdcmeehan Sep 18, 2024

BryanCutler Sep 18, 2024

		private Multimap<Stage, Checker> checkers;
		private boolean providedInitialized;

		private static final String PRESTO_SYSTEM_PROPERTY = "X-Presto-System-Property";
		private static final String PRESTO_CATALOG_PROPERTY = "X-Presto-Catalog-Property";

		Collections.singletonList(new NativePlanChecker(nodeManager, planFragmentJsonCodec, config)) :
		Collections.emptyList();

[WIP] Add SPI for custom plan checker and plugin for native plan validation #23596

Are you sure you want to change the base?

[WIP] Add SPI for custom plan checker and plugin for native plan validation #23596

Conversation

BryanCutler commented Sep 6, 2024

Description

Motivation and Context

Impact

Test Plan

Contributor checklist

Release Notes

linux-foundation-easycla bot commented Sep 6, 2024 • edited Loading

BryanCutler commented Sep 6, 2024

BryanCutler commented Sep 13, 2024

tdcmeehan left a comment

Choose a reason for hiding this comment

tdcmeehan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdcmeehan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Sep 6, 2024 •

edited

Loading