Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/gql improve webui update status #783

Merged
merged 5 commits into from
Dec 9, 2023
Merged

Feature/gql improve webui update status #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91e5f24
Remove "updateAvailable" from webui update info
schroda Nov 27, 2023
166b676
Extract status creation into function
schroda Nov 27, 2023
6042f88
Optionally emit status immediately
schroda Nov 27, 2023
a43f193
Rename "STOPPED" state to "IDLE"
schroda Nov 27, 2023
9855391
Reset webui update status
schroda Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions server/src/main/kotlin/suwayomi/tachidesk/graphql/mutations/InfoMutation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ import kotlinx.coroutines.flow.first
import kotlinx.coroutines.withTimeout
import suwayomi.tachidesk.graphql.types.UpdateState.DOWNLOADING
import suwayomi.tachidesk.graphql.types.UpdateState.ERROR
import suwayomi.tachidesk.graphql.types.UpdateState.STOPPED
import suwayomi.tachidesk.graphql.types.WebUIUpdateInfo
import suwayomi.tachidesk.graphql.types.UpdateState.IDLE
import suwayomi.tachidesk.graphql.types.WebUIUpdateStatus
import suwayomi.tachidesk.server.JavalinSetup.future
import suwayomi.tachidesk.server.serverConfig
import suwayomi.tachidesk.server.util.WebInterfaceManager
import java.util.concurrent.CompletableFuture
import kotlin.time.Duration.Companion.seconds
Expand Down Expand Up @@ -37,16 +35,7 @@ class InfoMutation {

return@withTimeout WebUIUpdatePayload(
input.clientMutationId,
WebUIUpdateStatus(
info =
WebUIUpdateInfo(
channel = serverConfig.webUIChannel.value,
tag = version,
updateAvailable,
),
state = if (didUpdateCheckFail) ERROR else STOPPED,
progress = 0,
),
WebInterfaceManager.getStatus(version, if (didUpdateCheckFail) ERROR else IDLE),
)
}
try {
Expand All @@ -62,4 +51,19 @@ class InfoMutation {
}
}
}

fun resetWebUIUpdateStatus(): CompletableFuture<WebUIUpdateStatus> {
return future {
withTimeout(30.seconds) {
val isUpdateFinished = WebInterfaceManager.status.value.state != DOWNLOADING
if (!isUpdateFinished) {
throw Exception("Status reset is not allowed during status \"$DOWNLOADING\"")
}

WebInterfaceManager.resetStatus()

WebInterfaceManager.status.first { it.state == IDLE }
}
}
}
}
3 changes: 1 addition & 2 deletions server/src/main/kotlin/suwayomi/tachidesk/graphql/types/WebUIUpdateType.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ data class WebUIUpdateCheck(
data class WebUIUpdateInfo(
val channel: String,
val tag: String,
val updateAvailable: Boolean,
)

enum class UpdateState {
STOPPED,
IDLE,
DOWNLOADING,
FINISHED,
ERROR,
Expand Down
80 changes: 47 additions & 33 deletions server/src/main/kotlin/suwayomi/tachidesk/server/util/WebInterfaceManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import suwayomi.tachidesk.graphql.types.UpdateState
import suwayomi.tachidesk.graphql.types.UpdateState.DOWNLOADING
import suwayomi.tachidesk.graphql.types.UpdateState.ERROR
import suwayomi.tachidesk.graphql.types.UpdateState.FINISHED
import suwayomi.tachidesk.graphql.types.UpdateState.STOPPED
import suwayomi.tachidesk.graphql.types.UpdateState.IDLE
import suwayomi.tachidesk.graphql.types.WebUIUpdateInfo
import suwayomi.tachidesk.graphql.types.WebUIUpdateStatus
import suwayomi.tachidesk.server.ApplicationDirs
Expand Down Expand Up @@ -137,25 +137,22 @@ object WebInterfaceManager {
private val notifyFlow =
MutableSharedFlow<WebUIUpdateStatus>(extraBufferCapacity = 1, onBufferOverflow = DROP_OLDEST)

@OptIn(FlowPreview::class)
private val statusFlow = MutableSharedFlow<WebUIUpdateStatus>()
val status =
notifyFlow.sample(1.seconds)
.stateIn(
scope,
SharingStarted.Eagerly,
WebUIUpdateStatus(
info =
WebUIUpdateInfo(
channel = serverConfig.webUIChannel.value,
tag = "",
updateAvailable = false,
),
state = STOPPED,
progress = 0,
),
)
statusFlow.stateIn(
scope,
SharingStarted.Eagerly,
getStatus(),
)

init {
scope.launch {
@OptIn(FlowPreview::class)
notifyFlow.sample(1.seconds).collect {
statusFlow.emit(it)
}
}

serverConfig.subscribeTo(
combine(serverConfig.webUIUpdateCheckInterval, serverConfig.webUIFlavor) { interval, flavor ->
Pair(
Expand All @@ -168,7 +165,7 @@ object WebInterfaceManager {
)
}

suspend fun getAboutInfo(): AboutWebUI {
fun getAboutInfo(): AboutWebUI {
val currentVersion = getLocalVersion()

val failedToGetVersion = currentVersion === "r-1"
Expand All @@ -182,6 +179,26 @@ object WebInterfaceManager {
)
}

fun getStatus(
version: String = "",
state: UpdateState = IDLE,
progress: Int = 0,
): WebUIUpdateStatus {
return WebUIUpdateStatus(
info =
WebUIUpdateInfo(
channel = serverConfig.webUIChannel.value,
tag = version,
),
state,
progress,
)
}

fun resetStatus() {
emitStatus("", IDLE, 0, immediate = true)
}

private var serveWebUI: () -> Unit = {}

fun setServeWebUI(serveWebUI: () -> Unit) {
Expand Down Expand Up @@ -535,20 +552,17 @@ object WebInterfaceManager {
version: String,
state: UpdateState,
progress: Int,
immediate: Boolean = false,
) {
scope.launch {
notifyFlow.emit(
WebUIUpdateStatus(
info =
WebUIUpdateInfo(
channel = serverConfig.webUIChannel.value,
tag = version,
updateAvailable = true,
),
state,
progress,
),
)
val status = getStatus(version, state, progress)

if (immediate) {
statusFlow.emit(status)
return@launch
}

notifyFlow.emit(status)
}
}

Expand All @@ -559,7 +573,7 @@ object WebInterfaceManager {
}

suspend fun downloadVersion(version: String) {
emitStatus(version, DOWNLOADING, 0)
emitStatus(version, DOWNLOADING, 0, immediate = true)

try {
val webUIZip = "${WebUIFlavor.WEBUI.baseFileName}-$version.zip"
Expand All @@ -586,11 +600,11 @@ object WebInterfaceManager {
extractDownload(webUIZipPath, applicationDirs.webUIRoot)
log.info { "Extracting WebUI zip Done." }

emitStatus(version, FINISHED, 100)
emitStatus(version, FINISHED, 100, immediate = true)

serveWebUI()
} catch (e: Exception) {
emitStatus(version, ERROR, 0)
emitStatus(version, ERROR, 0, immediate = true)
throw e
}
}
Expand Down
Loading