Add com.codename1.crash on-device crash protection client#5001
Open
shai-almog wants to merge 4 commits into
Open
Add com.codename1.crash on-device crash protection client#5001shai-almog wants to merge 4 commits into
shai-almog wants to merge 4 commits into
Conversation
New package for capturing unhandled exceptions on device, scrubbing
PII, and uploading structured crash reports to the BuildCloud crash
service. Pairs with the new /api/v2/crash/reports server endpoint
(separate BuildCloud PR).
Surface:
- CrashProtection.install() / setEnabled() / setScrubber() /
capture(). Endpoint is fixed; opt-in is developer-controlled and
persisted in Preferences (default off).
- PiiScrubber is a public subclassable class. Default rules: emails
partially redacted (keep first 3 chars + full domain), runs of 6+
digits collapsed to [num]. URLs are NOT scrubbed.
- Storage-first delivery: every payload is written to Storage with a
fresh eventId BEFORE the POST; the storage entry is deleted only on
a 2xx. Failed sends are retried on next launch. The server uses
eventId for idempotent dedup.
Wire-up:
- Android: AndroidImplementation's UncaughtExceptionHandler now also
forwards to CrashProtection.capture(e), guarded by try/catch so a
bug here can't suppress the legacy Log.bindCrashProtection path.
- iOS: no client change. The existing signal handlers in
CodenameOne_GLAppDelegate.m convert signals to JVM exceptions which
flow through the EDT error handler naturally.
Build-server utility:
- maven/codenameone-maven-plugin/.../util/CrashSymbolUploader. Used by
the cloud build executor's post-build hook to POST mapping.txt
(Android) or the dSYM zip (iOS, release builds only) to the
/api/v2/build/{buildKey}/symbols endpoint. Standalone, no Spring dep.
AndroidGradleBuilder + IPhoneBuilder carry comments pointing the
executor at the right call sites.
Java 5 source compatibility maintained in the core client classes.
No new runtime dependencies on the device. ASCII-only sources;
CodenameOne header (not Oracle).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Compared 121 screenshots: 121 matched. |
Collaborator
Author
|
Compared 128 screenshots: 128 matched. Native Android coverage
✅ Native Android screenshot tests passed. Native Android coverage
Benchmark ResultsDetailed Performance Metrics
|
Collaborator
Author
|
Compared 128 screenshots: 128 matched. Benchmark Results
Build and Run Timing
Detailed Performance Metrics
|
Collaborator
Author
|
Compared 124 screenshots: 124 matched. Benchmark Results
Build and Run Timing
Detailed Performance Metrics
|
Contributor
Cloudflare Preview
|
Collaborator
Author
|
Compared 128 screenshots: 128 matched. Benchmark Results
Detailed Performance Metrics
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
com.codename1.crashpackage —CrashProtection,PiiScrubber(public, subclassable),CrashReportPayload. Storage-first delivery: every payload is written toStoragewith a fresheventIdbefore the POST; the storage entry is deleted only on a 2xx response. Failed sends are retried on the next launch and the server dedups via the sameeventId.PiiScrubberrules: emails partially redacted (keep first 3 chars of local part + full domain, e.g.joe***@example.com); runs of 6+ consecutive digits collapsed to[num]; URLs are NOT scrubbed. App devs overridescrubMessage/scrubFrameand register viaCrashProtection.setScrubber(...).https://cloud.codenameone.com/api/v2/crash/reports. Opt-in is developer-controlled viasetEnabled(boolean)(persisted inPreferences, default off). Simulator skips uploads.UncaughtExceptionHandlernow forwards toCrashProtection.capture(e)alongside the legacyLog.bindCrashProtectionpath (guarded by try/catch so a bug here can't suppress the legacy path). iOS needs no client change — existing signal handlers already convert signals into JVM exceptions that flow through the EDT error handler.com.codename1.builders.util.CrashSymbolUploaderis a standalone (no Spring) multipart-POST utility the cloud build executor calls after a successful release build to shipmapping.txt(Android) or the dSYM zip (iOS) to the matching server endpoint.AndroidGradleBuilder+IPhoneBuildercarry hook-point comments showing the executor where to call it.Pairs with codenameone/BuildCloud's server PR adding the matching endpoints, entities, and migration.
Test plan
validate-java25-markdown-docs.sh) passes — all crash code uses///markdown style, no classic/**Javadoc.mvn compilesucceeds on Java 8 / 17 / 21 matrix (core module enforces Java 5 source/target).CrashSymbolUploaderutility.tests/corePiiScrubberTestcovers: email partial redaction, short local-part handling, digit-run scrubbing, URL pass-through, subclass override on top of defaults, null in / null out.CrashProtection.install()+setEnabled(true), trigger anNPE, verify aCN1Crash__$<eventId>storage entry is created, then deleted after a successful POST to the cloud endpoint.Log.bindCrashProtectionpath still works when both systems are installed (the Android handler runs both branches, guarded).🤖 Generated with Claude Code