Skip to content

[SPARK-21533][SQL] Print warning messages when override function configure found in Hive UDFs #18768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
maropu wants to merge 3 commits into from
Closed

[SPARK-21533][SQL] Print warning messages when override function configure found in Hive UDFs #18768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d586a8
Print warning messages when override function `configure` found
maropu Jul 29, 2017
c9b6080
Apply viirya's comment
maropu Jul 30, 2017
34238ff
Apply more comment
maropu Jul 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sql/hive/src/main/scala/org/apache/spark/sql/hive/HiveSessionCatalog.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import org.apache.spark.sql.catalyst.analysis.FunctionRegistry.FunctionBuilder
import org.apache.spark.sql.catalyst.catalog.{CatalogFunction, FunctionResourceLoader, GlobalTempViewManager, SessionCatalog}
import org.apache.spark.sql.catalyst.expressions.{Cast, Expression}
import org.apache.spark.sql.catalyst.parser.ParserInterface
import org.apache.spark.sql.hive.HiveShim.HiveFunctionWrapper
import org.apache.spark.sql.hive.HiveShim._
import org.apache.spark.sql.internal.SQLConf
import org.apache.spark.sql.types.{DecimalType, DoubleType}
import org.apache.spark.util.Utils
Expand Down Expand Up @@ -66,6 +66,8 @@ private[sql] class HiveSessionCatalog(
* Construct a [[FunctionBuilder]] based on the provided class that represents a function.
*/
private def makeFunctionBuilder(name: String, clazz: Class[_]): FunctionBuilder = {
validateHiveUserDefinedFunction(clazz)
Copy link
Member

@gatorsmile gatorsmile Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am neural to introduce a warning message for this case. Not sure how helpful the warning message will be.

Copy link
Member Author

@maropu maropu Jul 31, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. So, I think it's ok to revisit this again if we have more reports from users.


// When we instantiate hive UDF wrapper class, we may throw exception if the input
// expressions don't satisfy the hive UDF, such as type mismatch, input number
// mismatch, etc. Here we catch the exception and throw AnalysisException instead.
Expand Down
35 changes: 31 additions & 4 deletions sql/hive/src/main/scala/org/apache/spark/sql/hive/HiveShim.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ import java.rmi.server.UID

import scala.collection.JavaConverters._
import scala.language.implicitConversions
import scala.reflect.ClassTag
import scala.reflect.{classTag, ClassTag}
import scala.util.control.NonFatal

import com.google.common.base.Objects
import org.apache.avro.Schema
import org.apache.hadoop.conf.Configuration
import org.apache.hadoop.fs.Path
import org.apache.hadoop.hive.ql.exec.{UDF, Utilities}
import org.apache.hadoop.hive.ql.exec.{MapredContext, UDF, Utilities}
import org.apache.hadoop.hive.ql.plan.{FileSinkDesc, TableDesc}
import org.apache.hadoop.hive.ql.udf.generic.GenericUDFMacro
import org.apache.hadoop.hive.ql.udf.generic.{GenericUDF, GenericUDFMacro, GenericUDTF}
import org.apache.hadoop.hive.serde2.ColumnProjectionUtils
import org.apache.hadoop.hive.serde2.avro.{AvroGenericRecordWritable, AvroSerdeUtils}
import org.apache.hadoop.hive.serde2.objectinspector.primitive.HiveDecimalObjectInspector
Expand All @@ -42,7 +43,7 @@ import org.apache.spark.internal.Logging
import org.apache.spark.sql.types.Decimal
import org.apache.spark.util.Utils

private[hive] object HiveShim {
private[hive] object HiveShim extends Logging {
// Precision and scale to pass for unlimited decimals; these are the same as the precision and
// scale Hive 0.13 infers for BigDecimals from sources that don't specify them (e.g. UDFs)
val UNLIMITED_DECIMAL_PRECISION = 38
Expand Down Expand Up @@ -111,6 +112,32 @@ private[hive] object HiveShim {
}
}

private def hasInheritanceOf[UDFType: ClassTag](func: String, clazz: Class[_]): Boolean = {
val parentClazz = classTag[UDFType].runtimeClass
if (parentClazz.isAssignableFrom(clazz)) {
try {
val funcClass = clazz.getMethod(func, classOf[MapredContext])
// If a given `func` not overridden, `Method.getDeclaringClass` returns
// a parent Class object.
funcClass.getDeclaringClass != parentClazz
} catch {
case NonFatal(_) => false
}
} else {
false
}
}

def validateHiveUserDefinedFunction(udfClass: Class[_]): Unit = {
if (hasInheritanceOf[GenericUDF]("configure", udfClass) ||
Copy link
Member

@viirya viirya Jul 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When GenericUDF API has configure method? Seems GenericUDF at 0.10.0 has no such method?

https://hive.apache.org/javadocs/r0.10.0/api/org/apache/hadoop/hive/ql/udf/generic/GenericUDF.html

Copy link
Member Author

@maropu maropu Jul 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked it seemed this API had been implemented in v0.11.0 (https://github.com/apache/hive/blob/release-0.11.0/ql/src/java/org/apache/hadoop/hive/ql/udf/generic/GenericUDF.java). This is the commit for this API.

Copy link
Member

@viirya viirya Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If ran with a Hive version that configure is not implemented yet, is hasInheritanceOf safe from NoSuchMethodException ?

Copy link
Member Author

@maropu maropu Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC spark always refers to hive-exec-1.2.1.spark2.jar , so it seems we have no chance to get the exception. But, I think it is not a bad idea to catch NoSuchMethodException there for understandability.

Copy link
Member

@viirya viirya Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, that's right. As you said, it is still good to catch the exception.

hasInheritanceOf[GenericUDTF]("configure", udfClass)) {
logWarning(s"Found an overridden method `configure` in ${udfClass.getSimpleName}, but " +
"Spark does not call the method during initialization because Spark does not use " +
"MapredContext inside (See SPARK-21533). So, you might reconsider the implementation of " +
s"${udfClass.getSimpleName}.")
}
}

/**
* This class provides the UDF creation and also the UDF instance serialization and
* de-serialization cross process boundary.
Expand Down