flutter_patcher 0.1.3
flutter_patcher: ^0.1.3 copied to clipboard
Self-hosted Flutter Android hot-update/code-push plugin that patches libapp.so on cold start with integrity checks and crash rollback.
Chinese version: CHANGELOG-zh.md
0.1.3 #
Added #
- Added Android cold-start Flutter asset hot updates. Assets (images,
fonts, JSON, anything reachable via
Image.asset(...)orrootBundle.load(...)) can be patched together with Dart code through the samepatch.zippayload. - Added
--assetstodart run flutter_patcher:pack. Pass paths inline (--assets a,b) or read them from a UTF-8 text file with the@prefix (--assets @patch-assets.txt, one path per line,#starts a comment); inline paths and@filereferences can be mixed in the same flag. Each path must already be registered underassets:in the new APK'spubspec.yaml;--assetsonly tellspackwhich of those assets to ship insidepatch.zip. The runtime overlays them on top of the APK's Flutter asset bundle at install time.
Changed #
dart run flutter_patcher:packnow always emitsdist/patch.zip+dist/manifest.json(outerschemaVersion: 2,payload: patch.zip), whether or not--assetsis passed. A Dart-onlypatch.zipcontains justmanifest.json+lib/<abi>/libapp.so; its inner manifest omits theassetsblock. The previous bare-.sooutput mode is gone.- Android runtime detects ZIP payloads, installs overlay asset packages,
builds a private
flutter_assets.apk, and starts Flutter through a patchedFlutterJNIAssetManager when assets are present. Dart-onlypatch.zippayloads short-circuit the asset overlay pipeline and behave like code-only patches at install time. mock_server --distreadsmanifest.payloadand serves the declared file.
Compatibility #
- Bare-
.sopatches produced by 0.1.0–0.1.2 still install on 0.1.3 devices (the runtime keeps a quiet legacy install path); the producer CLI no longer emits that format. Server operators should shippatch.zipfor any new patch built against a 0.1.3+ host APK.
0.1.2 #
Added #
- Added
dart run flutter_patcher:mock_serverfor localcheckUpdate -> applyPatchtesting without maintaining an example-only helper script.
Changed #
- Improved README onboarding with a TL;DR, clearer fit / non-fit guidance, store policy warning, and local mock server instructions.
- Updated pub.dev package description and topics for better discoverability.
- Added a GitHub social preview image under
doc/social-preview.png.
0.1.1+1 #
Fixed #
- Corrected the README install snippet version pin to
^0.1.1(docs-only, no code change). - Translated CHANGELOG to English so pub.dev's pana check no longer
flags it for non-ASCII content. Chinese version preserved as
CHANGELOG-zh.md.
0.1.1 #
Changed #
PatchInfo.md5is now optional. An empty string means the caller explicitly opts out of download integrity verification and relies on HTTPS only. Whenmd5is empty the Ed25519 signature check is also skipped (the signature input is the md5 hex, so no md5 means no signature input).toJsonomits themd5key when it is empty.validatePatchArgs: blankmd5is now accepted; non-blankmd5is still required to be 32 lowercase hex chars.- Blacklist: when the caller does not provide
md5, the download pre-check falls back to version-only matching via the newBlacklistStore.containsByVersion. Blacklist entries are still recorded with the actual md5 computed after download. meta.json:effectiveMd5now always stores the md5 computed after download (previously it stored the server-declared md5). Boot checks and blacklist entries key on this stable hash.- Dependency constraints relaxed: Dart SDK constraint changed from
^3.10.7to>=3.0.0 <4.0.0; runtime dependencies switched to a lower bound plus an open upper bound;archivenow supports both 3.x and 4.x to reduce host-project conflicts.
0.1.0 #
First public release (Android-only beta).
Core features #
- Cold-start hot updates: replaces
FlutterLoader.findAppBundlePathvia reflection insideApplication.attachBaseContext, before the Dart engine starts, enabling whole-filelibapp.soreplacement. - Signature verification: built-in Ed25519 (X.509 SubjectPublicKey
Info) plus MD5 dual verification, with
strictSignaturemode that prevents downgrade bypass on older devices. - Crash circuit breaker / auto rollback: counts
REASON_CRASHevents fromApplicationExitInfoand hooksPlatformDispatcher.onErroron the Dart side. OncemaxCrashCount(default 1, fail-fast) is reached, the patch is deleted, added to the blacklist, and the host falls back to the bundled APK version. - First-frame verify clears the breaker: after the patch loads,
the app must stay alive in the foreground for
verifyAfter(default 5s) before being marked verified, which resets the crash counter. - Local blacklist: auto-blacklisted patches will never be
reinstalled, preventing crash loops. Inspect or clear via
FlutterPatcher.blacklist/clearBlacklist. - Progress event stream:
FlutterPatcher.applyProgressexposesdownloading/verifying/finalizingphase events. - CLI packaging tool:
dart run flutter_patcher:packextractslibapp.sofrom a release APK and produces the patch manifest.
Known limitations #
- Android only. On iOS / Web / desktop, all APIs are no-ops (the first call prints a warning).
- Strict Ed25519 mode requires Android API 33+. Below API 33 with
strictSignature: true(the default), signed patches are rejected. - Only full-mode patches are supported. Differential patching is not shipped in 0.1.0 to avoid exposing an unverified path.
- This initial release shipped the legacy lib-only payload path. Asset payloads were added later in 0.1.3.
Documentation #
- Repository README: use cases, 5-minute demo, integration steps.
doc/architecture.md: native + Dart layered architecture and startup sequence.doc/api-reference.md: full API reference.doc/crash-protection.md: breaker and rollback strategy.