This is an automated email from the ASF dual-hosted git repository. peacewong pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/linkis.git
commit 8cf5f66e9ce70dbf39f5491e860ba4b3cb8c69da Author: peacewong <[email protected]> AuthorDate: Tue Oct 10 17:37:57 2023 +0800 Gateway server log optimize, add token log and add error log to response --- .../LinkisGwAuthenticationErrorCodeSummary.java | 17 ++++-- .../main/resources/mapper/common/TokenMapper.xml | 6 +- .../service/CachedTokenService.scala | 62 ++++++++++++------- .../security/token/TokenAuthentication.scala | 5 +- .../gateway/dss/parser/DSSGatewayParser.scala | 14 +++-- .../springcloud/handler/CustomErrorAttributes.java | 69 ++++++++++++++++++++++ .../http/GatewayAuthorizationFilter.java | 2 +- .../websocket/WebsocketGatewaySession.scala | 6 +- 8 files changed, 142 insertions(+), 39 deletions(-) diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/java/org/apache/linkis/gateway/authentication/errorcode/LinkisGwAuthenticationErrorCodeSummary.java b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/java/org/apache/linkis/gateway/authentication/errorcode/LinkisGwAuthenticationErrorCodeSummary.java index 5abff1538..5679fe064 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/java/org/apache/linkis/gateway/authentication/errorcode/LinkisGwAuthenticationErrorCodeSummary.java +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/java/org/apache/linkis/gateway/authentication/errorcode/LinkisGwAuthenticationErrorCodeSummary.java @@ -20,12 +20,17 @@ package org.apache.linkis.gateway.authentication.errorcode; import org.apache.linkis.common.errorcode.LinkisErrorCode; public enum LinkisGwAuthenticationErrorCodeSummary implements LinkisErrorCode { - TOKEN_IS_NULL(15205, "token is null(token 令牌为空)!"), - FAILED_TO_LOAD_TOKEN(15200, "Failed to load token from DB into cache(无法将 token 令牌从数据库加载到缓存中)!"), - TOKEN_VALID_OR_STALE(15201, "Token is not valid or stale(token 令牌无效或已过期)!"), - ILLEGAL_TOKENUSER(15202, "Illegal TokenUser for Token(Token非法用户)!"), - ILLEGAL_HOST(15203, "Illegal Host for Token(Token非法主机)!"), - INVALID_TOKEN(15204, "Invalid Token(令牌无效)"); + FAILED_TO_LOAD_TOKEN( + 15200, + "Failed to load token:{0} from DB into cache(无法将 Token:{0} 令牌从数据库加载到缓存中),Caused by:{1}"), + TOKEN_IS_EXPIRED(15201, "Token is not valid or stale({0} 令牌已过期)!"), + ILLEGAL_TOKENUSER(15202, "Illegal TokenUser for Token(Token非法用户: {0})!"), + ILLEGAL_HOST(15203, "Illegal Host for Token(非法ip: {0})!"), + INVALID_TOKEN(15204, "Invalid Token(数据库中未配置的无效令牌)"), + TOKEN_IS_NULL(15205, "token is null({0} 令牌参数为空)!"), + FAILED_TO_BAD_SQLGRAMMAR( + 15206, "Failed to query token:{0} data(Token:{0} 数据查询失败), Caused by:{1}"), + NOT_EXIST_DB(15207, "Token:{0} does not exist in the table(Token:{0} 表中不存在)!, Caused by:{1}"); /** (errorCode)错误码 */ private final int errorCode; diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/resources/mapper/common/TokenMapper.xml b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/resources/mapper/common/TokenMapper.xml index 8ae1a8ba9..155c548d6 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/resources/mapper/common/TokenMapper.xml +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/resources/mapper/common/TokenMapper.xml @@ -36,8 +36,8 @@ <sql id="tableName">linkis_mg_gateway_auth_token</sql> - <select id="selectTokenByName" parameterType="java.lang.String" resultMap="tokenEntityMap"> - SELECT * FROM + <select id="selectTokenByName" parameterType="String" resultMap="tokenEntityMap"> + select * from <include refid="tableName"/> <where> token_name = #{tokenName} @@ -45,7 +45,7 @@ </select> <select id="getAllTokens" resultMap="tokenEntityMap"> - SELECT * FROM + select * from <include refid="tableName"/> </select> diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/scala/org/apache/linkis/gateway/authentication/service/CachedTokenService.scala b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/scala/org/apache/linkis/gateway/authentication/service/CachedTokenService.scala index e839d0b5b..91f10cc7b 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/scala/org/apache/linkis/gateway/authentication/service/CachedTokenService.scala +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-authentication/src/main/scala/org/apache/linkis/gateway/authentication/service/CachedTokenService.scala @@ -23,19 +23,21 @@ import org.apache.linkis.gateway.authentication.bo.impl.TokenImpl import org.apache.linkis.gateway.authentication.conf.TokenConfiguration import org.apache.linkis.gateway.authentication.dao.TokenDao import org.apache.linkis.gateway.authentication.entity.TokenEntity +import org.apache.linkis.gateway.authentication.errorcode.LinkisGwAuthenticationErrorCodeSummary import org.apache.linkis.gateway.authentication.errorcode.LinkisGwAuthenticationErrorCodeSummary._ import org.apache.linkis.gateway.authentication.exception.{ TokenAuthException, TokenNotExistException } -import org.apache.linkis.gateway.authentication.exception.TokenNotExistException import org.springframework.beans.factory.annotation.Autowired import org.springframework.stereotype.Service +import java.text.MessageFormat import java.util.concurrent.{ExecutionException, TimeUnit} import com.google.common.cache.{CacheBuilder, CacheLoader, LoadingCache} +import com.google.common.util.concurrent.UncheckedExecutionException @Service class CachedTokenService extends TokenService { @@ -59,9 +61,9 @@ class CachedTokenService extends TokenService { }); -// def setTokenDao(tokenDao: TokenDao): Unit = { -// this.tokenDao = tokenDao -// } + // def setTokenDao(tokenDao: TokenDao): Unit = { + // this.tokenDao = tokenDao + // } /* TODO begin @@ -104,28 +106,41 @@ class CachedTokenService extends TokenService { private def loadTokenFromCache(tokenName: String): Token = { if (tokenName == null) { - throw new TokenAuthException(TOKEN_IS_NULL.getErrorCode, TOKEN_IS_NULL.getErrorDesc) + throw new TokenAuthException( + TOKEN_IS_NULL.getErrorCode, + MessageFormat.format(TOKEN_IS_NULL.getErrorDesc, tokenName) + ) } Utils.tryCatch(tokenCache.get(tokenName))(t => t match { case x: ExecutionException => x.getCause match { - case _: TokenNotExistException => null - case _ => - throw new TokenAuthException( - FAILED_TO_LOAD_TOKEN.getErrorCode, - FAILED_TO_LOAD_TOKEN.getErrorDesc - ) + case e: TokenNotExistException => + throwTokenAuthException(NOT_EXIST_DB, tokenName, e) + case e => + throwTokenAuthException(FAILED_TO_LOAD_TOKEN, tokenName, e) } - case _ => - throw new TokenAuthException( - FAILED_TO_LOAD_TOKEN.getErrorCode, - FAILED_TO_LOAD_TOKEN.getErrorDesc - ) + case e: UncheckedExecutionException => + throwTokenAuthException(FAILED_TO_BAD_SQLGRAMMAR, tokenName, e) + case e => + throwTokenAuthException(FAILED_TO_LOAD_TOKEN, tokenName, e) } ) } + private def throwTokenAuthException( + gwAuthenticationErrorCodeSummary: LinkisGwAuthenticationErrorCodeSummary, + tokenName: String, + e: Throwable + ) = { + val exception = new TokenAuthException( + gwAuthenticationErrorCodeSummary.getErrorCode, + MessageFormat.format(gwAuthenticationErrorCodeSummary.getErrorDesc, tokenName, e.getMessage) + ) + exception.initCause(e) + throw exception + } + private def isTokenAcceptableWithUser(token: Token, userName: String): Boolean = { token != null && !token.isStale() && token.isUserLegal(userName) } @@ -153,20 +168,27 @@ class CachedTokenService extends TokenService { override def doAuth(tokenName: String, userName: String, host: String): Boolean = { val tmpToken: Token = loadTokenFromCache(tokenName) var ok: Boolean = true + // token expired if (!isTokenValid(tmpToken)) { ok = false throw new TokenAuthException( - TOKEN_VALID_OR_STALE.getErrorCode, - TOKEN_VALID_OR_STALE.getErrorDesc + TOKEN_IS_EXPIRED.getErrorCode, + MessageFormat.format(TOKEN_IS_EXPIRED.getErrorDesc, tokenName) ) } if (!isTokenAcceptableWithUser(tmpToken, userName)) { ok = false - throw new TokenAuthException(ILLEGAL_TOKENUSER.getErrorCode, ILLEGAL_TOKENUSER.getErrorDesc) + throw new TokenAuthException( + ILLEGAL_TOKENUSER.getErrorCode, + MessageFormat.format(ILLEGAL_TOKENUSER.getErrorDesc, userName) + ) } if (!isTokenAcceptableWithHost(tmpToken, host)) { ok = false - throw new TokenAuthException(ILLEGAL_HOST.getErrorCode, ILLEGAL_HOST.getErrorDesc) + throw new TokenAuthException( + ILLEGAL_HOST.getErrorCode, + MessageFormat.format(ILLEGAL_HOST.getErrorDesc, host) + ) } ok } diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-core/src/main/scala/org/apache/linkis/gateway/security/token/TokenAuthentication.scala b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-core/src/main/scala/org/apache/linkis/gateway/security/token/TokenAuthentication.scala index 9a460eb52..c5c801029 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-core/src/main/scala/org/apache/linkis/gateway/security/token/TokenAuthentication.scala +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-core/src/main/scala/org/apache/linkis/gateway/security/token/TokenAuthentication.scala @@ -93,7 +93,7 @@ object TokenAuthentication extends Logging { }) if (ok) { logger.info( - s"Token authentication succeed, uri: ${gatewayContext.getRequest.getRequestURI}, token: $token, tokenUser: $tokenUser." + s"Token authentication succeed, uri: ${gatewayContext.getRequest.getRequestURI}, token: $token, tokenUser: $tokenUser, host: $host." ) if (login) { logger.info( @@ -115,6 +115,9 @@ object TokenAuthentication extends Logging { } true } else { + logger.info( + s"Token authentication fail, uri: ${gatewayContext.getRequest.getRequestURI}, token: $token, tokenUser: $tokenUser, host: $host." + ) SecurityFilter.filterResponse(gatewayContext, authMsg) false } diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/src/main/scala/org/apache/linkis/gateway/dss/parser/DSSGatewayParser.scala b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/src/main/scala/org/apache/linkis/gateway/dss/parser/DSSGatewayParser.scala index edd3ed949..e1b4bf430 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/src/main/scala/org/apache/linkis/gateway/dss/parser/DSSGatewayParser.scala +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/src/main/scala/org/apache/linkis/gateway/dss/parser/DSSGatewayParser.scala @@ -31,13 +31,15 @@ import org.apache.linkis.manager.label.entity.route.RouteLabel import org.apache.linkis.protocol.constants.TaskConstant import org.apache.linkis.protocol.utils.ZuulEntranceUtils import org.apache.linkis.rpc.sender.SpringCloudFeignConfigurationCache -import org.apache.linkis.server.{toScalaBuffer, BDPJettyServerHelper} +import org.apache.linkis.server.BDPJettyServerHelper import org.springframework.stereotype.Component import java.util import java.util.Locale +import scala.collection.JavaConverters._ + @Component class DSSGatewayParser extends AbstractGatewayParser { @@ -160,7 +162,7 @@ class DSSGatewayParser extends AbstractGatewayParser { logger.info( "Get ServiceName From Label and method is " + gatewayContext.getRequest.getMethod.toString + ",and urlLabels is " + requestUrlLabels ) - val requestMethod = gatewayContext.getRequest.getMethod.toLowerCase(Locale.ROOT) + val requestMethod = gatewayContext.getRequest.getMethod.toLowerCase(Locale.getDefault()) if ( requestUrlLabels == null && (requestMethod .equals("post") || requestMethod.equals("put") || requestMethod.equals("delete")) @@ -179,7 +181,7 @@ class DSSGatewayParser extends AbstractGatewayParser { case map: util.Map[String, Any] => labelBuilderFactory.getLabels(map.asInstanceOf) case _ => new util.ArrayList[Label[_]]() } - labels + labels.asScala .filter(label => label.isInstanceOf[RouteLabel]) .foreach(label => { routeLabelList.add(label.asInstanceOf[RouteLabel]) @@ -187,7 +189,7 @@ class DSSGatewayParser extends AbstractGatewayParser { case _ => null } - val labelNameList = routeLabelList.map(routeLabel => routeLabel.getStringValue).toList + val labelNameList = routeLabelList.asScala.map(routeLabel => routeLabel.getStringValue).toList if (labelNameList != null && labelNameList.size > 0) { genServiceNameByDSSLabel(labelNameList, tmpServiceName) } else if (null != requestUrlLabels) { @@ -239,7 +241,7 @@ class DSSGatewayParser extends AbstractGatewayParser { ): Option[String] = { val findIt: (String => Boolean) => Option[String] = op => { val services = - SpringCloudFeignConfigurationCache.getDiscoveryClient.getServices.filter(op).toList + SpringCloudFeignConfigurationCache.getDiscoveryClient.getServices.asScala.filter(op).toList if (services.length == 1) Some(services.head) else if (services.length > 1) tooManyDeal(services) else None @@ -250,7 +252,7 @@ class DSSGatewayParser extends AbstractGatewayParser { val findMostCorrect: (String => (String, Int)) => Option[String] = { op => { val serviceMap = - SpringCloudFeignConfigurationCache.getDiscoveryClient.getServices.map(op).toMap + SpringCloudFeignConfigurationCache.getDiscoveryClient.getServices.asScala.map(op).toMap var count = 0 var retService: Option[String] = None serviceMap.foreach { case (k, v) => diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/handler/CustomErrorAttributes.java b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/handler/CustomErrorAttributes.java new file mode 100644 index 000000000..ff27b76b4 --- /dev/null +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/handler/CustomErrorAttributes.java @@ -0,0 +1,69 @@ +/* + * 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.linkis.gateway.springcloud.handler; + +import org.springframework.boot.web.error.ErrorAttributeOptions; +import org.springframework.boot.web.reactive.error.DefaultErrorAttributes; +import org.springframework.core.annotation.MergedAnnotation; +import org.springframework.core.annotation.MergedAnnotations; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.reactive.function.server.ServerRequest; +import org.springframework.web.server.ResponseStatusException; + +import java.util.HashMap; +import java.util.Map; + +import com.google.common.collect.Lists; + +@Component +public class CustomErrorAttributes extends DefaultErrorAttributes { + + @Override + public Map<String, Object> getErrorAttributes( + ServerRequest request, ErrorAttributeOptions options) { + Throwable throwable = this.getError(request); + MergedAnnotation<ResponseStatus> responseStatusAnnotation = + MergedAnnotations.from( + throwable.getClass(), MergedAnnotations.SearchStrategy.TYPE_HIERARCHY) + .get(ResponseStatus.class); + HttpStatus errorStatus = determineHttpStatus(throwable, responseStatusAnnotation); + Map<String, Object> map = new HashMap<>(); + map.put("method", request.path()); + map.put("status", errorStatus.value()); + String msg = errorStatus.getReasonPhrase(); + if (errorStatus.value() >= HttpStatus.INTERNAL_SERVER_ERROR.value()) { + msg = msg + ", with request path:" + request.path(); + } + map.put("message", msg); + map.put("data", Lists.newArrayList()); + + return map; + } + + private HttpStatus determineHttpStatus( + Throwable error, MergedAnnotation<ResponseStatus> responseStatusAnnotation) { + if (error instanceof ResponseStatusException) { + return ((ResponseStatusException) error).getStatus(); + } + return responseStatusAnnotation + .getValue("code", HttpStatus.class) + .orElse(HttpStatus.INTERNAL_SERVER_ERROR); + } +} diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/http/GatewayAuthorizationFilter.java b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/http/GatewayAuthorizationFilter.java index 9bc1fa601..71e53fb2b 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/http/GatewayAuthorizationFilter.java +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/java/org/apache/linkis/gateway/springcloud/http/GatewayAuthorizationFilter.java @@ -166,7 +166,7 @@ public class GatewayAuthorizationFilter implements GlobalFilter, Ordered { if (serviceInstance != null) { logger.info( "Client request ip: " - + gatewayContext.getRequest().getRemoteAddress() + + gatewayContext.getRequest().getRequestRealIpAddr() + " and uri: " + gatewayContext.getRequest().getRequestURI() + "GatewayRouter route requestUri: " diff --git a/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/scala/org/apache/linkis/gateway/springcloud/websocket/WebsocketGatewaySession.scala b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/scala/org/apache/linkis/gateway/springcloud/websocket/WebsocketGatewaySession.scala index 29c42996f..c9c05776d 100644 --- a/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/scala/org/apache/linkis/gateway/springcloud/websocket/WebsocketGatewaySession.scala +++ b/linkis-spring-cloud-services/linkis-service-gateway/linkis-spring-cloud-gateway/src/main/scala/org/apache/linkis/gateway/springcloud/websocket/WebsocketGatewaySession.scala @@ -84,7 +84,8 @@ class GatewayWebSocketSessionConnection( } } - def getAddress: InetSocketAddress = webSocketSession.getHandshakeInfo.getRemoteAddress; + // todo + def getAddress: InetSocketAddress = null def getProxyWebSocketSession( serviceInstance: ServiceInstance @@ -191,7 +192,8 @@ class GatewayWebSocketSession private ( protected var webSocketConnection: WebSocketConnection = _ - def isAlive: Boolean = !webSocketConnection.getInbound.receiveCloseStatus().subscribe().isDisposed + // todo + def isAlive: Boolean = true override def receive(): Flux[WebSocketMessage] = webSocketConnection.getInbound .aggregateFrames(ServerConfiguration.BDP_SERVER_SOCKET_TEXT_MESSAGE_SIZE_MAX.getValue.toInt) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
