Clean up progress DTOs

This commit is contained in:
Davide Depau committed 2019-08-11 19:55:33 +02:00
1 parent 8f9c85d3a5
commit 060bc5dc12
20 files changed
+84 -207

No files matched your search

@@ -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")
@@ -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"
}
}
@@ -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
@@ -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)
}
@@ -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
}
@@ -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)
}
@@ -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<ErrorType>() },
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)
}
}
@@ -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<Int>
) : KotletParcelable {
@Suppress("UNCHECKED_CAST")
constructor(parcel: Parcel) : this(
jobId = parcel.readLong(),
jobType = parcel.readEnum<JobType>()!!,
inputName = parcel.readString()!!,
outputName = parcel.readString()!!,
stepsNamesResIDs = (parcel.readSerializable() as Array<Int>).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)
}
}
@@ -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<RateUnit>() }
)
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) }
}
}
@@ -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
}
@@ -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
}
@@ -1,8 +0,0 @@
package eu.depau.etchdroid.utils.worker.enums
enum class StepType {
STREAM_COPY,
FORMAT_DRIVE,
COPY_FILES,
INSTALL_BOOTLOADER
}
@@ -2,5 +2,4 @@ package eu.depau.etchdroid.utils.worker.impl
import eu.depau.etchdroid.utils.worker.IAsyncWorker
abstract class AbstractAsyncWorker : IAsyncWorker, AbstractProgressSender() {
}
abstract class AbstractAsyncWorker : IAsyncWorker, AbstractProgressSender()
@@ -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
}
}
@@ -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<IProgressListener>()
private val listeners = ArrayList<IWorkerProgressListener>()
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) }
}
@@ -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)
}
)
}
@@ -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)
@@ -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
@@ -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
@@ -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
}