VcsManagementController.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:
      Alexander Romashin <romashin.a.va@sberbank.ru>, Sber - 2026

  Contributors:
      Alexander Romashin <romashin.a.va@sberbank.ru>, Sber - 2026
*/

package org.archtool.controller

import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.media.Content
import io.swagger.v3.oas.annotations.media.Schema
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.tags.Tag
import org.archtool.data.dto.UpdateStatusResponse
import org.archtool.data.model.UpdateStatus
import org.archtool.scheduler.VcsReposDataScheduler
import org.slf4j.LoggerFactory
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PutMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController

@Tag(
    name = "Контроллер управления адаптера GIT",
    description = "Отвечает за управление процессом обновления данных адаптера GIT"
)
@RestController
@RequestMapping("/vcs-mgr")
class VcsManagementController(
    private val scheduler: VcsReposDataScheduler
) {
    private val log = LoggerFactory.getLogger(javaClass)

    @Operation(
        summary = "Обновление данных из VCS",
        description = "Запускает процедуру принудительного обновления данных из VCS, в конце вызывает метод reload бэкенда. " +
                "Ответ SCHEDULED — запрос принят: обновление начнётся после него. Ответ IN_PROGRESS — обновление, " +
                "начатое до запроса, ещё выполняется, и запрос не принят: вызывающий должен повторить его после завершения обновления.",
        responses = [
            ApiResponse(
                responseCode = "200", description = "Обновление запланировано",
                content = [Content(schema = Schema(implementation = UpdateStatusResponse::class))]
            ),
        ]
    )
    @PutMapping("/update")
    suspend fun update(): UpdateStatusResponse {
        scheduler.scheduleUpdate()
        val status = scheduler.updateStatus
        log.debug("Статус обновления изменён на {}", status)
        return UpdateStatusResponse(status.name, status.value)
    }

    @Operation(
        summary = "Получение статуса обновления данных из VCS",
        description = "Возвращает текущий статус процесса обновления: выполнение, планирование или статус бэкенда.",
        responses = [
            ApiResponse(
                responseCode = "200", description = "Статус загрузки манифеста",
                content = [Content(schema = Schema(implementation = UpdateStatusResponse::class))]
            )
        ]
    )
    @GetMapping("/status")
    suspend fun status(): UpdateStatusResponse {
        val status = scheduler.updateStatus
        val completionTime = if (status == UpdateStatus.SUCCESS) {
            scheduler.updateCompletionTime
        } else {
            null
        }
        val errorMessage = if (status == UpdateStatus.ERROR) {
            scheduler.errorMessage
        } else {
            null
        }
        return UpdateStatusResponse(status.name, status.value, completionTime, errorMessage)
    }
}