Skip to content

docs: state the browser engine boundaries - #21

Merged
cardmagic merged 1 commit into
mainfrom
docs/browser-engine-support
Aug 23, 2026
Merged

docs: state the browser engine boundaries#21
cardmagic merged 1 commit into
mainfrom
docs/browser-engine-support

Conversation

@cardmagic

Copy link
Copy Markdown
Owner

The support matrix said only "Chromium through Playwright", which leaves the most common adoption question unanswered: does the browser runtime work in my WebView? An agent evaluating the library for a Cordova/WKWebView app hit exactly that wall.

docs/support.md now answers it in three parts:

  • What gates persistence: OPFS sync access handles in a dedicated worker — Chromium has them, Safari since 16.4, Firefox since 111.
  • What the multi-tab hosts need: the Web Locks API and BroadcastChannel, available in every current engine.
  • Why a WebView is not the platform browser: Cordova and other WKWebView or Android WebView shells can lack OPFS even when the device's browser has it. sqliteWasm({ storage: "persistent" }) fails fast where OPFS is missing and temporary storage works wherever the WASM module loads, so the note prescribes probing the target WebView before committing to durable in-app state.

Docs-only; check:documentation passes.

The support matrix named only Chromium, so an agent evaluating the
browser runtime for a Cordova app had no answer for WKWebView. The
runtime support section now separates the three questions: which API
gates persistence (OPFS sync access handles, with the Safari 16.4 and
Firefox 111 arrival points), which APIs the multi-tab hosts need (Web
Locks and BroadcastChannel, universally available), and why an
embedded WebView must be probed even when the platform browser
qualifies. Fail-fast persistent open and everywhere-working temporary
storage give the probe a safe shape.
@greptile-apps

greptile-apps Bot commented Aug 23, 2026

Copy link
Copy Markdown

Greptile Summary

Adds browser-runtime support boundaries and deployment guidance to the support documentation.

  • Identifies OPFS sync access handles as the persistent-storage requirement.
  • Documents the Web Locks and BroadcastChannel requirements for multi-tab hosts.
  • Warns that embedded WebViews may differ from platform browsers and recommends probing the target runtime.

Confidence Score: 5/5

The documentation-only PR appears safe to merge.

The added guidance accurately distinguishes persistent OPFS storage, temporary storage, and multi-tab browser requirements without changing runtime behavior or introducing a documented contradiction.

Important Files Changed

Filename Overview
docs/support.md The new browser compatibility guidance is consistent with the repository’s direct SQLite WASM and multi-tab host behavior; no actionable issue was identified.

Reviews (1): Last reviewed commit: "docs: state the browser engine boundarie..." | Re-trigger Greptile

@cardmagic
cardmagic merged commit 0cad795 into main Aug 23, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant