Skip to content
This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Commit

Permalink
Try to restart foreground watcher in more cases (when hte app goes fo…
Browse files Browse the repository at this point in the history 
…reground and when a bookmark for currently opened thread is updated. Add more logs.
  • Loading branch information
@K1rakishou
K1rakishou committed Mar 6, 2024
1 parent 3dca7d7 commit 4d18c55
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 95 deletions.
9 changes: 9 additions & 0 deletions ...app/src/main/java/com/github/k1rakishou/chan/core/manager/ApplicationVisibilityManager.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@ package com.github.k1rakishou.chan.core.manager

import com.github.k1rakishou.chan.utils.BackgroundUtils
import com.github.k1rakishou.core_logger.Logger
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import java.util.concurrent.CopyOnWriteArrayList
import kotlin.time.measureTime

class ApplicationVisibilityManager {
private val listeners = CopyOnWriteArrayList<ApplicationVisibilityListener>()

private val _applicationVisibilityUpdatesFlow = MutableStateFlow<ApplicationVisibility>(ApplicationVisibility.Background)
val applicationVisibilityUpdatesFlow: StateFlow<ApplicationVisibility>
get() = _applicationVisibilityUpdatesFlow.asStateFlow()

@Volatile
private var currentApplicationVisibility: ApplicationVisibility = ApplicationVisibility.Background

Expand All @@ -29,6 +36,7 @@ class ApplicationVisibilityManager {

_switchedToForegroundAt = System.currentTimeMillis()
currentApplicationVisibility = ApplicationVisibility.Foreground
_applicationVisibilityUpdatesFlow.tryEmit(ApplicationVisibility.Foreground)

val time = measureTime {
listeners.forEach { listener ->
Expand All @@ -44,6 +52,7 @@ class ApplicationVisibilityManager {
BackgroundUtils.ensureMainThread()

currentApplicationVisibility = ApplicationVisibility.Background
_applicationVisibilityUpdatesFlow.tryEmit(ApplicationVisibility.Background)

val time = measureTime {
listeners.forEach { listener ->
Expand Down
131 changes: 53 additions & 78 deletions ...ba/app/src/main/java/com/github/k1rakishou/chan/core/watcher/BookmarkForegroundWatcher.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ package com.github.k1rakishou.chan.core.watcher

import android.content.Context
import com.github.k1rakishou.ChanSettings
import com.github.k1rakishou.chan.core.manager.ApplicationVisibility
import com.github.k1rakishou.chan.core.manager.ApplicationVisibilityManager
import com.github.k1rakishou.chan.core.manager.ArchivesManager
import com.github.k1rakishou.chan.core.manager.BookmarksManager
import com.github.k1rakishou.chan.core.manager.CurrentOpenedDescriptorStateManager
import com.github.k1rakishou.common.AppConstants
import com.github.k1rakishou.common.errorMessageOrClassName
import com.github.k1rakishou.common.isExceptionImportant
import com.github.k1rakishou.common.rethrowCancellationException
import com.github.k1rakishou.core_logger.Logger
import com.github.k1rakishou.model.data.descriptor.ChanDescriptor
import dagger.Lazy
Expand All @@ -21,11 +20,12 @@ import kotlinx.coroutines.Job
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.channels.consumeEach
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.flow.onEach
import kotlinx.coroutines.isActive
import kotlinx.coroutines.launch
import kotlinx.coroutines.reactive.asFlow
import kotlinx.coroutines.withContext
import java.util.concurrent.atomic.AtomicInteger
import java.util.concurrent.atomic.AtomicReference

class BookmarkForegroundWatcher(
Expand All @@ -41,37 +41,40 @@ class BookmarkForegroundWatcher(
) {
private val channel = Channel<Unit>(Channel.RENDEZVOUS)
private val workJob = AtomicReference<Job?>(null)
private val attemptsCount = 25
private val attemptsBeforeShuttingDown = AtomicInteger(attemptsCount)

init {
appScope.launch {
channel.consumeEach {
if (workJob.get() != null) {
if (workJob.get()?.isActive == true) {
Logger.debug(TAG) { "channel.consumeEach() workJob != null. Exiting." }
return@consumeEach
}

val newJob = appScope.launch(Dispatchers.Default, CoroutineStart.LAZY) {
try {
Logger.d(TAG, "working == true, calling updateBookmarksWorkerLoop()")
Logger.d(TAG, "channel.consumeEach() working == true, calling updateBookmarksWorkerLoop()")
updateBookmarksWorkerLoop()
Logger.d(TAG, "channel.consumeEach() working == false, exited updateBookmarksWorkerLoop normally")
} catch (error: Throwable) {
if (error is CancellationException) {
Logger.d(TAG, "updateBookmarksWorkerLoop() canceled, exiting")
error.rethrowCancellationException()
Logger.d(TAG, "channel.consumeEach() got CancellationException")
} else {
Logger.error(TAG) {
"channel.consumeEach() Error while doing foreground bookmark watching: ${error.errorMessageOrClassName()}"
}
}

logErrorIfNeeded(error)
} finally {
workJob.set(null)
Logger.d(TAG, "channel.consumeEach() working == false")
workJob.getAndSet(null)?.cancel()
}
}

if (workJob.compareAndSet(null, newJob)) {
newJob.start()
} else {
newJob.cancel()
}
Logger.debug(TAG) { "channel.consumeEach() cancelling previous coroutine" }
workJob.get()?.cancel()
workJob.set(newJob)

Logger.debug(TAG) { "channel.consumeEach() starting new coroutine" }
newJob.start()
}
}

Expand All @@ -84,23 +87,40 @@ class BookmarkForegroundWatcher(
}
}
}

appScope.launch {
applicationVisibilityManager.applicationVisibilityUpdatesFlow
.onEach { applicationVisibility ->
if (applicationVisibility == ApplicationVisibility.Foreground) {
Logger.debug(TAG) { "Got ${applicationVisibility} event, trying to restart the foreground watcher" }
startWatchingIfNotWatchingYet()
}
}
.collect()
}
}

suspend fun startWatchingIfNotWatchingYet() {
if (workJob.get() == null) {
attemptsBeforeShuttingDown.set(attemptsCount)
val currentWorkJob = workJob.get()

if (currentWorkJob == null || !currentWorkJob.isActive) {
Logger.d(TAG, "startWatchingIfNotWatchingYet() currentWorkJob is null or not active")

channel.send(Unit)
return
}

channel.send(Unit)
Logger.d(TAG, "startWatchingIfNotWatchingYet() currentWorkJob is not null or is active")
}

@Synchronized
fun stopWatching() {
Logger.d(TAG, "stopWatching()")
workJob.getAndSet(null)?.cancel()
}

suspend fun restartWatching() {
Logger.d(TAG, "restartWatching() called")
Logger.d(TAG, "restartWatching()")

stopWatching()
startWatchingIfNotWatchingYet()
Expand Down Expand Up @@ -152,6 +172,7 @@ class BookmarkForegroundWatcher(

try {
BookmarkWatcherCoordinator.restartBackgroundWork(appConstants, appContext)
startWatchingIfNotWatchingYet()

bookmarkWatcherDelegate.get().doWork(
isCalledFromForeground = true,
Expand All @@ -174,47 +195,22 @@ class BookmarkForegroundWatcher(
val isAppInForeground = applicationVisibilityManager.isAppInForeground()
val isAppStartingUp = applicationVisibilityManager.isAppStartingUpMaybe()

Logger.d(TAG, "updateBookmarksWorkerLoop() isAppInForeground: ${isAppInForeground}, isAppStartingUp: ${isAppStartingUp}")
return
}

val switchedToForegroundAt = applicationVisibilityManager.switchedToForegroundAt
val currentTime = System.currentTimeMillis()

if (switchedToForegroundAt == null || (currentTime - switchedToForegroundAt) < REQUIRED_FOREGROUND_TIME_MS) {
if (switchedToForegroundAt == null && attemptsBeforeShuttingDown.decrementAndGet() <= 0) {
Logger.d(TAG, "updateBookmarksWorkerLoop() app haven't started up within the allowed attempts count. " +
"This is most likely because some service got started up, not the app itself. " +
"Shutting down the foreground watcher.")
return
Logger.debug(TAG) {
"updateBookmarksWorkerLoop() isInForegroundOrStartingUp is false, exiting. " +
"isAppInForeground: ${isAppInForeground}, isAppStartingUp: ${isAppStartingUp}"
}

if (switchedToForegroundAt == null) {
val attemptsCount = attemptsBeforeShuttingDown.get()

Logger.d(TAG, "updateBookmarksWorkerLoop() app is starting up and not ready to process " +
"bookmarks yet, attemptsCount=$attemptsCount")
} else {
val foregroundTime = currentTime - switchedToForegroundAt

Logger.d(TAG, "updateBookmarksWorkerLoop() app was not long enough in the foreground " +
"to start updating bookmarks (foregroundTime=${foregroundTime}ms)")
}

delay(APP_FOREGROUND_DELAY_MS)
continue
return
}

attemptsBeforeShuttingDown.set(attemptsCount)

if (!ChanSettings.watchEnabled.get()) {
Logger.d(TAG, "updateBookmarksWorkerLoop() ChanSettings.watchEnabled() is false, exiting")
Logger.d(TAG, "updateBookmarksWorkerLoop() ChanSettings.watchEnabled() is false. Exiting.")
return
}

val hasActiveBookmarks = bookmarksManager.hasActiveBookmarks()
if (!hasActiveBookmarks) {
Logger.d(TAG, "updateBookmarksWorkerLoop() no active bookmarks left, exiting")
Logger.d(TAG, "updateBookmarksWorkerLoop() no active bookmarks left. Exiting.")
return
}

Expand All @@ -226,29 +222,23 @@ class BookmarkForegroundWatcher(
updateCurrentlyOpenedThread = false
)
} catch (error: Throwable) {
Logger.e(TAG, "Unhandled exception in " +
Logger.e(TAG, "updateBookmarksWorkerLoop() Unhandled exception in " +
"bookmarkWatcherDelegate.doWork(isUpdatingCurrentlyOpenedThread=false)", error)
}

if (!isActive) {
Logger.d(TAG, "updateBookmarksWorkerLoop() not active anymore (before delay), exiting")
Logger.d(TAG, "updateBookmarksWorkerLoop() not active anymore (before delay). Exiting.")
return
}

val additionalInterval = calculateAndLogAdditionalInterval()

if (verboseLogsEnabled) {
Logger.d(TAG, "updateBookmarksWorkerLoop() start waiting")
}

Logger.d(TAG, "updateBookmarksWorkerLoop() start waiting...")
delay(foregroundWatchIntervalMs() + additionalInterval)

if (verboseLogsEnabled) {
Logger.d(TAG, "updateBookmarksWorkerLoop() done waiting")
}
Logger.d(TAG, "updateBookmarksWorkerLoop() start ...OK")

if (!isActive) {
Logger.d(TAG, "updateBookmarksWorkerLoop() not active anymore (after delay), exiting")
Logger.d(TAG, "updateBookmarksWorkerLoop() not active anymore (after delay). Exiting.")
return
}
}
Expand Down Expand Up @@ -286,24 +276,9 @@ class BookmarkForegroundWatcher(
return ADDITIONAL_INTERVAL_INCREMENT_MS
}

private fun logErrorIfNeeded(error: Throwable) {
if (!error.isExceptionImportant()) {
return
}

if (verboseLogsEnabled) {
Logger.e(TAG, "Error while doing foreground bookmark watching", error)
} else {
Logger.e(TAG, "Error while doing foreground bookmark watching: ${error.errorMessageOrClassName()}")
}
}

companion object {
private const val TAG = "BookmarkForegroundWatcher"

private const val REQUIRED_FOREGROUND_TIME_MS = 5_000L
private const val APP_FOREGROUND_DELAY_MS = 1_000L

const val ADDITIONAL_INTERVAL_INCREMENT_MS = 5L * 1000L
}
}
17 changes: 5 additions & 12 deletions ...a/app/src/main/java/com/github/k1rakishou/chan/core/watcher/BookmarkWatcherCoordinator.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ class BookmarkWatcherCoordinator(
// Pass the filter if we have at least one bookmark change that we actually want
.filter { bookmarkChange -> isWantedBookmarkChange(bookmarkChange) }
.collect { bookmarkChange ->
if (verboseLogsEnabled) {
Logger.d(TAG, "Calling onBookmarksChanged() because bookmarks have actually changed")
}
Logger.d(TAG, "Calling onBookmarksChanged() because bookmarks have actually changed")

onBookmarksChanged(
hasCreateBookmarkChange = bookmarkChange is BookmarksManager.BookmarkChange.BookmarksCreated
Expand Down Expand Up @@ -102,15 +100,13 @@ class BookmarkWatcherCoordinator(

private suspend fun onBookmarksChanged(hasCreateBookmarkChange: Boolean = false) {
val alreadyRunning = running.compareAndSet(false, true).not()

if (verboseLogsEnabled) {
Logger.d(TAG, "onBookmarksChanged() start hasCreateBookmarkChange: $hasCreateBookmarkChange, alreadyRunning: $alreadyRunning")
}

if (alreadyRunning) {
Logger.d(TAG, "onBookmarksChanged() alreadyRunning is true. Exiting.")
return
}

Logger.d(TAG, "onBookmarksChanged() hasCreateBookmarkChange: $hasCreateBookmarkChange")

appScope.launch {
if (!bookmarksManager.isReady()) {
Logger.d(TAG, "onBookmarksChanged() bookmarksManager.awaitUntilInitialized()...")
Expand Down Expand Up @@ -155,10 +151,7 @@ class BookmarkWatcherCoordinator(
Logger.e(TAG, "onBookmarksChanged() canceled")
} finally {
running.set(false)

if (verboseLogsEnabled) {
Logger.d(TAG, "onBookmarksChanged() end")
}
Logger.d(TAG, "onBookmarksChanged() end")
}
}
}
Expand Down
7 changes: 2 additions & 5 deletions Kuroba/app/src/main/java/com/github/k1rakishou/chan/core/watcher/BookmarkWatcherDelegate.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,8 @@ class BookmarkWatcherDelegate(
) {
BackgroundUtils.ensureBackgroundThread()

if (verboseLogsEnabled) {
Logger.d(TAG, "BookmarkWatcherDelegate.doWork(isCalledFromForeground: $isCalledFromForeground, " +
"updateCurrentlyOpenedThread: $updateCurrentlyOpenedThread)")
}
Logger.d(TAG, "BookmarkWatcherDelegate.doWork(isCalledFromForeground: $isCalledFromForeground, " +
"updateCurrentlyOpenedThread: $updateCurrentlyOpenedThread)")

if (isDevFlavor) {
if (isCalledFromForeground) {
Expand Down Expand Up @@ -83,7 +81,6 @@ class BookmarkWatcherDelegate(
}
}

@OptIn(ExperimentalTime::class)
private suspend fun doWorkInternal(
isCalledFromForeground: Boolean,
updateCurrentlyOpenedThread: Boolean,
Expand Down

0 comments on commit 4d18c55

Please sign in to comment.