Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Clean up download optimizations #6841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 8, 2025
Merged

Clean up download optimizations #6841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
442e585
Remove risky optimization
seadowg Aug 6, 2025
ad83983
Rework benchmarks
seadowg Aug 6, 2025
189e087
Fix benchmark URL setup
seadowg Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions collect_app/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ def getVersionName = { ->
def secrets = getSecrets()
def googleMapsApiKey = secrets.getProperty('GOOGLE_MAPS_API_KEY', '')
def mapboxAccessToken = secrets.getProperty('MAPBOX_ACCESS_TOKEN', '')
def entitiesFilterProjectUrl = secrets.getProperty('ENTITIES_FILTER_TEST_PROJECT_URL', '')
def entitiesFilterSearchProjectUrl = secrets.getProperty('ENTITIES_FILTER_SEARCH_TEST_PROJECT_URL', '')
def entitiesFilterProjectUrl = secrets.getProperty('ENTITIES_FILTER_PROJECT_URL', '')
def entitiesFilterSearchProjectUrl = secrets.getProperty('ENTITIES_FILTER_SEARCH_PROJECT_URL', '')
def thousandMediaFileProjectUrl = secrets.getProperty('THOUSAND_MEDIA_FILE_PROJECT_URL', '')
def thousandMediaFileEntityListProjectUrl = secrets.getProperty('THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL', '')

Expand Down
66 changes: 54 additions & 12 deletions collect_app/src/androidTest/java/org/odk/collect/android/benchmark/EntitiesBenchmarkTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,9 @@ import org.odk.collect.android.support.pages.MainMenuPage
import org.odk.collect.android.support.rules.CollectTestRule
import org.odk.collect.android.support.rules.TestRuleChain.chain
import org.odk.collect.android.test.BuildConfig.ENTITIES_FILTER_PROJECT_URL
import org.odk.collect.android.test.BuildConfig.THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL
import org.odk.collect.strings.R

/**
* Benchmarks the performance of entity follow up forms. [ENTITIES_FILTER_PROJECT_URL] should
* be set to a project that contains the "100k Entities Filter" benchmark form and the
* "entities_100k" entity list.
*
* Devices that currently pass:
* - Fairphone 3
* - Pixel 3
*
*/

@RunWith(AndroidJUnit4::class)
class EntitiesBenchmarkTest {

Expand All @@ -39,8 +29,18 @@ class EntitiesBenchmarkTest {
@get:Rule
var chain: RuleChain = chain(TestDependencies(true)).around(rule)

/**
* Benchmarks the performance of entity follow up forms. [ENTITIES_FILTER_PROJECT_URL] should
* be set to a project that contains the "100k Entities Filter" benchmark form and the
* "entities_100k" entity list.
*
* Devices that currently pass:
* - Fairphone 3
* - Pixel 3
*
*/
@Test
fun run() {
fun oneHundredThousandEntities() {
assertThat(
"Need to set ENTITIES_FILTER_PROJECT_URL before running!",
ENTITIES_FILTER_PROJECT_URL,
Expand Down Expand Up @@ -98,6 +98,48 @@ class EntitiesBenchmarkTest {

benchmarker.assertResults()
}

/**
* Benchmarks the performance of updating forms with entity lists and many media files.
* [THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL] should be set to a project that contains the
* "1000-media-files-entity-list" form.
*
* Devices that currently pass:
* - Fairphone 3
*/
@Test
fun oneThousandMediaFilesWithEntityList() {
assertThat(
"Need to set THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL before running!",
THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL,
not(blankOrNullString())
)

val benchmarker = Benchmarker()

rule.startAtFirstLaunch()
.clickManuallyEnterProjectDetails()
.inputUrl(THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL)
.addProject()

// Download all forms
.clickGetBlankForm()
.clickGetSelected()
.clickOKOnDialog(MainMenuPage())

.clickGetBlankForm()
.benchmark(
"Redownloading a form with 1k media files and entity list when there are no updates",
15,
benchmarker
) {
it
.clickGetSelected()
.clickOKOnDialog(MainMenuPage())
}

benchmarker.assertResults()
}
}

private fun clearAndroidCache() {
Expand Down
55 changes: 1 addition & 54 deletions ...ct_app/src/androidTest/java/org/odk/collect/android/benchmark/FormsUpdateBenchmarkTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ import org.junit.Rule
import org.junit.Test
import org.junit.rules.RuleChain
import org.junit.runner.RunWith
import org.odk.collect.android.application.FeatureFlags
import org.odk.collect.android.benchmark.support.Benchmarker
import org.odk.collect.android.benchmark.support.benchmark
import org.odk.collect.android.support.TestDependencies
import org.odk.collect.android.support.pages.MainMenuPage
import org.odk.collect.android.support.rules.CollectTestRule
import org.odk.collect.android.support.rules.TestRuleChain.chain
import org.odk.collect.android.test.BuildConfig.THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL
import org.odk.collect.android.test.BuildConfig.THOUSAND_MEDIA_FILE_PROJECT_URL

@RunWith(AndroidJUnit4::class)
Expand All @@ -26,7 +24,7 @@ class FormsUpdateBenchmarkTest {
val chain: RuleChain = chain(TestDependencies(true)).around(rule)

/**
* Benchmarks the performance of updating forms. [THOUSAND_MEDIA_FILE_PROJECT_URL] should
* Benchmarks the performance of check for updates. [THOUSAND_MEDIA_FILE_PROJECT_URL] should
* be set to a project that contains the "1000-media-files" benchmark form.
*
* Devices that currently pass:
Expand Down Expand Up @@ -62,57 +60,6 @@ class FormsUpdateBenchmarkTest {
.clickSelectAll()
}

.benchmark(
"Redownloading a form with 1k media files when there are no updates",
12,
benchmarker
) {
it
.clickGetSelected()
.clickOKOnDialog(MainMenuPage())
}

benchmarker.assertResults()
}

/**
* Benchmarks the performance of updating forms. [THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL] should
* be set to a project that contains the "1000-media-files-entity-list" form.
*
* Devices that currently pass:
* - Fairphone 3
*/
@Test
fun oneThousandMediaFilesWithEntityList() {
assertThat(
"Need to set THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL before running!",
THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL,
not(blankOrNullString())
)

val benchmarker = Benchmarker()

rule.startAtFirstLaunch()
.clickManuallyEnterProjectDetails()
.inputUrl(THOUSAND_MEDIA_FILE_ENTITY_LIST_PROJECT_URL)
.addProject()

// Download all forms
.clickGetBlankForm()
.clickGetSelected()
.clickOKOnDialog(MainMenuPage())

.clickGetBlankForm()
.benchmark(
"Redownloading a form with 1k media files and entity list when there are no updates",
if (FeatureFlags.FASTER_FORM_UPDATES) 5 else 15,
benchmarker
) {
it
.clickGetSelected()
.clickOKOnDialog(MainMenuPage())
}

benchmarker.assertResults()
}
}
1 change: 0 additions & 1 deletion collect_app/src/main/java/org/odk/collect/android/application/FeatureFlags.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ package org.odk.collect.android.application
object FeatureFlags {

const val NO_THEME_SETTING = true
const val FASTER_FORM_UPDATES = false
const val FOREGROUND_SERVICE_UPDATES = true
}
5 changes: 2 additions & 3 deletions collect_app/src/main/java/org/odk/collect/android/formmanagement/ServerFormDetails.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,10 @@ data class ServerFormDetails @JvmOverloads constructor(
val hash: String?,
val isNotOnDevice: Boolean,
val isUpdated: Boolean,
val manifest: ManifestFile?,
val mediaOnlyUpdate: Boolean = false
val manifest: ManifestFile?
) : Serializable {

companion object {
private const val serialVersionUID = 2L
private const val serialVersionUID = 3L
}
}
4 changes: 1 addition & 3 deletions collect_app/src/main/java/org/odk/collect/android/formmanagement/ServerFormUseCases.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,7 @@ object ServerFormUseCases {
val existingFileHash = existingFile.getMd5Hash()

if (existingFileHash.contentEquals(mediaFile.hash)) {
if (!formToDownload.mediaOnlyUpdate) {
copyFileToDirectory(existingFile, tempMediaDir)
}
copyFileToDirectory(existingFile, tempMediaDir)
} else {
downloadMediaFile(
formSource,
Expand Down
4 changes: 1 addition & 3 deletions ...ect_app/src/main/java/org/odk/collect/android/formmanagement/ServerFormsDetailsFetcher.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/
package org.odk.collect.android.formmanagement

import org.odk.collect.android.application.FeatureFlags
import org.odk.collect.android.utilities.FormUtils
import org.odk.collect.android.utilities.WebCredentialsUtils
import org.odk.collect.forms.Form
Expand Down Expand Up @@ -85,8 +84,7 @@ open class ServerFormsDetailsFetcher(
listItem.hash,
!thisFormAlreadyDownloaded,
isNewerFormVersionAvailable || areNewerMediaFilesAvailable,
manifestFile,
FeatureFlags.FASTER_FORM_UPDATES && (!isNewerFormVersionAvailable && areNewerMediaFilesAvailable)
manifestFile
)
}
}
Expand Down