Skip to content

Fix "Targeting R+ (version 30 and above) requires the resources.arsc of installed APKs to be stored uncompressed" #24

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 1 commit into from
Mar 23, 2025
Merged

Fix "Targeting R+ (version 30 and above) requires the resources.arsc of installed APKs to be stored uncompressed" #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions examples/minimal/build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,19 @@ pub fn build(b: *std.Build) void {
};

for (targets) |target| {
var exe: *std.Build.Step.Compile = if (target.result.abi.isAndroid()) b.addSharedLibrary(.{
.name = exe_name,
.root_source_file = b.path("src/minimal.zig"),
const app_module = b.createModule(.{
.target = target,
.optimize = optimize,
.root_source_file = b.path("src/minimal.zig"),
});

var exe: *std.Build.Step.Compile = if (target.result.abi.isAndroid()) b.addLibrary(.{
.name = exe_name,
.root_module = app_module,
.linkage = .dynamic,
}) else b.addExecutable(.{
.name = exe_name,
.root_source_file = b.path("src/minimal.zig"),
.target = target,
.optimize = optimize,
.root_module = app_module,
});

// if building as library for Android, add this target
Expand Down
14 changes: 8 additions & 6 deletions examples/sdl2/build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,18 @@ pub fn build(b: *std.Build) void {

for (targets) |target| {
const exe_name: []const u8 = "sdl-zig-demo";
var exe: *std.Build.Step.Compile = if (target.result.abi.isAndroid()) b.addSharedLibrary(.{
.name = exe_name,
.root_source_file = b.path("src/sdl-zig-demo.zig"),
const app_module = b.createModule(.{
.target = target,
.optimize = optimize,
.root_source_file = b.path("src/sdl-zig-demo.zig"),
});
var exe: *std.Build.Step.Compile = if (target.result.abi.isAndroid()) b.addLibrary(.{
.name = exe_name,
.root_module = app_module,
.linkage = .dynamic,
}) else b.addExecutable(.{
.name = exe_name,
.root_source_file = b.path("src/sdl-zig-demo.zig"),
.target = target,
.optimize = optimize,
.root_module = app_module,
});

const library_optimize = if (!target.result.abi.isAndroid())
Expand Down
60 changes: 55 additions & 5 deletions src/androidbuild/apk.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,10 @@ fn doInstallApk(apk: *Apk) std.mem.Allocator.Error!*Step.InstallFile {
// - classes.dex
const apk_files = b.addWriteFiles();

// These files belong in root and *must not* be compressed
// - resources.arsc
const apk_files_not_compressed = b.addWriteFiles();

// Add build artifacts, usually a shared library targetting:
// - aarch64-linux-android
// - arm-linux-androideabi
Expand Down Expand Up @@ -491,10 +495,24 @@ fn doInstallApk(apk: *Apk) std.mem.Allocator.Error!*Step.InstallFile {
const extracted_apk_dir = resources_apk.dirname();
jar.setCwd(extracted_apk_dir);
_ = apk_files.addCopyDirectory(extracted_apk_dir, "", .{
// Ignore the *.apk that exists in this directory
.exclude_extensions = &.{".apk"},
.exclude_extensions = &.{
// ignore the *.apk that exists in this directory
".apk",
// ignore resources.arsc as Android 30+ APIs does not supporting
// compressing this in the zip file
".arsc",
},
});
apk_files.step.dependOn(&jar.step);

// Setup directory of additional files that should not be compressed

// NOTE(jae): 2025-03-23 - https://github.com/silbinarywolf/zig-android-sdk/issues/23
// We apply resources.arsc seperately to the zip file to avoid compressing it, otherwise we get the following
// error when we "adb install"
// - "Targeting R+ (version 30 and above) requires the resources.arsc of installed APKs to be stored uncompressed and aligned on a 4-byte boundary"
_ = apk_files_not_compressed.addCopyFile(extracted_apk_dir.path(b, "resources.arsc"), "resources.arsc");
apk_files_not_compressed.step.dependOn(&jar.step);
}

// Create zip via "jar" as it's cross-platform and aapt2 can't zip *.so or *.dex files.
Expand All @@ -513,9 +531,12 @@ fn doInstallApk(apk: *Apk) std.mem.Allocator.Error!*Step.InstallFile {
// Hack to ensure this side-effect re-triggers zipping this up
jar.addFileInput(directory_to_zip.path(b, "AndroidManifest.xml"));

// -c = compress
// -f specify filename
// -M do not include a MANIFEST file
// Written as-is from running "jar --help"
// -c, --create = Create the archive. When the archive file name specified
// -u, --update = Update an existing jar archive
// -f, --file=FILE = The archive file name. When omitted, either stdin or
// -M, --no-manifest = Do not create a manifest file for the entries
// -0, --no-compress = Store only; use no ZIP compression
const compress_zip_arg = "-cfM";
if (b.verbose) jar.addArg(compress_zip_arg ++ "v") else jar.addArg(compress_zip_arg);
const output_zip_file = jar.addOutputFileArg("compiled_code.zip");
Expand All @@ -524,6 +545,32 @@ fn doInstallApk(apk: *Apk) std.mem.Allocator.Error!*Step.InstallFile {
break :blk output_zip_file;
};

// Update zip with files that are not compressed (ie. resources.arsc)
const update_zip: *Step = blk: {
const jar = b.addSystemCommand(&[_][]const u8{
apk.tools.java_tools.jar,
});
jar.setName(runNameContext("jar (update zip with uncompressed files)"));

const directory_to_zip = apk_files_not_compressed.getDirectory();
jar.setCwd(directory_to_zip);
// NOTE(jae): 2025-03-23
// Hack to ensure this side-effect re-triggers zipping this up
jar.addFileInput(apk_files_not_compressed.getDirectory().path(b, "resources.arsc"));

// Written as-is from running "jar --help"
// -c, --create = Create the archive. When the archive file name specified
// -u, --update = Update an existing jar archive
// -f, --file=FILE = The archive file name. When omitted, either stdin or
// -M, --no-manifest = Do not create a manifest file for the entries
// -0, --no-compress = Store only; use no ZIP compression
const update_zip_arg = "-ufM0";
if (b.verbose) jar.addArg(update_zip_arg ++ "v") else jar.addArg(update_zip_arg);
jar.addFileArg(zip_file);
jar.addArg(".");
break :blk &jar.step;
};

// NOTE(jae): 2024-09-28 - https://github.com/silbinarywolf/zig-android-sdk/issues/8
// Experimented with using "lint" but it didn't actually catch the issue described
// in the above Github, ie. having "<category android:name="org.khronos.openxr.intent.category.IMMERSIVE_HMD" />"
Expand Down Expand Up @@ -561,7 +608,10 @@ fn doInstallApk(apk: *Apk) std.mem.Allocator.Error!*Step.InstallFile {
"4",
});

// Depend on zip file and the additional update to it
zipalign.addFileArg(zip_file);
zipalign.step.dependOn(update_zip);

const apk_file = zipalign.addOutputFileArg(b.fmt("aligned-{s}.apk", .{apk_name}));
break :blk apk_file;
};
Expand Down