build: Add Java 8 API compatibility checks by adinauer · Pull Request #5745 · getsentry/sentry-java

adinauer · 2026-07-08T12:57:02Z

📜 Description

Add Java 8 runtime API compatibility coverage to JVM SDK modules using Animal Sniffer and the Codehaus Java 8 signature.

This applies ru.vyarus.animalsniffer to Java 8 java-library SDK modules that were missing it and adds:

org.codehaus.mojo.signature:java18:1.0@signature

to those modules, with the signature version defined in gradle/libs.versions.toml as java18Signature. Modules that already used Animal Sniffer keep their existing gummy-bears signature and also get the Codehaus Java 8 signature. The plugin checks signatures independently, so the Java 8 check still catches plain JVM incompatibilities while the existing Android/desugaring coverage remains intact.

💡 Motivation and Context

We recently hit a Java 8 runtime incompatibility from a method reference that compiled on a newer JDK but is unavailable on Java 8. Targeting Java 8 bytecode is not sufficient to catch this class of issue, so published JVM SDK modules should also be checked against the Java 8 runtime API surface.

This now runs through the existing check lifecycle and therefore through the existing Build workflow on PRs and main.

Refs GH-5741

💚 How did you test it?

./gradlew spotlessApply apiDump
BUILD SUCCESSFUL

./gradlew check --no-configuration-cache -Dorg.gradle.configureondemand=false
BUILD SUCCESSFUL

The check run includes Android modules and passed, confirming the duplicated JVM Animal Sniffer configuration does not break Android builds.

A stacked validation PR intentionally introduces newer JDK API references in multiple JVM modules to confirm the new checks fail where expected.

📝 Checklist

I added GH Issue ID & Linear ID
I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.
Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.

#skip-changelog

sentry · 2026-07-08T12:58:46Z

📲 Install Builds

Android

🔗 App Name	App ID	Version	Configuration
SDK Size	io.sentry.tests.size	8.48.0 (1)	release

⚙️ sentry-android Build Distribution Settings

github-actions · 2026-07-08T13:05:46Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	327.56 ms	346.93 ms	19.37 ms
Size	0 B	0 B	0 B

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`4fc476b`	280.63 ms	363.04 ms	82.42 ms
`6b019b7`	343.31 ms	417.23 ms	73.91 ms
`83884a0`	334.46 ms	400.92 ms	66.46 ms
`319f256`	315.96 ms	372.96 ms	57.00 ms
`e63ad34`	297.04 ms	369.90 ms	72.86 ms
`d15471f`	322.58 ms	396.08 ms	73.50 ms
`d364ace`	382.77 ms	443.21 ms	60.44 ms
`7314dbe`	437.83 ms	505.64 ms	67.81 ms
`05aa61d`	320.22 ms	346.47 ms	26.24 ms
`0eaac1e`	316.82 ms	357.34 ms	40.52 ms

App size

Revision	Plain	With Sentry	Diff
`4fc476b`	0 B	0 B	0 B
`6b019b7`	0 B	0 B	0 B
`83884a0`	1.58 MiB	2.29 MiB	722.97 KiB
`319f256`	1.58 MiB	2.19 MiB	619.79 KiB
`e63ad34`	0 B	0 B	0 B
`d15471f`	1.58 MiB	2.13 MiB	559.54 KiB
`d364ace`	1.58 MiB	2.11 MiB	539.75 KiB
`7314dbe`	1.58 MiB	2.10 MiB	533.45 KiB
`05aa61d`	0 B	0 B	0 B
`0eaac1e`	1.58 MiB	2.19 MiB	619.17 KiB

Previous results on branch: ci/java8-api-compatibility

Startup times

Revision	Plain	With Sentry	Diff
`2013e56`	310.10 ms	352.13 ms	42.03 ms
`e122d12`	360.71 ms	433.96 ms	73.25 ms
`29117d4`	315.09 ms	353.43 ms	38.34 ms
`609df4f`	315.04 ms	360.96 ms	45.92 ms
`5e2e74b`	329.90 ms	382.21 ms	52.31 ms

App size

Revision	Plain	With Sentry	Diff
`2013e56`	0 B	0 B	0 B
`e122d12`	0 B	0 B	0 B
`29117d4`	0 B	0 B	0 B
`609df4f`	0 B	0 B	0 B
`5e2e74b`	0 B	0 B	0 B

adinauer · 2026-07-08T13:29:43Z

Tested this using #5746 and it failed for both Math.floorDiv and Objects.requireNonNullElse in different modules.

Apply Animal Sniffer to Java 8 JVM SDK modules and check them against the Codehaus Java 8 runtime signature. This catches references to newer JDK APIs while keeping the existing Android signature checks in place where they already apply. Refs GH-5741

Move shared Java 8 API compatibility configuration into build-logic plugins. Apply the Android-compatible variant where modules also need gummy-bears API checks to reduce duplicated signature setup. Co-Authored-By: Claude <noreply@anthropic.com>

