From ec88c722dcbb80d72bc15742b8288b31bb2e6b5a Mon Sep 17 00:00:00 2001 From: Matthias Urhahn <matthias.urhahn@sap.com> Date: Wed, 25 Nov 2020 15:34:42 +0100 Subject: [PATCH] Make worker type visible on log output (DEV) #1714 Co-authored-by: harambasicluka <64483219+harambasicluka@users.noreply.github.com> Co-authored-by: Ralf Gehrer <ralfgehrer@users.noreply.github.com> --- .../DeadmanNotificationOneTimeWorker.kt | 8 +++-- .../DeadmanNotificationPeriodicWorker.kt | 10 ++++-- .../nearby/ExposureStateUpdateWorker.kt | 8 +++-- .../worker/BackgroundNoiseOneTimeWorker.kt | 13 ++++---- .../worker/BackgroundNoisePeriodicWorker.kt | 18 +++++------ .../DiagnosisKeyRetrievalOneTimeWorker.kt | 19 ++++++------ .../DiagnosisKeyRetrievalPeriodicWorker.kt | 18 +++++------ ...gnosisTestResultRetrievalPeriodicWorker.kt | 31 +++++++++---------- 8 files changed, 64 insertions(+), 61 deletions(-) diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationOneTimeWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationOneTimeWorker.kt index 039330a1c..9eec045cc 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationOneTimeWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationOneTimeWorker.kt @@ -22,10 +22,10 @@ class DeadmanNotificationOneTimeWorker @AssistedInject constructor( CoroutineWorker(context, workerParams) { override suspend fun doWork(): Result { - Timber.d("Background job started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("Background job started. Run attempt: $runAttemptCount") if (runAttemptCount > BackgroundConstants.WORKER_RETRY_COUNT_THRESHOLD) { - Timber.d("Background job failed after $runAttemptCount attempts. Rescheduling") + Timber.tag(TAG).d("Background job failed after $runAttemptCount attempts. Rescheduling") return Result.failure() } @@ -41,4 +41,8 @@ class DeadmanNotificationOneTimeWorker @AssistedInject constructor( @AssistedInject.Factory interface Factory : InjectedWorkerFactory<DeadmanNotificationOneTimeWorker> + + companion object { + private val TAG = DeadmanNotificationOneTimeWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationPeriodicWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationPeriodicWorker.kt index 53e5d06ca..efd968e15 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationPeriodicWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/deadman/DeadmanNotificationPeriodicWorker.kt @@ -22,10 +22,10 @@ class DeadmanNotificationPeriodicWorker @AssistedInject constructor( CoroutineWorker(context, workerParams) { override suspend fun doWork(): Result { - Timber.d("Background job started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("Background job started. Run attempt: $runAttemptCount") if (runAttemptCount > BackgroundConstants.WORKER_RETRY_COUNT_THRESHOLD) { - Timber.d("Background job failed after $runAttemptCount attempts. Rescheduling") + Timber.tag(TAG).d("Background job failed after $runAttemptCount attempts. Rescheduling") return Result.failure() } @@ -34,7 +34,7 @@ class DeadmanNotificationPeriodicWorker @AssistedInject constructor( // Schedule one time deadman notification send work scheduler.scheduleOneTime() } catch (e: Exception) { - Timber.d(e) + Timber.tag(TAG).d(e) result = Result.retry() } @@ -43,4 +43,8 @@ class DeadmanNotificationPeriodicWorker @AssistedInject constructor( @AssistedInject.Factory interface Factory : InjectedWorkerFactory<DeadmanNotificationPeriodicWorker> + + companion object { + private val TAG = DeadmanNotificationPeriodicWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/nearby/ExposureStateUpdateWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/nearby/ExposureStateUpdateWorker.kt index e383844c3..5332793bf 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/nearby/ExposureStateUpdateWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/nearby/ExposureStateUpdateWorker.kt @@ -22,12 +22,10 @@ class ExposureStateUpdateWorker @AssistedInject constructor( override suspend fun doWork(): Result { try { - Timber.v("worker to persist exposure summary started") - taskController.submit( DefaultTaskRequest(RiskLevelTask::class, originTag = "ExposureStateUpdateWorker") ) - Timber.v("risk level calculation triggered") + Timber.tag(TAG).v("Risk level calculation triggered") } catch (e: ApiException) { e.report(ExceptionCategory.EXPOSURENOTIFICATION) } @@ -37,4 +35,8 @@ class ExposureStateUpdateWorker @AssistedInject constructor( @AssistedInject.Factory interface Factory : InjectedWorkerFactory<ExposureStateUpdateWorker> + + companion object { + private val TAG = ExposureStateUpdateWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoiseOneTimeWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoiseOneTimeWorker.kt index b77d7c9d7..522d279d6 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoiseOneTimeWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoiseOneTimeWorker.kt @@ -20,13 +20,8 @@ class BackgroundNoiseOneTimeWorker @AssistedInject constructor( private val playbook: Playbook ) : CoroutineWorker(context, workerParams) { - /** - * Work execution - * - * @return Result - */ override suspend fun doWork(): Result { - Timber.d("$id: doWork() started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("$id: doWork() started. Run attempt: $runAttemptCount") var result = Result.success() try { @@ -40,10 +35,14 @@ class BackgroundNoiseOneTimeWorker @AssistedInject constructor( } } - Timber.d("$id: doWork() finished with %s", result) + Timber.tag(TAG).d("$id: doWork() finished with %s", result) return result } @AssistedInject.Factory interface Factory : InjectedWorkerFactory<BackgroundNoiseOneTimeWorker> + + companion object { + private val TAG = BackgroundNoiseOneTimeWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoisePeriodicWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoisePeriodicWorker.kt index 15b175f85..d1111667f 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoisePeriodicWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/BackgroundNoisePeriodicWorker.kt @@ -22,19 +22,11 @@ class BackgroundNoisePeriodicWorker @AssistedInject constructor( @Assisted workerParams: WorkerParameters ) : CoroutineWorker(context, workerParams) { - companion object { - private val TAG: String? = BackgroundNoisePeriodicWorker::class.simpleName - } - /** - * Work execution - * - * @return Result - * * @see BackgroundConstants.NUMBER_OF_DAYS_TO_RUN_PLAYBOOK */ override suspend fun doWork(): Result { - Timber.d("$id: doWork() started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("$id: doWork() started. Run attempt: $runAttemptCount") var result = Result.success() try { @@ -57,15 +49,19 @@ class BackgroundNoisePeriodicWorker @AssistedInject constructor( Result.retry() } } - Timber.d("$id: doWork() finished with %s", result) + Timber.tag(TAG).d("$id: doWork() finished with %s", result) return result } private fun stopWorker() { BackgroundWorkScheduler.WorkType.BACKGROUND_NOISE_PERIODIC_WORK.stop() - Timber.d("$id: worker stopped") + Timber.tag(TAG).d("$id: worker stopped") } @AssistedInject.Factory interface Factory : InjectedWorkerFactory<BackgroundNoisePeriodicWorker> + + companion object { + private val TAG = BackgroundNoisePeriodicWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalOneTimeWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalOneTimeWorker.kt index 5546e8947..23199d027 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalOneTimeWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalOneTimeWorker.kt @@ -24,13 +24,8 @@ class DiagnosisKeyRetrievalOneTimeWorker @AssistedInject constructor( private val taskController: TaskController ) : CoroutineWorker(context, workerParams) { - /** - * Work execution - * - * @return Result - */ override suspend fun doWork(): Result { - Timber.d("$id: doWork() started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("$id: doWork() started. Run attempt: $runAttemptCount") var result = Result.success() taskController.submitBlocking( @@ -40,22 +35,26 @@ class DiagnosisKeyRetrievalOneTimeWorker @AssistedInject constructor( originTag = "DiagnosisKeyRetrievalOneTimeWorker" ) ).error?.also { error: Throwable -> - Timber.w(error, "$id: Error when submitting DownloadDiagnosisKeysTask.") + Timber.tag(TAG).w(error, "$id: Error when submitting DownloadDiagnosisKeysTask.") if (runAttemptCount > BackgroundConstants.WORKER_RETRY_COUNT_THRESHOLD) { - Timber.w(error, "$id: Retry attempts exceeded.") + Timber.tag(TAG).w(error, "$id: Retry attempts exceeded.") return Result.failure() } else { - Timber.d(error, "$id: Retrying.") + Timber.tag(TAG).d(error, "$id: Retrying.") result = Result.retry() } } - Timber.d("$id: doWork() finished with %s", result) + Timber.tag(TAG).d("$id: doWork() finished with %s", result) return result } @AssistedInject.Factory interface Factory : InjectedWorkerFactory<DiagnosisKeyRetrievalOneTimeWorker> + + companion object { + private val TAG = DiagnosisKeyRetrievalOneTimeWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalPeriodicWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalPeriodicWorker.kt index 4bcd5bc8f..adff8651b 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalPeriodicWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisKeyRetrievalPeriodicWorker.kt @@ -21,38 +21,38 @@ class DiagnosisKeyRetrievalPeriodicWorker @AssistedInject constructor( ) : CoroutineWorker(context, workerParams) { /** - * Work execution - * - * @return Result - * * @see BackgroundWorkScheduler.scheduleDiagnosisKeyPeriodicWork() * @see BackgroundWorkScheduler.scheduleDiagnosisKeyOneTimeWork() */ override suspend fun doWork(): Result { - Timber.d("$id: doWork() started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("$id: doWork() started. Run attempt: $runAttemptCount") var result = Result.success() try { BackgroundWorkScheduler.scheduleDiagnosisKeyOneTimeWork() } catch (e: Exception) { - Timber.w( + Timber.tag(TAG).w( e, "$id: Error during BackgroundWorkScheduler.scheduleDiagnosisKeyOneTimeWork()." ) if (runAttemptCount > BackgroundConstants.WORKER_RETRY_COUNT_THRESHOLD) { - Timber.w(e, "$id: Retry attempts exceeded.") + Timber.tag(TAG).w(e, "$id: Retry attempts exceeded.") return Result.failure() } else { - Timber.d(e, "$id: Retrying.") + Timber.tag(TAG).d(e, "$id: Retrying.") result = Result.retry() } } - Timber.d("$id: doWork() finished with %s", result) + Timber.tag(TAG).d("$id: doWork() finished with %s", result) return result } @AssistedInject.Factory interface Factory : InjectedWorkerFactory<DiagnosisKeyRetrievalPeriodicWorker> + + companion object { + private val TAG = DiagnosisKeyRetrievalPeriodicWorker::class.java.simpleName + } } diff --git a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisTestResultRetrievalPeriodicWorker.kt b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisTestResultRetrievalPeriodicWorker.kt index 33eb975e6..8b604d2fe 100644 --- a/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisTestResultRetrievalPeriodicWorker.kt +++ b/Corona-Warn-App/src/main/java/de/rki/coronawarnapp/worker/DiagnosisTestResultRetrievalPeriodicWorker.kt @@ -27,25 +27,20 @@ class DiagnosisTestResultRetrievalPeriodicWorker @AssistedInject constructor( ) : CoroutineWorker(context, workerParams) { /** - * Work execution - * * If background job is running for less than 21 days, testResult is checked. * If the job is running for more than 21 days, the job will be stopped * - * @return Result - * * @see LocalData.isTestResultNotificationSent * @see LocalData.initialPollingForTestResultTimeStamp */ override suspend fun doWork(): Result { - - Timber.d("$id: doWork() started. Run attempt: $runAttemptCount") + Timber.tag(TAG).d("$id: doWork() started. Run attempt: $runAttemptCount") if (runAttemptCount > BackgroundConstants.WORKER_RETRY_COUNT_THRESHOLD) { - Timber.d("$id doWork() failed after $runAttemptCount attempts. Rescheduling") + Timber.tag(TAG).d("$id doWork() failed after $runAttemptCount attempts. Rescheduling") BackgroundWorkScheduler.scheduleDiagnosisKeyPeriodicWork() - Timber.d("$id Rescheduled background worker") + Timber.tag(TAG).d("$id Rescheduled background worker") return Result.failure() } @@ -56,19 +51,19 @@ class DiagnosisTestResultRetrievalPeriodicWorker @AssistedInject constructor( System.currentTimeMillis() ) < BackgroundConstants.POLLING_VALIDITY_MAX_DAYS ) { - Timber.d(" $id maximum days not exceeded") + Timber.tag(TAG).d(" $id maximum days not exceeded") val testResult = SubmissionService.asyncRequestTestResult() initiateNotification(testResult) - Timber.d(" $id Test Result Notification Initiated") + Timber.tag(TAG).d(" $id Test Result Notification Initiated") } else { stopWorker() - Timber.d(" $id worker stopped") + Timber.tag(TAG).d(" $id worker stopped") } } catch (e: Exception) { result = Result.retry() } - Timber.d("$id: doWork() finished with %s", result) + Timber.tag(TAG).d("$id: doWork() finished with %s", result) return result } @@ -86,10 +81,10 @@ class DiagnosisTestResultRetrievalPeriodicWorker @AssistedInject constructor( */ private fun initiateNotification(testResult: TestResult) { if (LocalData.isTestResultNotificationSent() || LocalData.submissionWasSuccessful()) { - Timber.d("$id: Notification already sent or there was a successful submission") + Timber.tag(TAG).d("$id: Notification already sent or there was a successful submission") return } - Timber.d("$id: Test Result retried is $testResult") + Timber.tag(TAG).d("$id: Test Result retried is $testResult") if (testResult == TestResult.NEGATIVE || testResult == TestResult.POSITIVE || testResult == TestResult.INVALID ) { @@ -100,7 +95,7 @@ class DiagnosisTestResultRetrievalPeriodicWorker @AssistedInject constructor( CoronaWarnApplication.getAppContext() .getString(R.string.notification_body) ) - Timber.d("$id: Test Result available and notification is initiated") + Timber.tag(TAG).d("$id: Test Result available and notification is initiated") } LocalData.isTestResultNotificationSent(true) stopWorker() @@ -116,9 +111,13 @@ class DiagnosisTestResultRetrievalPeriodicWorker @AssistedInject constructor( private fun stopWorker() { LocalData.initialPollingForTestResultTimeStamp(0L) BackgroundWorkScheduler.WorkType.DIAGNOSIS_TEST_RESULT_PERIODIC_WORKER.stop() - Timber.d("$id: Background worker stopped") + Timber.tag(TAG).d("$id: Background worker stopped") } @AssistedInject.Factory interface Factory : InjectedWorkerFactory<DiagnosisTestResultRetrievalPeriodicWorker> + + companion object { + private val TAG = DiagnosisTestResultRetrievalPeriodicWorker::class.java.simpleName + } } -- GitLab