Sitelet https://github.com/flutter/flutter/pull/168248/files
Skip to content

Check for duplicate archive paths in the engine build configuration JSON files #168248

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
auto-submit merged 2 commits into from
May 5, 2025
Merged

Check for duplicate archive paths in the engine build configuration JSON files #168248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e21bf0
Check for duplicate archive paths in the engine build configuration J…
jason-simmons May 2, 2025
a2d97e2
analyzer
jason-simmons May 5, 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
28 changes: 28 additions & 0 deletions engine/src/flutter/tools/pkg/engine_build_configs/bin/check.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ void run(
statusPrint('All build names must have a conforming prefix', success: buildNameErrors.isEmpty);
indentedPrint(buildNameErrors);

// Check for duplicate archive paths in order to prevent builders from
// overwriting each other's artifacts in cloud storage.
final List<String> duplicateArchives = checkForDuplicateArchives(configs);
statusPrint('Archive paths must be unique', success: duplicateArchives.isEmpty);
indentedPrint(duplicateArchives);

// If we have a successfully parsed .ci.yaml, perform additional checks.
if (ciConfig == null) {
return;
Expand Down Expand Up @@ -228,6 +234,28 @@ List<String> checkForDuplicateConfigs(Map<String, BuilderConfig> configs) {
return errors;
}

// This check ensures that json files do not duplicate archive paths.
List<String> checkForDuplicateArchives(Map<String, BuilderConfig> configs) {
final RegExp zipPathPattern = RegExp(r'zip_archives/(.*\.zip)$');
final List<String> errors = <String>[];
final Set<String> archivePaths = <String>{};
_forEachBuild(configs, (String name, BuilderConfig config, Build build) {
for (final BuildArchive archive in build.archives) {
for (final String path in archive.includePaths) {
final RegExpMatch? match = zipPathPattern.firstMatch(path);
if (match == null) {
continue;
}
final String zipPath = match.group(1)!;
if (!archivePaths.add(zipPath)) {
errors.add('$zipPath is duplicated in $name\n');
}
}
}
});
return errors;
}

// This check ensures that builds are named in a way that is understood by
// `et`.
List<String> checkForInvalidBuildNames(Map<String, BuilderConfig> configs) {
Expand Down
27 changes: 27 additions & 0 deletions engine/src/flutter/tools/pkg/engine_build_configs/test/check_integration_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,4 +214,31 @@ void main() {

expect(stderr.toString(), contains('❌ All builder files conform to release_build standards'));
});

test('fails if archives.include_paths containts duplicates', () {
addConfig('android_debug', [
{
'name': 'ci/android_debug',
'archives': <Object?>[
{
'include_paths': <Object?>['out/android_debug/zip_archives/android-arm/artifacts.zip'],
},
],
},
]);
addConfig('android_debug2', [
{
'name': 'ci/android_debug2',
'archives': <Object?>[
{
'include_paths': <Object?>['out/android_debug2/zip_archives/android-arm/artifacts.zip'],
},
],
},
]);

run(['--engine-src-path=${tmpFlutterEngineSrc.path}'], allowFailure: true);

expect(stderr.toString(), contains('❌ Archive paths must be unique'));
});
}