implemented 08-web-ui.md: added Thymeleaf-based web UI: templates for builds, artifacts, current builds, and fragments; static assets for favicon, CSS, and JavaScript
This commit is contained in:
Michael Hoennig
@@ -67,10 +67,14 @@ class BuildsApiController(
|
||||
return ResponseEntity.ok(readLogTail(artifactKey, build.liveLogFile, offset))
|
||||
}
|
||||
|
||||
/** Re-enqueues the branch's last recorded commit, like the legacy `/control/restart`. */
|
||||
@PostMapping("/api/builds/{branch}/restart")
|
||||
/**
|
||||
* Re-enqueues the branch's last recorded commit, like the legacy `/control/restart`.
|
||||
* The branch is a parameter, not a path variable, because branch names may contain
|
||||
* slashes (Tomcat rejects encoded slashes in the path by default).
|
||||
*/
|
||||
@PostMapping("/api/builds/restart")
|
||||
fun restart(
|
||||
@PathVariable branch: String,
|
||||
@RequestParam branch: String,
|
||||
@RequestHeader(name = TOKEN_HEADER, required = false) headerToken: String?,
|
||||
@RequestParam(name = "token", required = false) paramToken: String?,
|
||||
): ResponseEntity<Any> {
|
||||
|
||||
@@ -0,0 +1,173 @@
|
||||
package de.hoennig.gittally.server
|
||||
|
||||
import de.hoennig.gittally.build.ArtifactStore
|
||||
import de.hoennig.gittally.build.BuildExecutor
|
||||
import de.hoennig.gittally.build.BuildResultRepository
|
||||
import de.hoennig.gittally.build.BuildStatus
|
||||
import de.hoennig.gittally.config.ConfigLoader
|
||||
import org.springframework.beans.factory.ObjectProvider
|
||||
import org.springframework.boot.info.BuildProperties
|
||||
import org.springframework.http.HttpStatus
|
||||
import org.springframework.stereotype.Controller
|
||||
import org.springframework.ui.Model
|
||||
import org.springframework.web.bind.annotation.GetMapping
|
||||
import org.springframework.web.bind.annotation.PathVariable
|
||||
import org.springframework.web.server.ResponseStatusException
|
||||
import java.nio.file.Files
|
||||
import java.nio.file.Path
|
||||
import java.nio.file.Paths
|
||||
import kotlin.io.path.name
|
||||
import kotlin.streams.asSequence
|
||||
|
||||
/**
|
||||
* Server-rendered Thymeleaf views over the JSON API. The pages render the full
|
||||
* state server-side (usable without JavaScript); `gittally.js` then polls the
|
||||
* `/api/…` endpoints and re-renders the table bodies — pages are never re-fetched
|
||||
* and diffed like legacy, so the UI cannot get stuck on a loading animation.
|
||||
*/
|
||||
@Controller
|
||||
class UiController(
|
||||
private val repository: BuildResultRepository,
|
||||
private val buildExecutor: BuildExecutor,
|
||||
private val artifactStore: ArtifactStore,
|
||||
private val controlTokens: ControlTokenService,
|
||||
private val configLoader: ConfigLoader,
|
||||
private val buildProperties: ObjectProvider<BuildProperties>,
|
||||
) {
|
||||
var workingDir: Path = Paths.get(".")
|
||||
|
||||
@GetMapping("/")
|
||||
fun latest(model: Model): String {
|
||||
val links = baseModel(model, view = "latest", pageTitle = "Latest Builds")
|
||||
model.addAttribute("rows", repository.latestPerBranch().map { BuildRowView.from(it, links) })
|
||||
model.addAttribute("apiPath", "/api/builds/latest")
|
||||
model.addAttribute("allowRestart", true)
|
||||
model.addAttribute("emptyMessage", "No builds recorded yet.")
|
||||
return "builds"
|
||||
}
|
||||
|
||||
@GetMapping("/history")
|
||||
fun history(model: Model): String {
|
||||
val links = baseModel(model, view = "history", pageTitle = "Build History")
|
||||
model.addAttribute("rows", repository.history().map { BuildRowView.from(it, links) })
|
||||
model.addAttribute("apiPath", "/api/builds/history")
|
||||
model.addAttribute("allowRestart", false)
|
||||
model.addAttribute("emptyMessage", "No builds archived yet.")
|
||||
return "builds"
|
||||
}
|
||||
|
||||
@GetMapping("/current")
|
||||
fun current(model: Model): String {
|
||||
val links = baseModel(model, view = "current", pageTitle = "Current Builds")
|
||||
val results = repository.history()
|
||||
val currentBuilds =
|
||||
buildExecutor.currentBuilds().map { build ->
|
||||
CurrentBuildView(
|
||||
branch = build.branch,
|
||||
commit = build.commit,
|
||||
commitAbbrev = build.commit.take(12),
|
||||
status =
|
||||
(results.firstOrNull { it.artifactKey == build.artifactKey }?.status ?: BuildStatus.RUNNING)
|
||||
.jsonName,
|
||||
startedAtIso = build.startedAt.toString(),
|
||||
startedAt = UiFormats.timestamp(build.startedAt),
|
||||
artifactKey = build.artifactKey,
|
||||
branchUrl = links.branchUrl(build.branch),
|
||||
commitUrl = links.commitUrl(build.commit),
|
||||
)
|
||||
}
|
||||
model.addAttribute("currentBuilds", currentBuilds)
|
||||
return "current"
|
||||
}
|
||||
|
||||
/** Artifact index rendered from the artifact store — legacy pre-generated this page as static HTML. */
|
||||
@GetMapping("/builds/{artifactKey}")
|
||||
fun artifactIndex(
|
||||
@PathVariable artifactKey: String,
|
||||
model: Model,
|
||||
): String {
|
||||
val result = repository.history().firstOrNull { it.artifactKey == artifactKey }
|
||||
val artifactDir = artifactStore.artifactDir(artifactKey)
|
||||
if (result == null && artifactDir == null) {
|
||||
throw ResponseStatusException(HttpStatus.NOT_FOUND, "no build with artifact key '$artifactKey'")
|
||||
}
|
||||
val links = baseModel(model, view = "artifact", pageTitle = "Build Artifacts")
|
||||
model.addAttribute("artifactKey", artifactKey)
|
||||
model.addAttribute("result", result?.let { BuildRowView.from(it, links) })
|
||||
model.addAttribute("hasArtifacts", artifactDir != null)
|
||||
model.addAttribute("buildCommand", result?.let { branchBuildCommand(it.branch) })
|
||||
model.addAttribute("logs", artifactDir?.let { logFiles(it) } ?: emptyList<String>())
|
||||
model.addAttribute("reportIndexes", artifactDir?.let { reportIndexes(it) } ?: emptyList<String>())
|
||||
return "artifact"
|
||||
}
|
||||
|
||||
/** Adds the attributes every page needs and returns the Gitea link helper for row building. */
|
||||
private fun baseModel(
|
||||
model: Model,
|
||||
view: String,
|
||||
pageTitle: String,
|
||||
): GiteaWebLinks {
|
||||
val config = configLoader.load(workingDir)
|
||||
val links = GiteaWebLinks(config.gitea)
|
||||
val repoName =
|
||||
listOf(config.gitea.owner.trim(), config.gitea.repo.trim())
|
||||
.filter { it.isNotEmpty() }
|
||||
.joinToString("/")
|
||||
model.addAttribute("view", view)
|
||||
model.addAttribute("pageTitle", pageTitle)
|
||||
model.addAttribute("repoName", repoName)
|
||||
model.addAttribute("version", buildProperties.getIfAvailable()?.version ?: "dev")
|
||||
model.addAttribute("impressumUrl", config.server.impressumUrl.trim())
|
||||
model.addAttribute("controlToken", controlTokens.token())
|
||||
model.addAttribute("giteaRepoUrl", links.repoUrl ?: "")
|
||||
return links
|
||||
}
|
||||
|
||||
/** The currently configured build command — the command actually used at build time is not persisted. */
|
||||
private fun branchBuildCommand(branch: String): String {
|
||||
val branches = configLoader.load(workingDir).branches
|
||||
return (branches[branch] ?: branches["default"])?.buildCommand ?: ""
|
||||
}
|
||||
|
||||
/** The stored log files: all top-level regular files of the artifact directory. */
|
||||
private fun logFiles(artifactDir: Path): List<String> =
|
||||
Files.list(artifactDir).use { children ->
|
||||
children
|
||||
.asSequence()
|
||||
.filter { Files.isRegularFile(it) }
|
||||
.map { it.name }
|
||||
.sorted()
|
||||
.toList()
|
||||
}
|
||||
|
||||
/**
|
||||
* The browsable `index.html` pages under `reports/`, shallowest first; pages nested
|
||||
* below an already-listed report index are skipped — like the legacy artifact index.
|
||||
*/
|
||||
private fun reportIndexes(artifactDir: Path): List<String> {
|
||||
val reportsDir = artifactDir.resolve("reports")
|
||||
if (!Files.isDirectory(reportsDir)) {
|
||||
return emptyList()
|
||||
}
|
||||
val allIndexes =
|
||||
Files.walk(reportsDir).use { paths ->
|
||||
paths
|
||||
.asSequence()
|
||||
.filter { Files.isRegularFile(it) && it.name == "index.html" }
|
||||
.map { reportsDir.relativize(it).toString() }
|
||||
.sortedWith(compareBy({ path -> path.count { it == '/' } }, { it.length }, { it }))
|
||||
.toList()
|
||||
}
|
||||
val knownDirs = mutableListOf<String>()
|
||||
val topmost = mutableListOf<String>()
|
||||
for (relativeIndex in allIndexes) {
|
||||
val dir = relativeIndex.substringBeforeLast('/', "")
|
||||
if (knownDirs.any { known -> known.isEmpty() || dir == known || dir.startsWith("$known/") }) {
|
||||
continue
|
||||
}
|
||||
knownDirs += dir
|
||||
topmost += relativeIndex
|
||||
}
|
||||
return topmost
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
package de.hoennig.gittally.server
|
||||
|
||||
import de.hoennig.gittally.build.BuildResult
|
||||
import de.hoennig.gittally.config.GiteaConfig
|
||||
import java.net.URLEncoder
|
||||
import java.nio.charset.StandardCharsets
|
||||
import java.time.Duration
|
||||
import java.time.Instant
|
||||
import java.time.ZoneId
|
||||
import java.time.format.DateTimeFormatter
|
||||
|
||||
/** Links into the Gitea web UI, like legacy `gitea_branch_web_url`; null when Gitea is not configured. */
|
||||
class GiteaWebLinks(
|
||||
gitea: GiteaConfig,
|
||||
) {
|
||||
val repoUrl: String? =
|
||||
listOf(gitea.baseUrl.trim().trimEnd('/'), gitea.owner.trim(), gitea.repo.trim())
|
||||
.takeIf { parts -> parts.all { it.isNotEmpty() } }
|
||||
?.let { (baseUrl, owner, repo) -> "$baseUrl/${escapePath(owner)}/${escapePath(repo)}" }
|
||||
|
||||
fun branchUrl(branch: String): String? = repoUrl?.let { "$it/src/branch/${escapePath(branch)}" }
|
||||
|
||||
fun commitUrl(commit: String): String? = repoUrl?.let { "$it/commit/${escapePath(commit)}" }
|
||||
|
||||
/** Escapes each path segment but keeps `/` — branch names may contain slashes. */
|
||||
private fun escapePath(value: String): String =
|
||||
value
|
||||
.split('/')
|
||||
.joinToString("/") { URLEncoder.encode(it, StandardCharsets.UTF_8).replace("+", "%20") }
|
||||
}
|
||||
|
||||
/** Display formatting shared by the server-rendered views; `gittally.js` renders the same formats. */
|
||||
object UiFormats {
|
||||
private val timestampFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm").withZone(ZoneId.systemDefault())
|
||||
|
||||
fun timestamp(instant: Instant): String = timestampFormat.format(instant)
|
||||
|
||||
/** `m:ss`, or `h:mm:ss` from one hour — like the legacy `MM:SS` duration column. */
|
||||
fun duration(duration: Duration?): String {
|
||||
if (duration == null || duration.isNegative) {
|
||||
return ""
|
||||
}
|
||||
val seconds = duration.seconds
|
||||
val hours = seconds / 3600
|
||||
val minutes = (seconds % 3600) / 60
|
||||
val rest = seconds % 60
|
||||
return if (hours > 0) {
|
||||
"%d:%02d:%02d".format(hours, minutes, rest)
|
||||
} else {
|
||||
"%d:%02d".format(minutes, rest)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** One row of the latest/history build tables. */
|
||||
data class BuildRowView(
|
||||
val branch: String,
|
||||
val commit: String,
|
||||
val commitAbbrev: String,
|
||||
val status: String,
|
||||
val startedAtIso: String,
|
||||
val startedAt: String,
|
||||
val duration: String,
|
||||
val artifactKey: String,
|
||||
val branchUrl: String?,
|
||||
val commitUrl: String?,
|
||||
) {
|
||||
companion object {
|
||||
fun from(
|
||||
result: BuildResult,
|
||||
links: GiteaWebLinks,
|
||||
) = BuildRowView(
|
||||
branch = result.branch,
|
||||
commit = result.commit,
|
||||
commitAbbrev = result.commit.take(12),
|
||||
status = result.status.jsonName,
|
||||
startedAtIso = result.startedAt.toString(),
|
||||
startedAt = UiFormats.timestamp(result.startedAt),
|
||||
duration = UiFormats.duration(result.duration),
|
||||
artifactKey = result.artifactKey,
|
||||
branchUrl = links.branchUrl(result.branch),
|
||||
commitUrl = links.commitUrl(result.commit),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/** One card of the current-builds view; the live log is fetched by `gittally.js`. */
|
||||
data class CurrentBuildView(
|
||||
val branch: String,
|
||||
val commit: String,
|
||||
val commitAbbrev: String,
|
||||
val status: String,
|
||||
val startedAtIso: String,
|
||||
val startedAt: String,
|
||||
val artifactKey: String,
|
||||
val branchUrl: String?,
|
||||
val commitUrl: String?,
|
||||
)
|
||||
Reference in New Issue
Block a user