GitlabVcsAccessProvider.kt
/*
Copyright (C) 2026 Sber
Licensed 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
In any derivative products, you must retain the information of
owner of the original code and provide clear attribution to the project
https://dochub.info
The use of this product or its derivatives for any purpose cannot be a secret.
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.
Maintainers:
Марат Ниязматов <mrusniyazmatov@sberbank.ru>, Sber - 2026
Contributors:
Марат Ниязматов <mrusniyazmatov@sberbank.ru>, Sber - 2026
*/
package org.archtool.vcs.provider.gitlab
import io.ktor.client.HttpClient
import io.ktor.client.call.body
import io.ktor.client.plugins.defaultRequest
import io.ktor.client.request.get
import io.ktor.client.request.parameter
import io.ktor.http.HttpStatusCode
import kotlinx.coroutines.CancellationException
import org.archtool.data.model.RepoInfoModel
import org.archtool.helper.VcsHttpClientFactory
import org.archtool.vcs.provider.SyncedRepositories
import org.archtool.vcs.provider.VcsAccessProvider
import org.archtool.vcs.provider.VcsApiException
import org.archtool.vcs.provider.VcsApiUtils
import org.archtool.vcs.provider.VcsProjectKey
import org.archtool.vcs.provider.VcsProviderType
import org.archtool.vcs.provider.VcsRepoSlug
import org.archtool.vcs.provider.VcsUser
import org.archtool.vcs.provider.gitlab.dto.GitlabMemberDto
import org.archtool.vcs.provider.gitlab.dto.GitlabProjectDto
import org.archtool.service.RepoService
import org.archtool.service.UserService
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.springframework.stereotype.Component
import java.time.Instant
@Component
@ConditionalOnGitlab
class GitlabVcsAccessProvider(
private val properties: GitlabProperties,
private val vcsHttpClientFactory: VcsHttpClientFactory,
private val repoService: RepoService,
private val userService: UserService,
) : VcsAccessProvider {
private val httpClient: HttpClient = vcsHttpClientFactory.createClient(PRIVATE_TOKEN_HEADER) {
defaultRequest {
headers.append(PRIVATE_TOKEN_HEADER, properties.token)
}
}
override suspend fun syncRepositories(sequence: Long, expirationTime: Instant): SyncedRepositories {
log.debug("=== Запрашиваем и обновляем репозитории GitLab ===")
val repoProjectsMap: MutableMap<VcsProjectKey, MutableSet<VcsRepoSlug>> = mutableMapOf()
for (project in listProjects()) {
val projectId = project.id.toString()
repoProjectsMap.getOrPut(projectId) { mutableSetOf() }.add(projectId)
try {
repoService.saveRepo(
repoInfo = RepoInfoModel(
slug = projectId,
projectKey = projectId,
name = project.name,
description = project.description,
cloneLink = project.httpUrlToRepo,
webLink = project.webUrl,
defaultPermission = GitlabDefaultPermission.from(
project.visibility,
project.repositoryAccessLevel,
),
),
sequence = sequence,
expirationTime = expirationTime,
)
} catch (e: CancellationException) {
throw e
} catch (e: Exception) {
log.error("Ошибка при обновлении GitLab-проекта {}", projectId, e)
}
}
return SyncedRepositories(repoProjectsMap)
}
override suspend fun syncUsers(
repositories: SyncedRepositories,
sequence: Long,
expirationTime: Instant,
) {
log.debug("=== Запрашиваем пользователей и права на проекты GitLab ===")
for (projectId in repositories.slugsByProjectKey.keys) {
log.debug("Запрашиваем участников GitLab-проекта {}", projectId)
try {
syncProjectMembers(projectId, sequence, expirationTime)
} catch (e: CancellationException) {
throw e
} catch (e: VcsApiException) {
if (e.status == HttpStatusCode.Unauthorized) {
throw e
}
log.error("Ошибка при запросе участников GitLab-проекта {}", projectId, e)
} catch (e: Exception) {
log.error("Ошибка при запросе участников GitLab-проекта {}", projectId, e)
}
}
}
private suspend fun listProjects(): List<GitlabProjectDto> {
val projects = mutableListOf<GitlabProjectDto>()
var page = 1
while (true) {
val projectsUrl = "${properties.apiBaseUrl}/projects"
val response = vcsHttpClientFactory.execute(httpClient) { client ->
client.get(projectsUrl) {
parameter("page", page)
parameter("per_page", properties.perPage)
parameter("membership", properties.membership)
}
}
VcsApiUtils.requireSuccess(response, VcsProviderType.GITLAB, projectsUrl)
val pageProjects = response.body<List<GitlabProjectDto>>()
if (pageProjects.isEmpty()) {
break
}
projects.addAll(pageProjects)
val nextPage = response.headers["X-Next-Page"]?.toIntOrNull() ?: break
page = nextPage
}
return projects
}
private suspend fun syncProjectMembers(projectId: String, sequence: Long, expirationTime: Instant) {
var page = 1
while (true) {
val membersUrl = "${properties.apiBaseUrl}/projects/$projectId/members/all"
val response = vcsHttpClientFactory.execute(httpClient) { client ->
client.get(membersUrl) {
parameter("page", page)
parameter("per_page", properties.perPage)
}
}
VcsApiUtils.requireSuccess(response, VcsProviderType.GITLAB, membersUrl)
val members = response.body<List<GitlabMemberDto>>()
if (members.isEmpty()) {
break
}
for (member in members) {
if (member.state != "active") {
log.trace("[{}] Участник GitLab не активен, права не получены", member.username)
continue
}
val permission = GitlabAccessLevelMapping.mapAccessLevel(member.accessLevel)
if (permission == null) {
log.trace(
"[{}] Уровень доступа GitLab {} не даёт прав SEAF",
member.username,
member.accessLevel,
)
continue
}
userService.insertUserIfNotExistsAndSaveRepoRelations(
toVcsUser(member),
setOf(projectId),
projectId,
sequence,
expirationTime,
permission,
)
}
val nextPage = response.headers["X-Next-Page"]?.toIntOrNull() ?: break
page = nextPage
}
}
private fun toVcsUser(member: GitlabMemberDto): VcsUser =
VcsUser(externalId = member.username)
companion object {
private const val PRIVATE_TOKEN_HEADER = "PRIVATE-TOKEN"
private val log: Logger = LoggerFactory.getLogger(GitlabVcsAccessProvider::class.java)
}
}