TODO(b/74333698): Always check the contents of conflicting resources */ static class PathComparingChecker implements SourceChecker { static SourceChecker create() { return new PathComparingChecker(); } @Override public boolean checkEquality(DataSource one, DataSource two) throws IOException { return one.getPath().equals(two.getPath()); } } /** Compares two paths by the contents of the files. */ static class ContentComparingChecker implements SourceChecker { static SourceChecker create() { return new ContentComparingChecker(); } @Override public boolean checkEquality(DataSource one, DataSource two) throws IOException { // TODO(corysmith): Is there a filesystem hash we can use? if (one.getFileSize() != two.getFileSize()) { return false; } try (final InputStream oneStream = one.newBufferedInputStream(); final InputStream twoStream = two.newBufferedInputStream()) { int bytesRead = 0; while (true) { int oneByte = oneStream.read(); int twoByte = twoStream.read(); bytesRead++; if (oneByte == -1 || twoByte == -1) { if (oneByte == twoByte) { return true; } else { // getFileSize did not return correct size. logger.severe( String.format( "Filesystem size of %s (%s) or %s (%s) is inconsistent with bytes read %s.", one, one.getFileSize(), two, two.getFileSize(), bytesRead)); return false; } } if (oneByte != twoByte) { return false; } } } } } static class NoopSourceChecker implements SourceChecker { static SourceChecker create() { return new NoopSourceChecker(); } @Override public boolean checkEquality(DataSource one, DataSource two) { return false; } } private final SourceChecker deDuplicator; private final ListeningExecutorService executorService; private final AndroidDataDeserializer deserializer; /** Creates a merger with no path deduplication and a default {@link ExecutorService}. */ @VisibleForTesting static AndroidDataMerger createWithDefaults() { return createWithDefaultThreadPool(NoopSourceChecker.create()); } /** Creates a merger with a custom deduplicator and a default {@link ExecutorService}. */ @VisibleForTesting static AndroidDataMerger createWithDefaultThreadPool(SourceChecker deDuplicator) { return new AndroidDataMerger( deDuplicator, MoreExecutors.newDirectExecutorService(), AndroidParsedDataDeserializer.create()); } /** Creates a merger with a file contents hashing deduplicator. */ static AndroidDataMerger createWithPathDeduplictor( ListeningExecutorService executorService, AndroidDataDeserializer deserializer, SourceChecker checker) { return new AndroidDataMerger(checker, executorService, deserializer); } private AndroidDataMerger( SourceChecker deDuplicator, ListeningExecutorService executorService, AndroidDataDeserializer deserializer) { this.deDuplicator = deDuplicator; this.executorService = executorService; this.deserializer = deserializer; } /** * Loads a list of dependency {@link SerializedAndroidData} and merge with the primary {@link * ParsedAndroidData}. * * @see AndroidDataMerger#merge(ParsedAndroidData, ParsedAndroidData, UnvalidatedAndroidData, * boolean, boolean) for details. */ UnwrittenMergedAndroidData loadAndMerge( List transitive, List direct, ParsedAndroidData primary, Path primaryManifest, boolean allowPrimaryOverrideAll, boolean throwOnResourceConflict) { Stopwatch timer = Stopwatch.createStarted(); try { logger.fine( String.format("Merged dependencies read in %sms", timer.elapsed(TimeUnit.MILLISECONDS))); timer.reset().start(); return doMerge( ParsedAndroidData.loadedFrom(transitive, executorService, deserializer), ParsedAndroidData.loadedFrom(direct, executorService, deserializer), primary, primaryManifest, allowPrimaryOverrideAll, throwOnResourceConflict); } finally { logger.fine(String.format("Resources merged in %sms", timer.elapsed(TimeUnit.MILLISECONDS))); } } /** * Merges DataResources into an UnwrittenMergedAndroidData. * *
This method has two basic states, library and binary. These are distinguished by * allowPrimaryOverrideAll, which allows the primary data to overwrite any value in the closure, a * trait associated with binaries, as a binary is a leaf node. The other semantics are slightly * more complicated: a given resource can be overwritten only if it resides in the direct * dependencies of primary data. This forces an explicit simple priority for each resource, * instead of the more subtle semantics of multiple layers of libraries with potential overwrites. * *
The UnwrittenMergedAndroidData contains only one of each DataKey in both the direct and * transitive closure. * *
The merge semantics for overwriting resources (non id and styleable) are as follows: * *
* Key: * A(): package A * A(foo): package A with resource symbol foo * A() -> B(): a dependency relationship of B.deps = [:A] * A(),B() -> C(): a dependency relationship of C.deps = [:A,:B] * * For android library (allowPrimaryOverrideAll = False) * * A() -> B(foo) -> C(foo) == Valid * A() -> B() -> C(foo) == Valid * A() -> B() -> C(foo),D(foo) == Conflict * A(foo) -> B(foo) -> C() == Conflict * A(foo) -> B() -> C(foo) == Conflict * A(foo),B(foo) -> C() -> D() == Conflict * A() -> B(foo),C(foo) -> D() == Conflict * A(foo),B(foo) -> C() -> D(foo) == Conflict * A() -> B(foo),C(foo) -> D(foo) == Conflict * * For android binary (allowPrimaryOverrideAll = True) * * A() -> B(foo) -> C(foo) == Valid * A() -> B() -> C(foo) == Valid * A() -> B() -> C(foo),D(foo) == Conflict * A(foo) -> B(foo) -> C() == Conflict * A(foo) -> B() -> C(foo) == Valid * A(foo),B(foo) -> C() -> D() == Conflict * A() -> B(foo),C(foo) -> D() == Conflict * A(foo),B(foo) -> C() -> D(foo) == Valid * A() -> B(foo),C(foo) -> D(foo) == Valid ** *
Combining resources are much simpler -- since a combining (id and styleable) resource does * not get replaced when redefined, they are simply combined: * *
* A(foo) -> B(foo) -> C(foo) == Valid * ** * @param transitive The transitive dependencies to merge. * @param direct The direct dependencies to merge. * @param primaryData The primary data to merge against. * @param allowPrimaryOverrideAll Boolean that indicates if the primary data will be considered * the ultimate source of truth, provided it doesn't conflict with itself. * @return An UnwrittenMergedAndroidData, containing DataResource objects that can be written to * disk for aapt processing or serialized for future merge passes. * @throws MergingException if there are issues with parsing resources from primaryData. * @throws MergeConflictException if there are merge conflicts */ UnwrittenMergedAndroidData merge( ParsedAndroidData transitive, ParsedAndroidData direct, UnvalidatedAndroidData primaryData, boolean allowPrimaryOverrideAll, boolean throwOnResourceConflict) { try { // Extract the primary resources. ParsedAndroidData parsedPrimary = ParsedAndroidData.from(primaryData); return doMerge( transitive, direct, parsedPrimary, primaryData.getManifest(), allowPrimaryOverrideAll, throwOnResourceConflict); } catch (IOException e) { throw MergingException.wrapException(e); } } private UnwrittenMergedAndroidData doMerge( ParsedAndroidData transitive, ParsedAndroidData direct, ParsedAndroidData parsedPrimary, Path primaryManifest, boolean allowPrimaryOverrideAll, boolean throwOnResourceConflict) { // Create the builders for the final parsed data. final ParsedAndroidData.Builder primaryBuilder = ParsedAndroidData.Builder.newBuilder(); final ParsedAndroidData.Builder transitiveBuilder = ParsedAndroidData.Builder.newBuilder(); final KeyValueConsumers transitiveConsumers = transitiveBuilder.consumers(); final KeyValueConsumers primaryConsumers = primaryBuilder.consumers(); final Set