[VL] Consistent Exception Handling With Spark

Open
#13,647 7 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java, scala, spark

Research direction

Start by reading the translateException hook in gluten-arrow/src/main/java/org/apache/gluten/vectorized/ColumnarBatchOutIterator.java and the error propagation in cpp/core/jni/JniError.h. Compare the Spark and Velox exception behavior described here, then review the alternatives and user experience tradeoff with maintainers. Done means the project has decided whether and how Gluten should translate Velox exceptions to Spark exceptions.

Written by the indexing model from the issue text.

Description

enhancement
Description

Hey folks

I was hoping to get feedback on a proposal.

Proposal

Translate Velox generated exception to Spark exceptions to maintain consistent exception semantics with Spark. The necessary hooks have already been provided in translateException


Current State
  • Today when we enable new Velox operators in gluten we propagate the Velox exception message via a gluten exception
  • The Velox exception can be different than that of Spark. For example:

Spark JVM:

"Exceeds char/varchar type length limitation: 5"

Velox:

"Exceeds allowed length limitation: 5"

Why It's an Issue

Let me explain using an example. In #12976 a new Velox operator was enabled in Gluten:

  • Enabling the operator was 1 line of change (remove if from the kBlackList array:
const std::unordered_set<std::string> kBlackList = {"split_part", "sequence", "approx_percentile", "map_from_arrays"};
  • However after enabling the operator it starts to raise a different type of exception, causing the spark tests that assert the exception to fail. This caused 20+ sparks tests that relied on the operator to fail which required exclusion such as:
...
.excludeGlutenTest("NOT NULL checks for nullable map with required values (byName)")
.excludeGlutenTest("NOT NULL checks for nullable map with required values (byPosition)")
.excludeGlutenTest("NOT NULL checks for fields inside nullable maps (byPosition)")
...

To avoid losing test coverage spark tests were copied over adding 800 lines of test code (duplicate code with spark tests with a few lines different during exception assertions).


User Experience

This would change user experience though which needs a decision on the repo. User would no longer be receiving a gluten specific error message and the experience would be transparent regardless of which execution engine is running spark. A decision that the repo would need to make if its the correct experience.


Alternative Solution, Option 2

Regarding reason2 we could rely on Apache spark to enable the exception assertions in their tests to be extensible such as assertLengthCheckFailure.

The challenge with this is:

  • The spark team seems reluctant of adding these extensions (please see comment)
  • The extensions would only help with spark versions going forward and previous spark versions would still have the code duplication

Alternative Solution, Option 3

We rely on Velox to throw exceptions consistent with Spark. My understanding is that Velox does strive to be agnostic to the specific data processing system that uses it so incorporating these changes there might prove challenging.

Gluten version

main branch

Dominant language
Scala
Stars
1.6k
Forks
679
Avg merge
4d 16h
Merged PRs (30d)
84

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/gluten

All issues in apache/gluten

Similar issues

More Scala issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.