loveheaven
11d796361e
* perf(epub): add native EPUB parser in Rust
Introduce a Rust-side EPUB pre-parser exposing three Tauri commands:
* parse_epub_metadata - title/author/cover + partialMD5 in one
shot, for the import hot path
* parse_epub_full - OPF + nav.xhtml + toc.ncx bytes plus a
manifest size table, for the reader open
hot path
* extract_epub_cover_full - full-resolution cover bytes, for the
lock-screen wallpaper writer
All three avoid ferrying multi-MB blobs across the JS<->Rust IPC
boundary. Cover bytes returned by parse_epub_metadata are downscaled
to a webview-friendly JPEG when the long edge exceeds the library
thumbnail size.
No JS callers yet -- wired up in the following commits.
* perf(import): use native EPUB parser and downscale covers on Tauri targets
On Tauri (desktop/iOS/Android), importBook now forwards EPUB
metadata + cover extraction to the Rust parse_epub_metadata
command and reuses the partialMD5 it returns, skipping the
foliate-js full archive parse and the second pass over the file
for hashing.
As a side effect, the cover written to cover.png is downscaled
to a webview-friendly JPEG (long edge <= 512px), shrinking the
on-disk thumbnail from multi-MB to ~30-60KB per book. To keep
the lock-screen wallpaper feature unchanged, useAutoSaveBookCover
now pulls the original full-resolution cover via the Rust
extract_epub_cover_full command instead of copying the (now
downscaled) cover.png; falls back to the thumbnail when the
native path is unavailable.
Web targets and non-EPUB formats keep the existing path.
* perf(reader): prefetch EPUB OPF/nav from Rust on book open
When opening an EPUB on Tauri targets, DocumentLoader now calls the
Rust parse_epub_full command up-front to pull the OPF, EPUB3 nav,
NCX and the central-directory size map in a single IPC. The
foliate-js zip loader is wrapped so that loadText() of these
entries (and a synthetic META-INF/container.xml) is served from
that in-memory cache without inflating through zip.js, while
all other assets keep flowing through the original loader.
A small in-flight dedupe is added to the spine-text loader so the
nav pipeline (loadText + createDocument back-to-back on the same
href) doesn't pay for two zip.js inflate calls per chapter on
first open.
Reader store / app service plumbing: readerStore.openBook now
resolves an absolute on-disk path via the new
appService.resolveNativeBookFilePath / bookService.resolveNativeBookFilePath
helper and threads it into DocumentLoader as nativeFilePath so
the prefetch can fire. Web targets, non-EPUB formats and books
without a managed/external on-disk path skip the prefetch and
take the original code path.
* perf(nav): parallelize section scans and memoize fragment lookups
computeBookNav now processes sections via Promise.all instead of
a sequential for-loop, and within each section issues loadText()
and createDocument() concurrently. Combined with the in-flight
loadText dedupe added to the zip loader, each chapter pays for a
single zip inflate per nav build, and the inflates of different
chapters overlap.
enrichTocFromNavElements is restructured into two concurrent
phases: a cheap '<nav' substring filter on the inflated text, and
a parsed-document walk for the survivors. Most chapters fall out
in phase 1 without ever being parsed.
In fragments.ts, calculateFragmentSize now consults a
per-section position cache (makeFragmentPositionCache) so the
N-fragment loop is O(N) over the chapter HTML instead of O(N²).
A small isCfiAddressable guard is added to skip elements that
foliate-js's CFI generator can't address (documentElement, body
itself, detached nodes, nodes outside <body>) — these previously
threw and spammed console.warn for every fragment, now they
silently fall back to the section CFI.
* perf(import): use native MOBI/AZW/AZW3 parser on Tauri targets
On Tauri (desktop/iOS/Android), importBook now forwards
MOBI/AZW/AZW3/PRC metadata + cover extraction to the Rust
parse_mobi_metadata command and reuses the partialMD5 it returns,
skipping the foliate-js full-buffer parse and the second pass over
the file for hashing. Mirrors the existing EPUB native fast-path
added in e3fc4767 — bookService tries EPUB first, then MOBI; both
bridges fall back to the foliate-js DocumentLoader when the native
path is unavailable (web target, parse error, format mismatch).
The new mobi_parser is built on the mobi crate (KF7+KF8 reader,
zero JS-side touch). It reads title, author, publisher, ISBN, ASIN,
publish date, language, subjects and description from the MobiHeader
+ EXTH records, resolves the EXTH 201 cover offset against the PDB
image-record table (with ThumbOffset / first-image fallbacks), and
strips KindleGen's HTML wrapping in EXTH 103 so the description goes
into the library DB as plain text. The parsed cover is funneled
through the same maybe_resize_cover path as EPUB, so MOBI library
thumbnails are also clamped to a 512px-long-edge JPEG.
Cover-resize / partialMD5 / RawCoverImage are extracted into a new
parser_common module shared between epub_parser and mobi_parser, so
a single tweak (e.g. raising the thumbnail target) applies to every
native importer and the partialMD5 implementation can't drift between
the two paths (a divergent algorithm would silently re-import every
existing book under a new hash on the first run).
Web targets and non-Kindle formats keep the existing path.
* test(tauri): verify native Rust EPUB parser parity with foliate-js
Add a Tauri WebView parity suite (epub-parser-parity.tauri.test.ts) that
cross-checks the native Rust parser against foliate-js on the same fixtures:
parse_epub_metadata / parse_epub_full (title, author, language, identifier,
publisher, published, subjects, partialMD5, OPF + per-entry size table), and
that opening with the native prefetch produces the same BookDoc and
computeBookNav (TOC) output as the pure-JS path.
Fix a parity divergence the suite caught: the Rust OPF parser mapped
dcterms:modified onto `published`, but foliate-js keeps them separate and
leaves `published` empty -- so EPUB3 books carrying only the mandatory
dcterms:modified got a bogus publication date on the native import path. Map
only dc:date now; add regression tests.
Test infra:
- vitest.tauri.config.mts: add optimizeDeps (mirroring vitest.browser.config)
so foliate-js-importing tauri tests load -- otherwise esbuild's dep scan
can't resolve '@pdfjs/pdf.min.mjs', pre-bundling is skipped, and the CJS
deps fail to import ("Importing a module script failed").
- capabilities-extra/webdriver.json: fix __test__ -> __tests__ fs scope typo
so import tests can open fixtures under src/__tests__/.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* refactor(import): foliate-js owns EPUB/MOBI metadata via standalone extractors
Rust contributes only the mechanical work that's expensive on a
WebView — partialMD5, the downscaled cover, and (for EPUB) the raw
OPF bytes Rust already had to read for cover resolution. Metadata
extraction is delegated to foliate-js's two new standalone entry
points (`parseEpubMetadataFromXML`, `readMobiMetadata`) so the
import-path BookDoc and the reader-path BookDoc share a single
parser implementation.
EPUB
- `parse_epub_metadata` returns
`{ partialMd5, cover, coverMime, opfPath, opfBytes }`. OPF bytes
are a free byproduct of the cover-resolution scan.
- `tryNativeParseEpub` runs `parseEpubMetadataFromXML` on the OPF
bytes and assembles a lightweight BookDoc stub (metadata +
getCover). The importer doesn't drive `DocumentLoader.open()`, so
no zip central-directory scan, no nav/ncx inflate, no spine walk.
- `coverMime` is preserved so `bookService.importBook`'s
`cover.type === 'image/svg+xml'` branch still routes SVG covers
through svg2png.
MOBI / AZW / AZW3 / PRC
- `parse_mobi_metadata` returns `{ partialMd5, cover, coverMime }`.
`tryNativeParseMobi` runs foliate's `readMobiMetadata` on the
same File, which uses `MOBI.open(file, { metadataOnly: true })`
to parse PalmDB + MobiHeader + EXTH and short-circuit before the
MOBI6 / KF8 init() that walks every text record.
- `Book.metadata.identifier` is foliate's `mobi.uid.toString()`
(PalmDB UID), the canonical MOBI identifier the reader path uses.
bookService.importBook
- EPUB and MOBI native branches consume the bridge's BookDoc stub
directly. The stub's `getCover()` returns the Rust-downscaled
blob, falling back to foliate's own `getCover` thunk when Rust
didn't extract a cover.
Other
- Drop the unused `base64` Rust dependency: cover bytes go over IPC
as `Vec<u8>` (Tauri 2 transports them natively, like opfBytes /
navBytes / ncxBytes).
- Drop the `nativePrefetch` option on `DocumentLoaderOptions`; no
caller passes it. `nativeFilePath` keeps driving `parse_epub_full`
on the open hot path.
Tests
- vitest.tauri parity test asserts byte-equal partialMD5, cover
presence parity, OPF bytes that decode to a real `<package>`
document, and that `parseEpubMetadataFromXML` on those bytes
produces the same user-visible metadata fields (title / author /
language / identifier / published) as `DocumentLoader.open()`.
* test(tauri): add War and Peace MOBI fixture for native parser parity
The .tauri parser-parity suite previously had no .mobi/.azw3 asset, so the native MOBI parser (metadata + EXTH cover resolution) was uncovered. Adds a real KF8 MOBI ("War and Peace") to enable MOBI parity coverage against foliate-js.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* chore(foliate-js): bump submodule to readest/foliate-js main (91191ca)
Replaces the ad-hoc 02f435a with the merged main commit 91191ca, which lands the standalone OPF/MOBI metadata extractors (parseEpubMetadataFromXML, readMobiMetadata) the import fast-path depends on (foliate#19), plus the RTL multi-view rect-mapper fix (foliate#20). The extractor code is byte-identical to 02f435a, so the bridges are unaffected.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Huang Xin <chrox.huang@gmail.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
118 lines
4.3 KiB
TOML
118 lines
4.3 KiB
TOML
[package]
|
|
name = "Readest"
|
|
version = "0.2.2"
|
|
description = "Your online library"
|
|
authors = ["Bilingify LLC"]
|
|
license = ""
|
|
repository = ""
|
|
edition = "2021"
|
|
rust-version = "1.77.2"
|
|
|
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
|
|
|
[lib]
|
|
name = "readestlib"
|
|
crate-type = ["staticlib", "cdylib", "lib"]
|
|
|
|
[features]
|
|
# Internal feature to suppress warnings from old objc crate
|
|
cargo-clippy = []
|
|
# Enable WebDriver plugin for E2E testing (use with `tauri build --debug --features webdriver`)
|
|
webdriver = ["tauri-plugin-webdriver"]
|
|
devtools = ["tauri/devtools"]
|
|
|
|
[build-dependencies]
|
|
tauri-build = { version = "2", features = [] }
|
|
|
|
[dependencies]
|
|
serde_json = "1.0"
|
|
serde = { version = "1.0", features = ["derive"] }
|
|
log = "0.4"
|
|
thiserror = "2"
|
|
walkdir = "2"
|
|
tokio = { version = "1", features = ["fs"] }
|
|
tokio-util = { version = "0.7", features = ["codec"] }
|
|
futures-util = "0.3"
|
|
futures = "0.3.31"
|
|
read-progress-stream = "1.0.0"
|
|
reqwest = { version = "0.12", default-features = false, features = [
|
|
"json",
|
|
"stream",
|
|
] }
|
|
tauri = { version = "2", features = [ "protocol-asset" ] }
|
|
tauri-build = "2"
|
|
tauri-plugin-log = "2"
|
|
tauri-plugin-fs = "2"
|
|
tauri-plugin-dialog = "2"
|
|
tauri-plugin-os = "2"
|
|
tauri-plugin-http = { version = "2", features = ["dangerous-settings"] }
|
|
tauri-plugin-shell = "2"
|
|
tauri-plugin-process = "2"
|
|
tauri-plugin-oauth = "2"
|
|
tauri-plugin-opener = "2"
|
|
tauri-plugin-deep-link = "2"
|
|
tauri-plugin-sign-in-with-apple = "1.0.2"
|
|
tauri-plugin-haptics = "2"
|
|
tauri-plugin-persisted-scope = "2"
|
|
tauri-plugin-native-bridge = { path = "./plugins/tauri-plugin-native-bridge" }
|
|
tauri-plugin-native-tts = { path = "./plugins/tauri-plugin-native-tts" }
|
|
tauri-plugin-webview-upgrade = { path = "./plugins/tauri-plugin-webview-upgrade" }
|
|
tauri-plugin-websocket = "2"
|
|
tauri-plugin-sharekit = "0.3"
|
|
tauri-plugin-clipboard-manager = "2"
|
|
tauri-plugin-device-info = "1.0.1"
|
|
tauri-plugin-turso = { path = "./plugins/tauri-plugin-turso" }
|
|
tauri-plugin-webdriver = { version = "0.2", optional = true }
|
|
|
|
# Native EPUB import path (Q1): zip + quick-xml + md5.
|
|
# Used by `epub_parser::parse_epub_metadata` (partialMD5 + downscaled
|
|
# cover) and `parse_epub_full` (OPF/nav/ncx prefetch + entry-size
|
|
# table) to do the mechanical zip work without ferrying multi-MB blobs
|
|
# across the JS<->Rust IPC boundary. Pure-Rust crates so they ship to
|
|
# every Tauri target (desktop, iOS, Android) without extra system deps.
|
|
zip = { version = "2", default-features = false, features = ["deflate"] }
|
|
quick-xml = "0.36"
|
|
md-5 = "0.10"
|
|
# Used by `epub_parser::read_zip_entry` as a fallback when an OPF/manifest
|
|
# href is percent-encoded (e.g. spaces as %20, CJK paths) but the zip stores
|
|
# the raw decoded bytes — or vice versa. Already in our transitive dep graph
|
|
# (reqwest pulls it), so adding it explicitly costs nothing.
|
|
percent-encoding = "2"
|
|
|
|
# Cover thumbnail generation (Q2). We decode the cover image extracted
|
|
# from the EPUB and, when its long edge exceeds the library-grid size,
|
|
# re-encode a smaller JPEG so the on-disk `cover.png` is suitable for
|
|
# webview rendering (~30-60 KB instead of multi-MB). Default features
|
|
# are disabled to keep the binary lean — we only need decoders for the
|
|
# formats EPUBs actually use (jpeg/png/gif) plus the JPEG encoder.
|
|
image = { version = "0.25", default-features = false, features = ["jpeg", "png", "gif"] }
|
|
|
|
# Native MOBI/AZW/AZW3 import path. Mirrors the EPUB fast-path: parse
|
|
# PalmDB + MobiHeader + EXTH in Rust to extract title/author/publisher/
|
|
# description/isbn/asin/subjects/language and the cover image, then
|
|
# return them to JS so the importer skips the foliate-js MOBI parser
|
|
# (which has to inflate the whole record stream up-front on the iOS
|
|
# WebView). Pure-Rust crate, ships to every Tauri target.
|
|
mobi = "0.8"
|
|
|
|
[target."cfg(target_os = \"macos\")".dependencies]
|
|
rand = "0.8"
|
|
cocoa = "0.25"
|
|
objc = "0.2.7"
|
|
objc-foundation = "0.1.1"
|
|
objc_id = "0.1.1"
|
|
block = "0.1.6"
|
|
objc2 = "0.6"
|
|
objc2-authentication-services = "0.3"
|
|
objc2-foundation = { version = "0.3", features = ["NSError", "NSArray"] }
|
|
|
|
[target.'cfg(any(target_os = "macos", windows, target_os = "linux"))'.dependencies]
|
|
tauri-plugin-cli = "2"
|
|
tauri-plugin-single-instance = "2"
|
|
tauri-plugin-updater = "2"
|
|
tauri-plugin-window-state = "2"
|
|
discord-rich-presence = "1.0.0"
|
|
|
|
[target.'cfg(target_os = "android")'.dependencies]
|
|
libc = "0.2"
|