Signal/Android
1
0
Fork 0
mirror of https://github.com/signalapp/Signal-Android.git synced 2026-02-24 03:35:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Prevent certain types of circular job dependencies.

Browse Source
This commit is contained in:
Greyson Parrelli
2023-04-03 14:56:44 -04:00
committed by Alex Hart
parent 2a9576baf5
commit bbdf54097e
4 changed files with 91 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
app/src/main/java/org/thoughtcrime/securesms/jobmanager/persistence/DependencySpec.java
View File

@@ -1,51 +0,0 @@
package org.thoughtcrime.securesms.jobmanager.persistence;
import androidx.annotation.NonNull;
import java.util.Locale;
import java.util.Objects;
public final class DependencySpec {
private final String jobId;
private final String dependsOnJobId;
private final boolean memoryOnly;
public DependencySpec(@NonNull String jobId, @NonNull String dependsOnJobId, boolean memoryOnly) {
this.jobId = jobId;
this.dependsOnJobId = dependsOnJobId;
this.memoryOnly = memoryOnly;
}
public @NonNull String getJobId() {
return jobId;
}
public @NonNull String getDependsOnJobId() {
return dependsOnJobId;
}
public boolean isMemoryOnly() {
return memoryOnly;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
DependencySpec that = (DependencySpec) o;
return Objects.equals(jobId, that.jobId) &&
Objects.equals(dependsOnJobId, that.dependsOnJobId) &&
memoryOnly == that.memoryOnly;
}
@Override
public int hashCode() {
return Objects.hash(jobId, dependsOnJobId, memoryOnly);
}
@Override
public @NonNull String toString() {
return String.format(Locale.US, "jobSpecId: JOB::%s | dependsOnJobSpecId: JOB::%s | memoryOnly: %b", jobId, dependsOnJobId, memoryOnly);
}
}

13
app/src/main/java/org/thoughtcrime/securesms/jobmanager/persistence/DependencySpec.kt Normal file
View File

@@ -0,0 +1,13 @@
package org.thoughtcrime.securesms.jobmanager.persistence
import java.util.Locale
class DependencySpec(
val jobId: String,
val dependsOnJobId: String,
val isMemoryOnly: Boolean
) {
override fun toString(): String {
return String.format(Locale.US, "jobSpecId: JOB::%s | dependsOnJobSpecId: JOB::%s | memoryOnly: %b", jobId, dependsOnJobId, isMemoryOnly)
}
}

32
app/src/main/java/org/thoughtcrime/securesms/jobs/FastJobStorage.kt
View File

@@ -23,7 +23,7 @@ class FastJobStorage(private val jobDatabase: JobDatabase) : JobStorage {
jobConstraints += constraintSpec
}
for (dependencySpec in jobDatabase.allDependencySpecs) {
for (dependencySpec in jobDatabase.allDependencySpecs.filterNot { it.hasCircularDependency() }) {
val jobDependencies: MutableList<DependencySpec> = dependenciesByJobId.getOrPut(dependencySpec.jobId) { mutableListOf() }
jobDependencies += dependencySpec
}
@@ -275,4 +275,34 @@ class FastJobStorage(private val jobDatabase: JobDatabase) : JobStorage {
private fun getJobById(id: String): JobSpec? {
return jobs.firstOrNull { it.id == id }
}
/**
* Note that this is currently only checking a specific kind of circular dependency -- ones that are
* created between dependencies and queues.
*
* More specifically, dependencies where one job depends on another job in the same queue that was
* scheduled *after* it. These dependencies will never resolve. Under normal circumstances these
* won't occur, but *could* occur if the user changed their clock (either purposefully or automatically).
*
* Rather than go through and delete them from the database, removing them from memory at load time
* serves the same effect and doesn't require new write methods. This should also be very rare.
*/
private fun DependencySpec.hasCircularDependency(): Boolean {
val job = getJobById(this.jobId)
val dependsOnJob = getJobById(this.dependsOnJobId)
if (job == null || dependsOnJob == null) {
return false
}
if (job.queueKey == null || dependsOnJob.queueKey == null) {
return false
}
if (job.queueKey != dependsOnJob.queueKey) {
return false
}
return dependsOnJob.createTime > job.createTime
}
}