You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2020/12/09 05:53:02 UTC
[GitHub] [kafka] chia7712 commented on a change in pull request #9715: Upstream ApisUtils from kip-500
chia7712 commented on a change in pull request #9715:
URL: https://github.com/apache/kafka/pull/9715#discussion_r539008999
##########
File path: core/src/main/scala/kafka/server/ApisUtils.scala
##########
@@ -0,0 +1,184 @@
+/**
+ * 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 kafka.server
+
+import java.lang.{Byte => JByte}
+import java.util.Collections
+
+import kafka.network.RequestChannel
+import kafka.security.authorizer.AclEntry
+import kafka.server.QuotaFactory.QuotaManagers
+import kafka.utils.Logging
+import org.apache.kafka.common.acl.AclOperation
+import org.apache.kafka.common.errors.ClusterAuthorizationException
+import org.apache.kafka.common.network.Send
+import org.apache.kafka.common.requests.{AbstractRequest, AbstractResponse, RequestContext}
+import org.apache.kafka.common.resource.Resource.CLUSTER_NAME
+import org.apache.kafka.common.resource.ResourceType.CLUSTER
+import org.apache.kafka.common.resource.{PatternType, Resource, ResourcePattern, ResourceType}
+import org.apache.kafka.common.utils.{Time, Utils}
+import org.apache.kafka.server.authorizer.{Action, AuthorizationResult, Authorizer}
+
+import scala.jdk.CollectionConverters._
+
+/**
+ * Helper class for request handlers. Provides common functionality around throttling, authorizations, and error handling
+ */
+class ApisUtils(val requestChannel: RequestChannel,
+ val authorizer: Option[Authorizer],
+ val quotas: QuotaManagers,
+ val time: Time) extends Logging {
+
+ // private package for testing
+ def authorize(requestContext: RequestContext,
+ operation: AclOperation,
+ resourceType: ResourceType,
+ resourceName: String,
+ logIfAllowed: Boolean = true,
+ logIfDenied: Boolean = true,
+ refCount: Int = 1): Boolean = {
+ authorizer.forall { authZ =>
+ val resource = new ResourcePattern(resourceType, resourceName, PatternType.LITERAL)
+ val actions = Collections.singletonList(new Action(operation, resource, refCount, logIfAllowed, logIfDenied))
+ authZ.authorize(requestContext, actions).get(0) == AuthorizationResult.ALLOWED
+ }
+ }
+
+ def authorizeClusterOperation(request: RequestChannel.Request, operation: AclOperation): Unit = {
+ if (!authorize(request.context, operation, CLUSTER, CLUSTER_NAME))
+ throw new ClusterAuthorizationException(s"Request $request is not authorized.")
+ }
+
+ def authorizedOperations(request: RequestChannel.Request, resource: Resource): Int = {
+ val supportedOps = AclEntry.supportedOperations(resource.resourceType).toList
+ val authorizedOps = authorizer match {
+ case Some(authZ) =>
+ val resourcePattern = new ResourcePattern(resource.resourceType, resource.name, PatternType.LITERAL)
+ val actions = supportedOps.map { op => new Action(op, resourcePattern, 1, false, false) }
+ authZ.authorize(request.context, actions.asJava).asScala
+ .zip(supportedOps)
+ .filter(_._1 == AuthorizationResult.ALLOWED)
+ .map(_._2).toSet
+ case None =>
+ supportedOps.toSet
+ }
+ Utils.to32BitField(authorizedOps.map(operation => operation.code.asInstanceOf[JByte]).asJava)
+ }
+
+ def handleError(request: RequestChannel.Request, e: Throwable): Unit = {
+ val mayThrottle = e.isInstanceOf[ClusterAuthorizationException] || !request.header.apiKey.clusterAction
+ error("Error when handling request: " +
+ s"clientId=${request.header.clientId}, " +
+ s"correlationId=${request.header.correlationId}, " +
+ s"api=${request.header.apiKey}, " +
+ s"version=${request.header.apiVersion}, " +
+ s"body=${request.body[AbstractRequest]}", e)
+ if (mayThrottle)
+ sendErrorResponseMaybeThrottle(request, e)
+ else
+ sendErrorResponseExemptThrottle(request, e)
+ }
+
+ def sendForwardedResponse(
+ request: RequestChannel.Request,
+ response: AbstractResponse
+ ): Unit = {
+ // For forwarded requests, we take the throttle time from the broker that
+ // the request was forwarded to
+ val throttleTimeMs = response.throttleTimeMs()
+ quotas.request.throttle(request, throttleTimeMs, requestChannel.sendResponse)
+ requestChannel.sendResponse(request, Some(response), None)
+ }
+
+ // Throttle the channel if the request quota is enabled but has been violated. Regardless of throttling, send the
+ // response immediately.
+ def sendResponseMaybeThrottle(request: RequestChannel.Request,
+ createResponse: Int => AbstractResponse,
+ onComplete: Option[Send => Unit] = None): Unit = {
Review comment:
```onComplete``` is unused.
##########
File path: core/src/main/scala/kafka/server/ApisUtils.scala
##########
@@ -0,0 +1,184 @@
+/**
+ * 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 kafka.server
+
+import java.lang.{Byte => JByte}
+import java.util.Collections
+
+import kafka.network.RequestChannel
+import kafka.security.authorizer.AclEntry
+import kafka.server.QuotaFactory.QuotaManagers
+import kafka.utils.Logging
+import org.apache.kafka.common.acl.AclOperation
+import org.apache.kafka.common.errors.ClusterAuthorizationException
+import org.apache.kafka.common.network.Send
+import org.apache.kafka.common.requests.{AbstractRequest, AbstractResponse, RequestContext}
+import org.apache.kafka.common.resource.Resource.CLUSTER_NAME
+import org.apache.kafka.common.resource.ResourceType.CLUSTER
+import org.apache.kafka.common.resource.{PatternType, Resource, ResourcePattern, ResourceType}
+import org.apache.kafka.common.utils.{Time, Utils}
+import org.apache.kafka.server.authorizer.{Action, AuthorizationResult, Authorizer}
+
+import scala.jdk.CollectionConverters._
+
+/**
+ * Helper class for request handlers. Provides common functionality around throttling, authorizations, and error handling
+ */
+class ApisUtils(val requestChannel: RequestChannel,
+ val authorizer: Option[Authorizer],
+ val quotas: QuotaManagers,
+ val time: Time) extends Logging {
+
+ // private package for testing
+ def authorize(requestContext: RequestContext,
+ operation: AclOperation,
+ resourceType: ResourceType,
+ resourceName: String,
+ logIfAllowed: Boolean = true,
+ logIfDenied: Boolean = true,
+ refCount: Int = 1): Boolean = {
+ authorizer.forall { authZ =>
+ val resource = new ResourcePattern(resourceType, resourceName, PatternType.LITERAL)
+ val actions = Collections.singletonList(new Action(operation, resource, refCount, logIfAllowed, logIfDenied))
+ authZ.authorize(requestContext, actions).get(0) == AuthorizationResult.ALLOWED
+ }
+ }
+
+ def authorizeClusterOperation(request: RequestChannel.Request, operation: AclOperation): Unit = {
+ if (!authorize(request.context, operation, CLUSTER, CLUSTER_NAME))
+ throw new ClusterAuthorizationException(s"Request $request is not authorized.")
+ }
+
+ def authorizedOperations(request: RequestChannel.Request, resource: Resource): Int = {
+ val supportedOps = AclEntry.supportedOperations(resource.resourceType).toList
+ val authorizedOps = authorizer match {
+ case Some(authZ) =>
+ val resourcePattern = new ResourcePattern(resource.resourceType, resource.name, PatternType.LITERAL)
+ val actions = supportedOps.map { op => new Action(op, resourcePattern, 1, false, false) }
+ authZ.authorize(request.context, actions.asJava).asScala
+ .zip(supportedOps)
+ .filter(_._1 == AuthorizationResult.ALLOWED)
+ .map(_._2).toSet
+ case None =>
+ supportedOps.toSet
+ }
+ Utils.to32BitField(authorizedOps.map(operation => operation.code.asInstanceOf[JByte]).asJava)
+ }
+
+ def handleError(request: RequestChannel.Request, e: Throwable): Unit = {
+ val mayThrottle = e.isInstanceOf[ClusterAuthorizationException] || !request.header.apiKey.clusterAction
+ error("Error when handling request: " +
+ s"clientId=${request.header.clientId}, " +
+ s"correlationId=${request.header.correlationId}, " +
+ s"api=${request.header.apiKey}, " +
+ s"version=${request.header.apiVersion}, " +
+ s"body=${request.body[AbstractRequest]}", e)
+ if (mayThrottle)
+ sendErrorResponseMaybeThrottle(request, e)
+ else
+ sendErrorResponseExemptThrottle(request, e)
+ }
+
+ def sendForwardedResponse(
+ request: RequestChannel.Request,
+ response: AbstractResponse
+ ): Unit = {
+ // For forwarded requests, we take the throttle time from the broker that
+ // the request was forwarded to
+ val throttleTimeMs = response.throttleTimeMs()
+ quotas.request.throttle(request, throttleTimeMs, requestChannel.sendResponse)
+ requestChannel.sendResponse(request, Some(response), None)
+ }
+
+ // Throttle the channel if the request quota is enabled but has been violated. Regardless of throttling, send the
+ // response immediately.
+ def sendResponseMaybeThrottle(request: RequestChannel.Request,
+ createResponse: Int => AbstractResponse,
+ onComplete: Option[Send => Unit] = None): Unit = {
+ val throttleTimeMs = maybeRecordAndGetThrottleTimeMs(request)
+ // Only throttle non-forwarded requests
+ if (!request.isForwarded)
+ quotas.request.throttle(request, throttleTimeMs, requestChannel.sendResponse)
+ requestChannel.sendResponse(request, Some(createResponse(throttleTimeMs)), None)
+ }
+
+ def sendErrorResponseMaybeThrottle(request: RequestChannel.Request, error: Throwable): Unit = {
+ val throttleTimeMs = maybeRecordAndGetThrottleTimeMs(request)
+ // Only throttle non-forwarded requests or cluster authorization failures
+ if (error.isInstanceOf[ClusterAuthorizationException] || !request.isForwarded)
+ quotas.request.throttle(request, throttleTimeMs, requestChannel.sendResponse)
+ sendErrorOrCloseConnection(request, error, throttleTimeMs)
+ }
+
+ private def maybeRecordAndGetThrottleTimeMs(request: RequestChannel.Request): Int = {
+ val throttleTimeMs = quotas.request.maybeRecordAndGetThrottleTimeMs(request, time.milliseconds())
+ request.apiThrottleTimeMs = throttleTimeMs
+ throttleTimeMs
+ }
+
+ /**
+ * Throttle the channel if the controller mutations quota or the request quota have been violated.
+ * Regardless of throttling, send the response immediately.
+ */
+ def sendResponseMaybeThrottleWithControllerQuota(controllerMutationQuota: ControllerMutationQuota,
+ request: RequestChannel.Request,
+ createResponse: Int => AbstractResponse,
+ onComplete: Option[Send => Unit]): Unit = {
Review comment:
ditto
##########
File path: core/src/main/scala/kafka/network/RequestChannel.scala
##########
@@ -432,6 +432,43 @@ class RequestChannel(val queueSize: Int,
}
}
+ def sendResponse(request: RequestChannel.Request,
+ responseOpt: Option[AbstractResponse],
+ onComplete: Option[Send => Unit]): Unit = {
+ // Update error metrics for each error code in the response including Errors.NONE
+ responseOpt.foreach(response => updateErrorMetrics(request.header.apiKey, response.errorCounts.asScala))
+
+ val response = responseOpt match {
+ case Some(response) =>
+ new RequestChannel.SendResponse(
+ request,
+ request.buildResponseSend(response),
+ request.responseString(response),
+ onComplete
+ )
+ case None =>
+ new RequestChannel.NoOpResponse(request)
+ }
+
+ sendResponse(response)
+ }
+
+ def sendErrorOrCloseConnection(request: RequestChannel.Request, error: Throwable, throttleMs: Int): Unit = {
Review comment:
There is a another "sendErrorOrCloseConnection" in ```ApisUtils```
##########
File path: core/src/main/scala/kafka/server/KafkaApis.scala
##########
@@ -98,6 +97,7 @@ import scala.annotation.nowarn
* Logic to handle the various Kafka requests
*/
class KafkaApis(val requestChannel: RequestChannel,
+ val apisUtils: ApisUtils,
Review comment:
Instantiating a "utils" object is a bit weird to me. it seems to me we can make ApisUtils be a ```trait``` with self-type (this: KafkaApis) if the main purpose of this PR is to reduce the size of ```KafkaApis```. The benefit of using self-type is that
1. we don't need to instantiate a "utils"
1. we can move some code from KafkaApis to ApisUtils
1. we don't need to change "autxxx" to "apisUtils.autxxx"
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org