From 060bc5dc12ebf2e128be51dc5b19b232996c5cc2 Mon Sep 17 00:00:00 2001 From: Davide Depau Date: Sun, 11 Aug 2019 19:55:33 +0200 Subject: [PATCH] Clean up progress DTOs --- .../services/{ => job}/JobService.kt | 4 +- .../job}/ProgressBroadcastForwarder.kt | 42 +++++++++---------- .../{ => job}/dto/JobServiceIntentDTO.kt | 2 +- .../IJobProgressListener.kt} | 19 +++++---- .../etchdroid/utils/worker/IProgressSender.kt | 4 +- ...Listener.kt => IWorkerProgressListener.kt} | 4 +- .../utils/worker/dto/ProgressDoneDTO.kt | 31 -------------- .../utils/worker/dto/ProgressStartDTO.kt | 40 ------------------ .../utils/worker/dto/ProgressUpdateDTO.kt | 24 +++-------- .../etchdroid/utils/worker/enums/ErrorType.kt | 11 ----- .../etchdroid/utils/worker/enums/JobType.kt | 9 ---- .../etchdroid/utils/worker/enums/StepType.kt | 8 ---- .../utils/worker/impl/AbstractAsyncWorker.kt | 3 +- .../impl/AbstractAutoProgressAsyncWorker.kt | 22 ++++++---- .../worker/impl/AbstractProgressSender.kt | 19 +++------ .../Dmg2OutputStreamConvertAsyncService.kt | 15 ++++--- .../Input2OutputStreamCopyAsyncWorker.kt | 5 +-- .../etchdroid/services/JobServiceTest.kt | 3 +- .../etchdroid/testutils/job/MockJobAction.kt | 18 +++----- .../testutils/worker/MockJobWorker.kt | 8 ++-- 20 files changed, 84 insertions(+), 207 deletions(-) rename app/src/main/java/eu/depau/etchdroid/services/{ => job}/JobService.kt (94%) rename app/src/main/java/eu/depau/etchdroid/{workers => services/job}/ProgressBroadcastForwarder.kt (70%) rename app/src/main/java/eu/depau/etchdroid/services/{ => job}/dto/JobServiceIntentDTO.kt (93%) rename app/src/main/java/eu/depau/etchdroid/utils/{worker/IProgressForwarder.kt => job/IJobProgressListener.kt} (69%) rename app/src/main/java/eu/depau/etchdroid/utils/worker/{IProgressListener.kt => IWorkerProgressListener.kt} (80%) delete mode 100644 app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressDoneDTO.kt delete mode 100644 app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressStartDTO.kt delete mode 100644 app/src/main/java/eu/depau/etchdroid/utils/worker/enums/ErrorType.kt delete mode 100644 app/src/main/java/eu/depau/etchdroid/utils/worker/enums/JobType.kt delete mode 100644 app/src/main/java/eu/depau/etchdroid/utils/worker/enums/StepType.kt diff --git a/app/src/main/java/eu/depau/etchdroid/services/JobService.kt b/app/src/main/java/eu/depau/etchdroid/services/job/JobService.kt similarity index 94% rename from app/src/main/java/eu/depau/etchdroid/services/JobService.kt rename to app/src/main/java/eu/depau/etchdroid/services/job/JobService.kt index de93888..e7babe2 100644 --- a/app/src/main/java/eu/depau/etchdroid/services/JobService.kt +++ b/app/src/main/java/eu/depau/etchdroid/services/job/JobService.kt @@ -1,10 +1,10 @@ -package eu.depau.etchdroid.services +package eu.depau.etchdroid.services.job import android.app.IntentService import android.content.Intent import eu.depau.etchdroid.db.EtchDroidDatabase import eu.depau.etchdroid.notification.impl.JobServiceNotificationHandler -import eu.depau.etchdroid.services.dto.JobServiceIntentDTO +import eu.depau.etchdroid.services.job.dto.JobServiceIntentDTO open class JobService(name: String) : IntentService(name) { constructor() : this("TestJobService") diff --git a/app/src/main/java/eu/depau/etchdroid/workers/ProgressBroadcastForwarder.kt b/app/src/main/java/eu/depau/etchdroid/services/job/ProgressBroadcastForwarder.kt similarity index 70% rename from app/src/main/java/eu/depau/etchdroid/workers/ProgressBroadcastForwarder.kt rename to app/src/main/java/eu/depau/etchdroid/services/job/ProgressBroadcastForwarder.kt index 31e2bb5..9f69658 100644 --- a/app/src/main/java/eu/depau/etchdroid/workers/ProgressBroadcastForwarder.kt +++ b/app/src/main/java/eu/depau/etchdroid/services/job/ProgressBroadcastForwarder.kt @@ -1,15 +1,12 @@ -package eu.depau.etchdroid.workers +package eu.depau.etchdroid.services.job import android.content.Context import android.util.Log import eu.depau.etchdroid.db.EtchDroidDatabase -import eu.depau.etchdroid.utils.worker.IProgressForwarder -import eu.depau.etchdroid.utils.worker.IProgressListener +import eu.depau.etchdroid.utils.job.IJobProgressListener +import eu.depau.etchdroid.utils.worker.IWorkerProgressListener import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO - -const val TAG = ".w.ProgBcastFwd" - // TODO: implement class stubs /** @@ -18,7 +15,7 @@ const val TAG = ".w.ProgBcastFwd" * * It tracks */ -class ProgressBroadcastForwarder(private val context: Context) : IProgressListener, IProgressForwarder { +class ProgressBroadcastForwarder(private val context: Context) : IJobProgressListener, IWorkerProgressListener { var jobId: Long = -1 @@ -32,15 +29,16 @@ class ProgressBroadcastForwarder(private val context: Context) : IProgressListen private fun assertProcedureStarted() { if (currentActionIdx == null || prevActionsProgressWeight == null) { - throw IllegalStateException("Call to a .notify*() method without a call to .notifyProcedureStart()") + throw IllegalStateException("Call to a .on*() method without a call to .onProcedureStart()") } } + /** * Called by the worker service to notify the forwarder that the currently referenced procedure * is starting. */ - override fun notifyProcedureStart(startActionIndex: Int) { + override fun onProcedureStart(startActionIndex: Int) { currentActionIdx = startActionIndex prevActionsProgressWeight = jobEntity.jobProcedure .subList(0, currentActionIdx!!) @@ -53,20 +51,20 @@ class ProgressBroadcastForwarder(private val context: Context) : IProgressListen * Called by the worker service to notify the forwarder that the currently referenced procedure * has finished successfully. */ - override fun notifyProcedureDone() { + override fun onProcedureDone() { assertProcedureStarted() // TODO: stub - Log.d(TAG, "notifyProcedureDone job $jobId ACTION $currentActionIdx") + Log.d(TAG, "onProcedureDone job $jobId ACTION $currentActionIdx") } /** * Called by the worker service to notify the forwarder that the currently referenced procedure * has failed with the provided exception. */ - override fun notifyProcedureError(error: Exception) { + override fun onProcedureError(error: Exception) { assertProcedureStarted() // TODO: stub - Log.d(TAG, "notifyProcedureError job $jobId ACTION $currentActionIdx", error) + Log.d(TAG, "onProcedureError job $jobId ACTION $currentActionIdx", error) } /** @@ -75,10 +73,10 @@ class ProgressBroadcastForwarder(private val context: Context) : IProgressListen * * @param dto a ProgressUpdateDTO describing the current status of the worker */ - override fun notifyActionProgress(dto: ProgressUpdateDTO) { + override fun onWorkerProgress(dto: ProgressUpdateDTO) { assertProcedureStarted() // TODO: stub - Log.d(TAG, "notifyActionProgress job $jobId ACTION $currentActionIdx dto $dto") + Log.d(TAG, "onWorkerProgress job $jobId ACTION $currentActionIdx dto $dto") } /** @@ -86,26 +84,28 @@ class ProgressBroadcastForwarder(private val context: Context) : IProgressListen * * @param actionIndex the current ACTION index within the JobProcedure */ - override fun notifyActionStart(actionIndex: Int) { + override fun onActionStart(actionIndex: Int) { assertProcedureStarted() currentActionIdx = actionIndex prevActionsProgressWeight = prevActionsProgressWeight!!.plus(jobEntity.jobProcedure[actionIndex].progressWeight) // TODO: stub - Log.d(TAG, "notifyActionStart job $jobId ACTION $currentActionIdx") + Log.d(TAG, "onActionStart job $jobId ACTION $currentActionIdx") } /** * Called by the worker service to notify the forwarder that the current ACTION has finished * running. Whether it has finished successfully or not is unspecified. * - * If it failed, a call to notifyProcedureError will follow with an Exception reference. + * If it failed, a call to onProcedureError will follow with an Exception reference. */ - override fun notifyActionDone() { + override fun onActionDone() { assertProcedureStarted() // TODO: stub - Log.d(TAG, "notifyActionDone job $jobId ACTION $currentActionIdx") + Log.d(TAG, "onActionDone job $jobId ACTION $currentActionIdx") } - + companion object { + const val TAG = ".w.ProgBcastFwd" + } } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/services/dto/JobServiceIntentDTO.kt b/app/src/main/java/eu/depau/etchdroid/services/job/dto/JobServiceIntentDTO.kt similarity index 93% rename from app/src/main/java/eu/depau/etchdroid/services/dto/JobServiceIntentDTO.kt rename to app/src/main/java/eu/depau/etchdroid/services/job/dto/JobServiceIntentDTO.kt index 5eea75e..04a7fbe 100644 --- a/app/src/main/java/eu/depau/etchdroid/services/dto/JobServiceIntentDTO.kt +++ b/app/src/main/java/eu/depau/etchdroid/services/job/dto/JobServiceIntentDTO.kt @@ -1,4 +1,4 @@ -package eu.depau.etchdroid.services.dto +package eu.depau.etchdroid.services.job.dto import android.os.Parcel import eu.depau.kotlet.android.parcelable.KotletParcelable diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressForwarder.kt b/app/src/main/java/eu/depau/etchdroid/utils/job/IJobProgressListener.kt similarity index 69% rename from app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressForwarder.kt rename to app/src/main/java/eu/depau/etchdroid/utils/job/IJobProgressListener.kt index 534ad6c..690bcf5 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressForwarder.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/job/IJobProgressListener.kt @@ -1,20 +1,23 @@ -package eu.depau.etchdroid.utils.worker +package eu.depau.etchdroid.utils.job -interface IProgressForwarder { +/** + * Base interface for a class that listens to progress events from a JobService + */ +interface IJobProgressListener { /** * Called by the worker service to update the forwarder on the current ACTION index. * * @param actionIndex the current ACTION index within the JobProcedure */ - fun notifyActionStart(actionIndex: Int) + fun onActionStart(actionIndex: Int) /** * Called by the worker service to notify the forwarder that the current ACTION has finished * running. Whether it has finished successfully or not is unspecified. * - * If it failed, a call to notifyProcedureError will follow with an Exception reference. + * If it failed, a call to onProcedureError will follow with an Exception reference. */ - fun notifyActionDone() + fun onActionDone() /** * Called by the worker service to notify the forwarder that the currently referenced procedure @@ -23,17 +26,17 @@ interface IProgressForwarder { * @param startActionIndex the ACTION index the procedure is starting with (which is > 0 if it's * being bootstrapped from a checkpoint) */ - fun notifyProcedureStart(startActionIndex: Int = 0) + fun onProcedureStart(startActionIndex: Int = 0) /** * Called by the worker service to notify the forwarder that the currently referenced procedure * has finished successfully. */ - fun notifyProcedureDone() + fun onProcedureDone() /** * Called by the worker service to notify the forwarder that the currently referenced procedure * has failed with the provided exception. */ - fun notifyProcedureError(error: java.lang.Exception) + fun onProcedureError(error: java.lang.Exception) } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressSender.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressSender.kt index 736c53f..cd7dbb9 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressSender.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressSender.kt @@ -1,6 +1,6 @@ package eu.depau.etchdroid.utils.worker interface IProgressSender { - fun attachProgressListener(listener: IProgressListener): Boolean - fun detachProgressListener(listener: IProgressListener): Boolean + fun attachProgressListener(listener: IWorkerProgressListener): Boolean + fun detachProgressListener(listener: IWorkerProgressListener): Boolean } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressListener.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/IWorkerProgressListener.kt similarity index 80% rename from app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressListener.kt rename to app/src/main/java/eu/depau/etchdroid/utils/worker/IWorkerProgressListener.kt index 0f25595..f578f74 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/IProgressListener.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/IWorkerProgressListener.kt @@ -2,12 +2,12 @@ package eu.depau.etchdroid.utils.worker import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO -interface IProgressListener { +interface IWorkerProgressListener { /** * Called by the current worker to update the progress listener on its status relative to * the current JobAction that describes its task. * * @param dto a ProgressUpdateDTO describing the current status of the worker */ - fun notifyActionProgress(dto: ProgressUpdateDTO) + fun onWorkerProgress(dto: ProgressUpdateDTO) } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressDoneDTO.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressDoneDTO.kt deleted file mode 100644 index 0b1a46a..0000000 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressDoneDTO.kt +++ /dev/null @@ -1,31 +0,0 @@ -package eu.depau.etchdroid.utils.worker.dto - -import android.os.Parcel -import android.os.Parcelable -import eu.depau.etchdroid.utils.worker.enums.ErrorType -import eu.depau.kotlet.android.parcelable.* - -data class ProgressDoneDTO( - val jobId: Long, - val error: ErrorType?, - val errorData: Parcelable? -) : KotletParcelable { - constructor(parcel: Parcel) : this( - jobId = parcel.readLong(), - error = parcel.readNullable { parcel.readEnum() }, - errorData = parcel.readNullable { parcel.readParcelable(Parcelable::class.java.classLoader) as Parcelable? } - ) - - override fun writeToParcel(parcel: Parcel, flags: Int) { - parcel.apply { - writeLong(jobId) - writeNullable(error) { writeEnum(it) } - writeNullable(errorData) { writeParcelable(errorData, flags) } - } - } - - companion object { - @JvmField - val CREATOR = parcelableCreator(::ProgressDoneDTO) - } -} \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressStartDTO.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressStartDTO.kt deleted file mode 100644 index 0ce983c..0000000 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressStartDTO.kt +++ /dev/null @@ -1,40 +0,0 @@ -package eu.depau.etchdroid.utils.worker.dto - -import android.os.Parcel -import eu.depau.etchdroid.utils.worker.enums.JobType -import eu.depau.kotlet.android.parcelable.KotletParcelable -import eu.depau.kotlet.android.parcelable.parcelableCreator -import eu.depau.kotlet.android.parcelable.readEnum -import eu.depau.kotlet.android.parcelable.writeEnum - -data class ProgressStartDTO( - val jobId: Long, - val jobType: JobType, - val inputName: String, - val outputName: String, - val stepsNamesResIDs: List -) : KotletParcelable { - @Suppress("UNCHECKED_CAST") - constructor(parcel: Parcel) : this( - jobId = parcel.readLong(), - jobType = parcel.readEnum()!!, - inputName = parcel.readString()!!, - outputName = parcel.readString()!!, - stepsNamesResIDs = (parcel.readSerializable() as Array).asList() - ) - - override fun writeToParcel(parcel: Parcel, flags: Int) { - parcel.apply { - writeLong(jobId) - writeEnum(jobType) - writeString(inputName) - writeString(outputName) - writeSerializable(stepsNamesResIDs.toTypedArray()) - } - } - - companion object { - @JvmField - val CREATOR = parcelableCreator(::ProgressStartDTO) - } -} \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressUpdateDTO.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressUpdateDTO.kt index 429cbb1..b7f1142 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressUpdateDTO.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/dto/ProgressUpdateDTO.kt @@ -5,32 +5,20 @@ import eu.depau.etchdroid.utils.worker.enums.RateUnit import eu.depau.kotlet.android.parcelable.* data class ProgressUpdateDTO( - val jobId: Long, - val currentStep: Int, - val jobProgress: Double, - val stepProgress: Double?, - val timeRemaining: Long?, - val currentRate: Double?, + val progress: Double?, + val rate: Double?, val rateUnit: RateUnit? ) : KotletParcelable { constructor(parcel: Parcel) : this( - jobId = parcel.readLong(), - currentStep = parcel.readInt(), - jobProgress = parcel.readDouble(), - stepProgress = parcel.readNullable { parcel.readDouble() }, - timeRemaining = parcel.readNullable { parcel.readLong() }, - currentRate = parcel.readNullable { parcel.readDouble() }, + progress = parcel.readNullable { parcel.readDouble() }, + rate = parcel.readNullable { parcel.readDouble() }, rateUnit = parcel.readNullable { parcel.readEnum() } ) override fun writeToParcel(parcel: Parcel, flags: Int) { parcel.apply { - writeLong(jobId) - writeInt(currentStep) - writeDouble(jobProgress) - writeNullable(stepProgress) { writeDouble(it) } - writeNullable(timeRemaining) { writeLong(it) } - writeNullable(currentRate) { writeDouble(it) } + writeNullable(progress) { writeDouble(it) } + writeNullable(rate) { writeDouble(it) } writeNullable(rateUnit) { writeEnum(rateUnit) } } } diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/ErrorType.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/ErrorType.kt deleted file mode 100644 index 3871bee..0000000 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/ErrorType.kt +++ /dev/null @@ -1,11 +0,0 @@ -package eu.depau.etchdroid.utils.worker.enums - -enum class ErrorType { - UNPLUGGED, - INPUT_FORMAT_ERROR, - ENOSPC_ON_USB, - ENOSPC_ON_DEVICE, - PERMISSION_DENIED_ANDROID, - PERMISSION_DENIED_FS, - PERMISSION_DENIED_USB -} \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/JobType.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/JobType.kt deleted file mode 100644 index 7ce6b3b..0000000 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/JobType.kt +++ /dev/null @@ -1,9 +0,0 @@ -package eu.depau.etchdroid.utils.worker.enums - -enum class JobType { - FLASH_RAW_IMAGE, - FLASH_DMG, - FLASH_ELTORITO, - DUMP_RAW_IMAGE, - CREATE_WINDOWS_INSTALLER -} \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/StepType.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/StepType.kt deleted file mode 100644 index d658c10..0000000 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/enums/StepType.kt +++ /dev/null @@ -1,8 +0,0 @@ -package eu.depau.etchdroid.utils.worker.enums - -enum class StepType { - STREAM_COPY, - FORMAT_DRIVE, - COPY_FILES, - INSTALL_BOOTLOADER -} \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAsyncWorker.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAsyncWorker.kt index 026618c..a0423fc 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAsyncWorker.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAsyncWorker.kt @@ -2,5 +2,4 @@ package eu.depau.etchdroid.utils.worker.impl import eu.depau.etchdroid.utils.worker.IAsyncWorker -abstract class AbstractAsyncWorker : IAsyncWorker, AbstractProgressSender() { -} \ No newline at end of file +abstract class AbstractAsyncWorker : IAsyncWorker, AbstractProgressSender() \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAutoProgressAsyncWorker.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAutoProgressAsyncWorker.kt index 1b19429..a69865a 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAutoProgressAsyncWorker.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractAutoProgressAsyncWorker.kt @@ -1,11 +1,13 @@ package eu.depau.etchdroid.utils.worker.impl import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO +import eu.depau.etchdroid.utils.worker.enums.RateUnit -const val UPDATE_INTERVAL = 500 -abstract class AbstractAutoProgressAsyncWorker(private val totalToDo: Long) : AbstractAsyncWorker() { - abstract val progressUpdateDTO: ProgressUpdateDTO +abstract class AbstractAutoProgressAsyncWorker( + private val totalToDo: Long, + private val rateUnit: RateUnit +) : AbstractAsyncWorker() { private var doneAccumulator = 0L private var doneSinceLastUpdate = 0L @@ -23,13 +25,11 @@ abstract class AbstractAutoProgressAsyncWorker(private val totalToDo: Long) : Ab if (currentTime > lastUpdateTime + UPDATE_INTERVAL) { val progress = doneAccumulator.toDouble() / totalToDo val speedUnitPerMillis = doneSinceLastUpdate.toDouble() / (currentTime - lastUpdateTime) - val timeRemainingMillis: Long = ((totalToDo - doneAccumulator) / speedUnitPerMillis).toLong() - val dto = progressUpdateDTO.copy( - jobProgress = progress, - stepProgress = progress, - timeRemaining = timeRemainingMillis, - currentRate = speedUnitPerMillis * 1000 + val dto = ProgressUpdateDTO( + progress = progress, + rate = speedUnitPerMillis * 1000, + rateUnit = rateUnit ) notifyProgress(dto) @@ -38,4 +38,8 @@ abstract class AbstractAutoProgressAsyncWorker(private val totalToDo: Long) : Ab lastUpdateTime = currentTime } } + + companion object { + const val UPDATE_INTERVAL = 500 + } } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractProgressSender.kt b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractProgressSender.kt index 9b4bc5e..f012aea 100644 --- a/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractProgressSender.kt +++ b/app/src/main/java/eu/depau/etchdroid/utils/worker/impl/AbstractProgressSender.kt @@ -1,28 +1,19 @@ package eu.depau.etchdroid.utils.worker.impl -import eu.depau.etchdroid.utils.worker.IProgressListener import eu.depau.etchdroid.utils.worker.IProgressSender -import eu.depau.etchdroid.utils.worker.dto.ProgressDoneDTO -import eu.depau.etchdroid.utils.worker.dto.ProgressStartDTO +import eu.depau.etchdroid.utils.worker.IWorkerProgressListener import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO abstract class AbstractProgressSender : IProgressSender { - private val listeners = ArrayList() + private val listeners = ArrayList() - override fun attachProgressListener(listener: IProgressListener) = + override fun attachProgressListener(listener: IWorkerProgressListener) = listeners.add(listener) - override fun detachProgressListener(listener: IProgressListener) = + override fun detachProgressListener(listener: IWorkerProgressListener) = listeners.remove(listener) - // TODO: fix -// protected fun notifyStart(dto: ProgressStartDTO) = -// listeners.forEach { it.notifyActionStart() } - protected fun notifyProgress(dto: ProgressUpdateDTO) = - listeners.forEach { it.notifyActionProgress(dto) } - -// protected fun notifyDone(dto: ProgressDoneDTO) = -// listeners.forEach { it.notifyActionDone() } + listeners.forEach { it.onWorkerProgress(dto) } } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/workers/Dmg2OutputStreamConvertAsyncService.kt b/app/src/main/java/eu/depau/etchdroid/workers/Dmg2OutputStreamConvertAsyncService.kt index 7473e5e..db9df80 100644 --- a/app/src/main/java/eu/depau/etchdroid/workers/Dmg2OutputStreamConvertAsyncService.kt +++ b/app/src/main/java/eu/depau/etchdroid/workers/Dmg2OutputStreamConvertAsyncService.kt @@ -3,7 +3,6 @@ package eu.depau.etchdroid.workers import android.content.Context import android.net.Uri import eu.depau.etchdroid.utils.imagetypes.DMGImage -import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO import java.io.OutputStream @@ -11,14 +10,14 @@ class Dmg2OutputStreamConvertAsyncService private constructor( private val i2oStreamWorker: Input2OutputStreamCopyAsyncWorker ) : IMergedAsyncWorkerProgressSender by i2oStreamWorker { - constructor(context: Context, - sourceDmgUri: Uri, - dest: OutputStream, - chunkSize: Int, - progressUpdateDTO: ProgressUpdateDTO) : this( + constructor( + context: Context, + sourceDmgUri: Uri, + dest: OutputStream, + chunkSize: Int + ) : this( DMGImage.getRawImageInputStream(context, sourceDmgUri).let { - Input2OutputStreamCopyAsyncWorker(it, dest, chunkSize, progressUpdateDTO, it.size) + Input2OutputStreamCopyAsyncWorker(it, dest, chunkSize, it.size) } ) - } \ No newline at end of file diff --git a/app/src/main/java/eu/depau/etchdroid/workers/Input2OutputStreamCopyAsyncWorker.kt b/app/src/main/java/eu/depau/etchdroid/workers/Input2OutputStreamCopyAsyncWorker.kt index e8b10ec..9feef19 100644 --- a/app/src/main/java/eu/depau/etchdroid/workers/Input2OutputStreamCopyAsyncWorker.kt +++ b/app/src/main/java/eu/depau/etchdroid/workers/Input2OutputStreamCopyAsyncWorker.kt @@ -1,6 +1,6 @@ package eu.depau.etchdroid.workers -import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO +import eu.depau.etchdroid.utils.worker.enums.RateUnit import eu.depau.etchdroid.utils.worker.impl.AbstractAutoProgressAsyncWorker import java.io.InputStream import java.io.OutputStream @@ -10,9 +10,8 @@ open class Input2OutputStreamCopyAsyncWorker( private val source: InputStream, private val dest: OutputStream, chunkSize: Int, - override val progressUpdateDTO: ProgressUpdateDTO, size: Long -) : IMergedAsyncWorkerProgressSender, AbstractAutoProgressAsyncWorker(size) { +) : IMergedAsyncWorkerProgressSender, AbstractAutoProgressAsyncWorker(size, RateUnit.BYTES_PER_SECOND) { private val buffer = ByteArray(chunkSize) diff --git a/app/src/test/java/eu/depau/etchdroid/services/JobServiceTest.kt b/app/src/test/java/eu/depau/etchdroid/services/JobServiceTest.kt index a2338af..0daa5b8 100644 --- a/app/src/test/java/eu/depau/etchdroid/services/JobServiceTest.kt +++ b/app/src/test/java/eu/depau/etchdroid/services/JobServiceTest.kt @@ -7,7 +7,8 @@ import eu.depau.etchdroid.AppBuildConfig import eu.depau.etchdroid.db.EtchDroidDatabase import eu.depau.etchdroid.db.entity.Job import eu.depau.etchdroid.db.repository.JobRepository -import eu.depau.etchdroid.services.dto.JobServiceIntentDTO +import eu.depau.etchdroid.services.job.JobService +import eu.depau.etchdroid.services.job.dto.JobServiceIntentDTO import eu.depau.etchdroid.testutils.job.MockJobAction import eu.depau.etchdroid.testutils.worker.MockJobWorker import eu.depau.etchdroid.utils.job.impl.JobProcedure diff --git a/app/src/test/java/eu/depau/etchdroid/testutils/job/MockJobAction.kt b/app/src/test/java/eu/depau/etchdroid/testutils/job/MockJobAction.kt index 7b455cc..7b4a1a5 100644 --- a/app/src/test/java/eu/depau/etchdroid/testutils/job/MockJobAction.kt +++ b/app/src/test/java/eu/depau/etchdroid/testutils/job/MockJobAction.kt @@ -5,8 +5,6 @@ import eu.depau.etchdroid.testutils.worker.MockJobWorker import eu.depau.etchdroid.utils.StringResBuilder import eu.depau.etchdroid.utils.job.IJobAction import eu.depau.etchdroid.utils.worker.IAsyncWorker -import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO -import eu.depau.etchdroid.utils.worker.enums.RateUnit import eu.depau.kotlet.android.parcelable.KotletParcelable import eu.depau.kotlet.android.parcelable.parcelableCreator import org.mockito.Mockito @@ -22,19 +20,13 @@ class MockJobAction( ) private val lazyWorker by lazy { - Mockito.spy( - MockJobWorker( - // TODO: fix update dto so it doesn't have excess fields - ProgressUpdateDTO( - -1, 0, 0.0, - 0.0, 0, 0.0, - RateUnit.FURLONGS_PER_FORTNIGHT - ) - ) - ) + Mockito.spy(MockJobWorker()) } - override fun getWorker(): IAsyncWorker = lazyWorker + override fun getWorker(): IAsyncWorker { + println("Retrieved worker for Action with nameResId $nameResId") + return lazyWorker + } /** * Check action preconditions and return a list of StringResBuilders, which will then be diff --git a/app/src/test/java/eu/depau/etchdroid/testutils/worker/MockJobWorker.kt b/app/src/test/java/eu/depau/etchdroid/testutils/worker/MockJobWorker.kt index 92830d3..24969e6 100644 --- a/app/src/test/java/eu/depau/etchdroid/testutils/worker/MockJobWorker.kt +++ b/app/src/test/java/eu/depau/etchdroid/testutils/worker/MockJobWorker.kt @@ -1,13 +1,12 @@ package eu.depau.etchdroid.testutils.worker -import eu.depau.etchdroid.utils.worker.dto.ProgressUpdateDTO +import eu.depau.etchdroid.utils.worker.enums.RateUnit import eu.depau.etchdroid.utils.worker.impl.AbstractAutoProgressAsyncWorker -import eu.depau.etchdroid.utils.worker.impl.UPDATE_INTERVAL -open class MockJobWorker(override val progressUpdateDTO: ProgressUpdateDTO) : AbstractAutoProgressAsyncWorker(10) { +open class MockJobWorker : AbstractAutoProgressAsyncWorker(10, RateUnit.FURLONGS_PER_FORTNIGHT) { var counter = 0 val steps = 10 - val sleepTime = (UPDATE_INTERVAL * 2.2 / steps).toLong() + private val sleepTime = (UPDATE_INTERVAL * 2.2 / steps).toLong() /** * Make the worker do one step. Returns whether there are more steps to do @@ -16,6 +15,7 @@ open class MockJobWorker(override val progressUpdateDTO: ProgressUpdateDTO) : Ab */ override fun runStep(): Boolean { counter++ + println("Worker counts $counter/$steps") Thread.sleep(sleepTime) return counter < steps }