fix(widget): avoid recycling aliased source bitmap for 2:3 covers (#4850)

Bitmap.createBitmap returns the same immutable instance when the
center-crop covers the whole source, which happens for covers that
decode to exactly 2:3. writeThumbnail then recycled that instance
before createScaledBitmap used it, crashing with "cannot use a
recycled source in createBitmap". Guard the recycle the same way the
scaled vs cropped case is already guarded, and add an instrumented
regression test.

Also bundles a pending widget debugging note and a regenerated
fastlane README that were staged in the working tree.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Huang Xin
2026-06-29 10:13:17 +08:00
committed by GitHub
parent 5358d85c0b
commit a23427ccc6
4 changed files with 55 additions and 9 deletions
@@ -14,6 +14,7 @@ Durable, non-obvious gotchas (each cost a debugging round):
- **iOS widget missing from gallery = stale `.xcodeproj`.** `gen/apple/project.yml` defines the `ReadestWidget` target, but **Tauri's iOS build does NOT re-run xcodegen**, so a newly-added target is silently omitted from the build. Fix: `cd src-tauri/gen/apple && xcodegen generate`. Also: iOS builds from the **MAIN repo** `/Users/chrox/dev/readest` (complete gen/apple), NOT the `pnpm worktree:new` worktree (its gen/apple is incomplete — missing `Sources/`, `Assets.xcassets`, `Externals`, `LaunchScreen.storyboard` — so xcodegen fails there). - **iOS widget missing from gallery = stale `.xcodeproj`.** `gen/apple/project.yml` defines the `ReadestWidget` target, but **Tauri's iOS build does NOT re-run xcodegen**, so a newly-added target is silently omitted from the build. Fix: `cd src-tauri/gen/apple && xcodegen generate`. Also: iOS builds from the **MAIN repo** `/Users/chrox/dev/readest` (complete gen/apple), NOT the `pnpm worktree:new` worktree (its gen/apple is incomplete — missing `Sources/`, `Assets.xcassets`, `Externals`, `LaunchScreen.storyboard` — so xcodegen fails there).
- **Android RemoteViews allow only @RemoteView widgets.** Plain `<View>` (and `<Space>`) is NOT allowed → launcher inflate fails → "Can't load widget". Use an empty `FrameLayout` for spacers. Covers: badge + progress bar are **baked into the bitmap** (Canvas in `writeThumbnail`) because RemoteViews can't clip/overlay reliably; shown via `fitCenter`. Responsive sizing by grid cells: `n = (minWidthDp + 30) / 70` (Android cell formula); one book per column, cap 3. - **Android RemoteViews allow only @RemoteView widgets.** Plain `<View>` (and `<Space>`) is NOT allowed → launcher inflate fails → "Can't load widget". Use an empty `FrameLayout` for spacers. Covers: badge + progress bar are **baked into the bitmap** (Canvas in `writeThumbnail`) because RemoteViews can't clip/overlay reliably; shown via `fitCenter`. Responsive sizing by grid cells: `n = (minWidthDp + 30) / 70` (Android cell formula); one book per column, cap 3.
- **Background TTS progress freeze.** `book.progress` (libraryStore) AND `readerProgressStore` are both written by the same `setProgress`, inside `commitRelocate`**`requestAnimationFrame`**, which Android pauses for a backgrounded WebView → both freeze during background TTS. No store-only fix (page-based progress needs rendering). Fix: in `FoliateViewer.progressRelocateHandler`, commit synchronously when `document.visibilityState === 'hidden'` (relocate still fires; only the rAF commit was deferred). Confirmed working on device. - **Background TTS progress freeze.** `book.progress` (libraryStore) AND `readerProgressStore` are both written by the same `setProgress`, inside `commitRelocate`**`requestAnimationFrame`**, which Android pauses for a backgrounded WebView → both freeze during background TTS. No store-only fix (page-based progress needs rendering). Fix: in `FoliateViewer.progressRelocateHandler`, commit synchronously when `document.visibilityState === 'hidden'` (relocate still fires; only the rAF commit was deferred). Confirmed working on device.
- **Android crash: "cannot use a recycled source in createBitmap" (exact-2:3 covers).** In `ReadingWidgetStore.writeThumbnail`, `Bitmap.createBitmap(src, x, y, w, h)` returns the SAME instance when the crop covers the whole *immutable* source (`decodeFile` bitmaps are immutable) — which happens when the cover decodes to exactly 2:3 (height==width*3/2), making the center-crop a no-op. The old code then did `bitmap.recycle()`, recycling `cropped` too, so the next `createScaledBitmap(cropped, …)` threw. Fix: `if (cropped !== bitmap) bitmap.recycle()` — mirror the `if (scaled !== cropped) cropped.recycle()` guard already 4 lines below. Trace was R8-obfuscated + ran inside `update_reading_widget`'s `pluginScope.launch { withContext(Dispatchers.IO) }`, surfacing as `FATAL EXCEPTION: main` with a `Dispatchers.Main` cancelled-coroutine suppressed frame. **iOS is unaffected**`ReadingWidgetWriter.writeThumbnail` uses ARC-managed immutable `UIImage` + `UIGraphicsImageRenderer`, no manual recycle/aliasing.
- **iOS TTS controls deferred** — interactive widget buttons need iOS 17 App Intents; widget min target is iOS 15 (15/16 widgets can only deep-link, no buttons). Android uses `MediaButtonReceiver.buildMediaButtonPendingIntent` (any version). Follow-up only. - **iOS TTS controls deferred** — interactive widget buttons need iOS 17 App Intents; widget min target is iOS 15 (15/16 widgets can only deep-link, no buttons). Android uses `MediaButtonReceiver.buildMediaButtonPendingIntent` (any version). Follow-up only.
- **`.superpowers/` is NOT gitignored** in this repo → a subagent's `git add` can sweep SDD scratch (`*-report.md`) into a commit; check `git ls-files '.superpowers/*'` before squashing/pushing. - **`.superpowers/` is NOT gitignored** in this repo → a subagent's `git add` can sweep SDD scratch (`*-report.md`) into a commit; check `git ls-files '.superpowers/*'` before squashing/pushing.
@@ -0,0 +1,49 @@
package com.readest.native_bridge
import android.graphics.Bitmap
import android.graphics.BitmapFactory
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Assert.assertNotNull
import org.junit.Assert.assertTrue
import org.junit.Test
import org.junit.runner.RunWith
import java.io.File
/**
* Instrumented test (runs on an Android device/emulator).
*
* Regression for the widget cover crash: a cover that decodes to exactly 2:3
* makes the center-crop a no-op, so Bitmap.createBitmap returns the SAME
* immutable instance as the source. The pre-fix code recycled the source right
* after, then passed the now-recycled bitmap to createScaledBitmap, throwing
* "cannot use a recycled source in createBitmap" and killing the app.
*/
@RunWith(AndroidJUnit4::class)
class ReadingWidgetStoreTest {
@Test
fun writeThumbnail_exact2to3Cover_doesNotCrash() {
val ctx = InstrumentationRegistry.getInstrumentation().targetContext
// 240x360 is exactly 2:3 and small enough to skip downsampling, so the
// decoded cover hits the createBitmap same-instance path.
val src = Bitmap.createBitmap(240, 360, Bitmap.Config.ARGB_8888)
val srcFile = File(ctx.cacheDir, "widget-cover-2x3.png")
srcFile.outputStream().use { src.compress(Bitmap.CompressFormat.PNG, 100, it) }
src.recycle()
val hash = "regression2x3"
try {
// Pre-fix: throws IllegalArgumentException. Post-fix: writes the PNG.
ReadingWidgetStore.writeThumbnail(ctx, hash, srcFile.absolutePath, 42)
val out = File(ReadingWidgetStore.coversDir(ctx), "$hash.png")
assertTrue("thumbnail should be written", out.exists())
val decoded = BitmapFactory.decodeFile(out.absolutePath)
assertNotNull("thumbnail should decode to a valid bitmap", decoded)
out.delete()
} finally {
srcFile.delete()
}
}
}
@@ -57,7 +57,11 @@ object ReadingWidgetStore {
val cropX = (srcW - cropW) / 2 val cropX = (srcW - cropW) / 2
val cropY = (srcH - cropH) / 2 val cropY = (srcH - cropH) / 2
val cropped = Bitmap.createBitmap(bitmap, cropX, cropY, cropW, cropH) val cropped = Bitmap.createBitmap(bitmap, cropX, cropY, cropW, cropH)
bitmap.recycle() // createBitmap returns the SAME instance when the crop covers the whole
// (immutable) source — i.e. covers already at exactly 2:3. Recycling here
// would recycle `cropped` too and crash createScaledBitmap below with
// "cannot use a recycled source". Mirror the scaled !== cropped guard.
if (cropped !== bitmap) bitmap.recycle()
// Scale the cropped bitmap to the target size. // Scale the cropped bitmap to the target size.
val scaled = Bitmap.createScaledBitmap(cropped, THUMB_WIDTH, THUMB_HEIGHT, true) val scaled = Bitmap.createScaledBitmap(cropped, THUMB_WIDTH, THUMB_HEIGHT, true)
-8
View File
@@ -13,14 +13,6 @@ For _fastlane_ installation instructions, see [Installing _fastlane_](https://do
# Available Actions # Available Actions
### verify_paths
```sh
[bundle exec] fastlane verify_paths
```
### release_ios ### release_ios
```sh ```sh