feat: fs-server支持客户端会话管理 #1275

src/backend/common/common-mongo-reactive/src/main/kotlin/com/tencent/bkrepo/common/mongo/reactive/dao/AbstractMongoReactiveDao.kt

@@ -115,6 +115,15 @@ abstract class AbstractMongoReactiveDao<E> : MongoReactiveDao<E> {
         }
     }
 
+    override suspend fun count(query: Query): Long {
+        if (logger.isDebugEnabled) {
+            logger.debug("Mongo Dao count: [$query]")
+        }
+        val mongoOperations = determineReactiveMongoOperations()
+        val collectName = determineCollectionName(query)
+        return mongoOperations.count(query, collectName).awaitSingle()
+    }
+
     protected open fun determineCollectionName(): String {
         var collectionName: String? = null
         if (classType.isAnnotationPresent(Document::class.java)) {

src/backend/common/common-mongo-reactive/src/main/kotlin/com/tencent/bkrepo/common/mongo/reactive/dao/MongoReactiveDao.kt

@@ -66,4 +66,9 @@ interface MongoReactiveDao<E> {
      * update or insert
      */
     suspend fun upsert(query: Query, update: Update): UpdateResult
+
+    /**
+     * count
+     */
+    suspend fun count(query: Query): Long
 }

src/backend/common/common-mongo-reactive/src/main/kotlin/com/tencent/bkrepo/common/mongo/reactive/dao/SimpleMongoReactiveDao.kt

@@ -31,7 +31,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.data.mongodb.core.ReactiveMongoOperations
 import org.springframework.data.mongodb.core.query.Query
 
-class SimpleMongoReactiveDao<E> : AbstractMongoReactiveDao<E>() {
+open class SimpleMongoReactiveDao<E> : AbstractMongoReactiveDao<E>() {
 
     // 抽象类使用构造器注入不方便
     @Suppress("LateinitUsage")

src/backend/common/common-mongo-reactive/src/main/kotlin/com/tencent/bkrepo/common/mongo/util/Pages.kt

@@ -0,0 +1,96 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
+ *
+ * A copy of the MIT License is included in this file.
+ *
+ *
+ * Terms of the MIT License:
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+ * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+ * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.tencent.bkrepo.common.mongo.util
+
+import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_NUMBER
+import com.tencent.bkrepo.common.api.constant.DEFAULT_PAGE_SIZE
+import com.tencent.bkrepo.common.api.pojo.Page
+import org.springframework.data.domain.PageRequest
+
+/**
+ * 分页工具类
+ */
+object Pages {
+
+    /**
+     * 根据页码[page]和分页大小[size]构造[PageRequest]
+     *
+     * [page]从1开始，如果传入值小于1则置为1
+     * [size]如果小于0则置为默认分页大小20
+     *
+     * [PageRequest]要求页码从0开始
+     */
+    fun ofRequest(page: Int, size: Int): PageRequest {
+        val pageNumber = if (page <= 0) DEFAULT_PAGE_NUMBER else page
+        val pageSize = if (page < 0) DEFAULT_PAGE_SIZE else size
+        return PageRequest.of(pageNumber - 1, pageSize)
+    }
+
+    /**
+     * 将查询到的所有数据通过内存分页构造结果
+     *
+     * @param total 所有数据
+     * @param page 页码，从1开始，如果传入值小于1则置为1
+     * @param size 分页大小，如果小于0则置为默认分页大小20
+     */
+    inline fun <reified T> buildPage(total: List<T>, page: Int, size: Int): Page<T> {
+        val pageNumber = if (page <= 0) DEFAULT_PAGE_NUMBER else page
+        val pageSize = if (page < 0) DEFAULT_PAGE_SIZE else size
+        val totalRecords = total.size
+        val offset = (pageNumber - 1) * pageSize
+        val records = if (offset > totalRecords) {
+            emptyList()
+        } else if (offset + pageSize > totalRecords) {
+            total.subList(offset, totalRecords)
+        } else {
+            total.subList(offset, offset + pageSize)
+        }
+        return Page(
+            pageNumber = pageNumber,
+            pageSize = pageSize,
+            totalRecords = totalRecords.toLong(),
+            records = records
+        )
+    }
+
+    /**
+     * 创建分页响应结果
+     *
+     * @param pageRequest 分页请求
+     * @param totalRecords 数据总数
+     * @param records 数据列表
+     */
+    inline fun <reified T> ofResponse(pageRequest: PageRequest, totalRecords: Long, records: List<T>): Page<T> {
+        return Page(
+            pageNumber = pageRequest.pageNumber + 1,
+            pageSize = pageRequest.pageSize,
+            totalRecords = totalRecords,
+            records = records
+        )
+    }
+}

src/backend/fs/api-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/api/FsClientClient.kt

@@ -0,0 +1,51 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
+ *
+ *  A copy of the MIT License is included in this file.
+ *
+ *
+ *  Terms of the MIT License:
+ *  ---------------------------------------------------
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ *  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ *  permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ *  the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+ *  LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+ *  NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.tencent.bkrepo.fs.server.api
+
+import com.tencent.bkrepo.common.api.constant.FS_SERVER_SERVICE_NAME
+import com.tencent.bkrepo.common.api.pojo.Page
+import com.tencent.bkrepo.common.api.pojo.Response
+import com.tencent.bkrepo.fs.server.pojo.ClientDetail
+import org.springframework.cloud.openfeign.FeignClient
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestParam
+
+@FeignClient(FS_SERVER_SERVICE_NAME, contextId = "ClientClient", primary = false)
+@RequestMapping("/service/client")
+interface FsClientClient {
+
+    @GetMapping("/list/{projectId}/{repoName}")
+    fun listClients(
+        @PathVariable projectId: String,
+        @PathVariable repoName: String,
+        @RequestParam pageNumber: Int,
+        @RequestParam pageSize: Int
+    ): Response<Page<ClientDetail>>
+}

src/backend/fs/api-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/pojo/ClientDetail.kt

@@ -0,0 +1,51 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2020 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
+ *
+ * A copy of the MIT License is included in this file.
+ *
+ *
+ * Terms of the MIT License:
+ * ---------------------------------------------------
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.tencent.bkrepo.fs.server.pojo
+
+import java.time.LocalDateTime
+
+/**
+ * 客户端详情
+ */
+data class ClientDetail(
+    val id: String,
+    val projectId: String,
+    val repoName: String,
+    val mountPoint: String,
+    val userId: String,
+    val ip: String,
+    val version: String,
+    val os: String,
+    val arch: String,
+    val online: Boolean,
+    val heartbeatTime: LocalDateTime
+)

src/backend/fs/api-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/pojo/ClientListRequest.kt

@@ -0,0 +1,38 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
+ *
+ * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
+ *
+ *  A copy of the MIT License is included in this file.
+ *
+ *
+ *  Terms of the MIT License:
+ *  ---------------------------------------------------
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ *  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ *  permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ *  the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+ *  LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+ *  NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package com.tencent.bkrepo.fs.server.pojo
+
+/**
+ * 客户端列表请求
+ */
+data class ClientListRequest(
+    val projectId: String,
+    val repoName: String,
+    val pageNumber: Int,
+    val pageSize: Int
+)

src/backend/fs/boot-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/config/BeanConfiguration.kt

@@ -35,17 +35,19 @@ import com.tencent.bkrepo.fs.server.filter.ArtifactFileCleanupFilterFunction
 import com.tencent.bkrepo.fs.server.filter.AuthHandlerFilterFunction
 import com.tencent.bkrepo.fs.server.filter.PermissionFilterFunction
 import com.tencent.bkrepo.fs.server.filter.ReactiveRequestContextFilter
+import com.tencent.bkrepo.fs.server.handler.ClientHandler
 import com.tencent.bkrepo.fs.server.handler.FileOperationsHandler
 import com.tencent.bkrepo.fs.server.handler.LoginHandler
 import com.tencent.bkrepo.fs.server.handler.NodeOperationsHandler
 import com.tencent.bkrepo.fs.server.handler.service.FsNodeHandler
 import com.tencent.bkrepo.fs.server.metrics.ServerMetrics
 import com.tencent.bkrepo.fs.server.service.BlockNodeServiceImpl
+import com.tencent.bkrepo.fs.server.service.ClientService
 import com.tencent.bkrepo.fs.server.service.FileNodeService
 import com.tencent.bkrepo.fs.server.service.FileOperationService
 import com.tencent.bkrepo.fs.server.service.PermissionService
-import com.tencent.bkrepo.fs.server.storage.CoStorageManager
 import com.tencent.bkrepo.fs.server.storage.CoArtifactFileFactory
+import com.tencent.bkrepo.fs.server.storage.CoStorageManager
 import com.tencent.bkrepo.fs.server.utils.SecurityManager
 import com.tencent.bkrepo.fs.server.utils.SpringContextUtils
 import com.tencent.devops.service.config.ServiceProperties
@@ -62,6 +64,7 @@ val beans = beans {
     bean<FileOperationsHandler>()
     bean<FsNodeHandler>()
     bean<LoginHandler>()
+    bean<ClientHandler>()
     bean<PermissionService>()
     bean<AuthHandlerFilterFunction>()
     bean<RepositoryCache>()
@@ -75,14 +78,15 @@ val beans = beans {
     bean<ArtifactFileCleanupFilterFunction>()
     bean<FileNodeService>()
     bean<FileOperationService>()
+    bean<ClientService>()
     bean<SecurityManager>()
     bean<JwtAuthProperties>()
     bean<SpringContextUtils>()
     bean<NettyWebServerAccessLogCustomizer>()
     bean<PermissionFilterFunction>()
     bean<ErrorCodeDecoder>()
     bean {
-        RouteConfiguration(ref(), ref(), ref(), ref(), ref(), ref(), ref(), ref()).router()
+        RouteConfiguration(ref(), ref(), ref(), ref(), ref(), ref(), ref(), ref(), ref()).router()
     }
     bean {
         CoroutineScope(Dispatchers.IO + SupervisorJob())

src/backend/fs/boot-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/config/RouteConfiguration.kt

@@ -38,6 +38,7 @@ import com.tencent.bkrepo.fs.server.filter.ArtifactFileCleanupFilterFunction
 import com.tencent.bkrepo.fs.server.filter.AuthHandlerFilterFunction
 import com.tencent.bkrepo.fs.server.filter.PermissionFilterFunction
 import com.tencent.bkrepo.fs.server.getOrNull
+import com.tencent.bkrepo.fs.server.handler.ClientHandler
 import com.tencent.bkrepo.fs.server.handler.FileOperationsHandler
 import com.tencent.bkrepo.fs.server.handler.LoginHandler
 import com.tencent.bkrepo.fs.server.handler.NodeOperationsHandler
@@ -64,6 +65,7 @@ class RouteConfiguration(
     private val fileOperationsHandler: FileOperationsHandler,
     private val loginHandler: LoginHandler,
     private val fsNodeHandler: FsNodeHandler,
+    private val clientHandler: ClientHandler,
     private val authHandlerFilterFunction: AuthHandlerFilterFunction,
     private val serverMetrics: ServerMetrics,
     private val permissionFilterFunction: PermissionFilterFunction,
@@ -100,6 +102,16 @@ class RouteConfiguration(
             addMetrics(serverMetrics.uploadingCount)
         }
 
+        "/client".nest {
+            POST("/create/{projectId}/{repoName}", clientHandler::createClient)
+            DELETE("/delete/{projectId}/{repoName}/{clientId}", clientHandler::removeClient)
+            POST("/heartbeat/{projectId}/{repoName}/{clientId}", clientHandler::heartbeat)
+        }
+
+        "/service/client".nest {
+            GET("/list/{projectId}/{repoName}", clientHandler::listClients)
+        }
+
         accept(APPLICATION_OCTET_STREAM).nest {
             GET(DEFAULT_MAPPING_URI, fileOperationsHandler::read)
             addMetrics(serverMetrics.downloadingCount)

src/backend/fs/boot-fs-server/src/main/kotlin/com/tencent/bkrepo/fs/server/context/ReactiveRequestContextHolder.kt

@@ -27,6 +27,7 @@
 
 package com.tencent.bkrepo.fs.server.context
 
+import com.tencent.bkrepo.common.api.constant.StringPool
 import kotlinx.coroutines.reactor.awaitSingle
 import org.springframework.http.server.reactive.ServerHttpRequest
 import org.springframework.http.server.reactive.ServerHttpResponse
@@ -55,6 +56,11 @@ object ReactiveRequestContextHolder {
         }.awaitSingle().exchange
     }
 
+    suspend fun getClientAddress(): String {
+        val request = getRequest()
+        return request.remoteAddress?.address?.hostAddress ?: StringPool.UNKNOWN
+    }
+
     fun getWebExchangeMono(): Mono<ServerWebExchange> {
         return Mono.deferContextual {
             Mono.just(it.get(REQUEST_CONTEXT_KEY).exchange)