Move Java 8 signature coordinates into the version catalog and add a shared helper for registering Animal Sniffer signature dependencies. Co-Authored-By: Claude <noreply@anthropic.com>

Configure Animal Sniffer tasks with the plugin task type directly so ignored classes can be set without reflective method lookup. Co-Authored-By: Claude <noreply@anthropic.com>

Configure Animal Sniffer task options directly from the convention extension so the build does not defer configuration with afterEvaluate. Co-Authored-By: Claude <noreply@anthropic.com>

Move the task-wiring logic out of SentryAnimalSnifferExtension and into the plugin. The extension previously held a Project reference and reached into the animalsnifferMain task on every DSL call, mixing configuration with application logic. The extension now only declares intent via managed ListProperty values; the plugin reads them when configuring the task. This drops the Project reference (config-cache friendly) and needs no afterEvaluate, since the task-configuration action runs after the build script is evaluated. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

runningcode

I left some comments and then did the refactor myself. Go back to the previous commit if you are curious. There's just one nit left but I'm giving it a 👍

adinauer mentioned this pull request Jul 8, 2026

test: Verify Java 8 API check in logback #5746

Closed

9 tasks

adinauer force-pushed the ci/java8-api-compatibility branch from 3611c33 to 0229500 Compare July 8, 2026 14:09

adinauer mentioned this pull request Jul 8, 2026

test: Verify Java 8 API compatibility coverage #5747

Closed

9 tasks

adinauer changed the title ~~ci: Add Java 8 API compatibility check~~ build: Add Java 8 API compatibility checks Jul 8, 2026

adinauer force-pushed the ci/java8-api-compatibility branch from 0229500 to 305dafe Compare July 8, 2026 14:23

runningcode reviewed Jul 8, 2026

View reviewed changes

Comment thread sentry-apache-http-client-5/build.gradle.kts Outdated

runningcode reviewed Jul 8, 2026

View reviewed changes

Comment thread sentry-apache-http-client-5/build.gradle.kts Outdated

adinauer and others added 2 commits July 9, 2026 09:58

build: Use catalog aliases for Animal Sniffer signatures

2c8712b

Move Java 8 signature coordinates into the version catalog and add a shared helper for registering Animal Sniffer signature dependencies. Co-Authored-By: Claude <noreply@anthropic.com>

runningcode reviewed Jul 9, 2026

View reviewed changes

Comment thread build-logic/src/main/kotlin/io/sentry/gradle/SentryAnimalSnifferPlugin.kt Outdated

runningcode reviewed Jul 9, 2026

View reviewed changes

Comment thread build-logic/src/main/kotlin/io/sentry/gradle/SentryAnimalSnifferPlugin.kt Outdated

adinauer and others added 2 commits July 9, 2026 14:43

build: Remove Animal Sniffer reflection

555d74a

Configure Animal Sniffer tasks with the plugin task type directly so ignored classes can be set without reflective method lookup. Co-Authored-By: Claude <noreply@anthropic.com>

build: Avoid afterEvaluate for Animal Sniffer config

e53d673

Configure Animal Sniffer task options directly from the convention extension so the build does not defer configuration with afterEvaluate. Co-Authored-By: Claude <noreply@anthropic.com>

adinauer marked this pull request as ready for review July 9, 2026 13:56

adinauer requested review from 0xadam-brown, markushi and romtsn as code owners July 9, 2026 13:56

runningcode reviewed Jul 10, 2026

View reviewed changes

Comment thread gradle/libs.versions.toml Outdated

Comment thread build-logic/src/main/kotlin/io/sentry/gradle/SentryAnimalSnifferPlugin.kt Outdated

runningcode approved these changes Jul 10, 2026

View reviewed changes

adinauer added 2 commits July 13, 2026 15:26

build: Clarify java18Signature refers to Java 1.8

58422c6

build: Rename java18 signature alias to java8 for clarity

22fddc7

adinauer merged commit c971c04 into main Jul 14, 2026
70 of 71 checks passed

adinauer deleted the ci/java8-api-compatibility branch July 14, 2026 05:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

build: Add Java 8 API compatibility checks#5745

build: Add Java 8 API compatibility checks#5745
adinauer merged 8 commits into
mainfrom
ci/java8-api-compatibility

adinauer commented Jul 8, 2026 •

edited

Loading

Uh oh!

sentry Bot commented Jul 8, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 8, 2026 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: ci/java8-api-compatibility

Startup times

App size

Uh oh!

adinauer commented Jul 8, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

runningcode left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

adinauer commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

Uh oh!

sentry Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📲 Install Builds

Android

Uh oh!

github-actions Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: ci/java8-api-compatibility

Startup times

App size

Uh oh!

adinauer commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

runningcode left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

adinauer commented Jul 8, 2026 •

edited

Loading

sentry Bot commented Jul 8, 2026 •

edited

Loading

github-actions Bot commented Jul 8, 2026 •

edited

Loading

adinauer commented Jul 8, 2026 •

edited

Loading