cloud-fan commented on code in PR #38320: URL: https://github.com/apache/spark/pull/38320#discussion_r1002901217
########## connector/connect/src/main/scala/org/apache/spark/sql/connect/service/SparkConnectInterceptorRegistry.scala: ########## @@ -0,0 +1,109 @@ +/* + * 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. + */ + +package org.apache.spark.sql.connect.service + +import java.lang.reflect.InvocationTargetException + +import io.grpc.ServerInterceptor +import io.grpc.netty.NettyServerBuilder + +import org.apache.spark.{SparkEnv, SparkIllegalArgumentException, SparkRuntimeException} +import org.apache.spark.sql.connect.config.Connect +import org.apache.spark.util.Utils + +/** + * This object provides a global list of configured interceptors for GRPC. The interceptors are + * added to the GRPC server in order of their position in the list. Once the statically compiled + * interceptors are added, dynamically configured interceptors are added. + */ +object SparkConnectInterceptorRegistry { + + // Contains the list of configured interceptors. + private lazy val interceptorChain: Seq[InterceptorBuilder] = Seq( + // Adding a new interceptor at compile time works like the eaxmple below with the dummy + // interceptor: + // interceptor[DummyInterceptor](classOf[DummyInterceptor]) + ) + + /** + * Given a NettyServerBuilder instance, will chain all interceptors to it in reverse order. + * @param sb + */ + def chainInterceptors(sb: NettyServerBuilder): Unit = { + interceptorChain.foreach(i => sb.intercept(i())) + createConfiguredInterceptors().foreach(sb.intercept(_)) + } + + // Type used to identify the closure responsible to instantiate a ServerInterceptor. + type InterceptorBuilder = () => ServerInterceptor + + /** + * For testing only. + * @return + */ + def createConfiguredInterceptors(): Seq[ServerInterceptor] = { + // Check all values from the Spark conf. + val classes = SparkEnv.get.conf.get(Connect.CONNECT_GRPC_INTERCEPTOR_CLASSES) + if (classes.nonEmpty) { + classes.get + .split(",") + .map(_.trim) + .filter(_.nonEmpty) + .map(Utils.classForName[ServerInterceptor](_)) + .map(createInstance(_)) + } else { + Seq.empty + } + } + + /** + * Creates a new instance of T using the default constructor. + * @param cls + * @tparam T + * @return + */ + private def createInstance[T <: ServerInterceptor](cls: Class[T]): ServerInterceptor = { + val ctorOpt = cls.getConstructors.find(_.getParameterCount == 0) + if (ctorOpt.isEmpty) { + throw new SparkIllegalArgumentException( + errorClass = "CONNECT.INTERCEPTOR_CTOR_MISSING", + messageParameters = Map("cls" -> cls.getName)) + } + try { + ctorOpt.get.newInstance().asInstanceOf[T] + } catch { + case e: InvocationTargetException => + throw new SparkRuntimeException( + errorClass = "CONNECT.INTERCEPTOR_RUNTIME_ERROR", + messageParameters = Map("msg" -> e.getTargetException.getMessage), + cause = e) + case e: Exception => + throw new SparkRuntimeException( + errorClass = "CONNECT.INTERCEPTOR_RUNTIME_ERROR", + messageParameters = Map("msg" -> "Unknown error"), Review Comment: can't we use `e.getMessage`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
