akai-tools/readest
2
0
Fork 0
forked from akai/readest
Code Pull Requests Activity
Files
fc71ca9857d009fa01feaedc515d3c24c3e78708
readest/apps/readest-app/.claude/memory/share-feature.md
T
Huang Xin d1e7b4902c feat(share): time-limited share links with cfi-aware imports (#4037) 
Add a Share Book feature that generates an expiring HTTPS share URL plus a
parallel readest://share/{token} deep link. Recipients land on /s/{token},
where logged-in users can one-tap "Add to my library" (R2 server-side
byte-copy) and anonymous users download the book or open it in the app.
Sharers manage active links from a dedicated "Manage Shared Links" panel
under user settings.

Highlights:
- 9 new App Router endpoints under /api/share (create, [token], cover,
  og.png, download, download/confirm, import, revoke, list).
- /s landing page with branded next/og chat unfurl image and SSR auth-cookie
  detection so logged-in recipients see "Add to my library" as the primary
  action without layout shift.
- Server-side R2 byte-copy for /import preserves the project's existing
  invariant that every files.file_key is prefixed with its row's user_id;
  stats / purge / delete / download routes work unchanged. URL-encodes the
  copy source so titles with spaces or '&' don't break the copy.
- Universal 7-day expiry cap, no tier differentiation, no "never". DMCA-risk
  reduction. Picker defaults to 3 days.
- Position-aware shares: "Share current page" toggle (off by default for
  privacy) attaches the sharer's CFI; recipient lands at the same paragraph.
- Per-user 50-share cap, rate limiting via Cache-Control: no-store on
  token-bearing responses, atomic SQL increment for download_count via a
  SECURITY DEFINER function so the public confirm beacon stays safe under
  concurrent fire.
- Soft revocation: presigned download URLs (5-min TTL) cannot be cancelled
  before TTL; documented as accepted v1 behavior.
- token + token_hash hybrid storage: public endpoints look up by hash and
  never select the raw token, so accidental SELECT-* leakage on a public
  route can't expose the bearer credential.
- Mobile / desktop Tauri share via tauri-plugin-sharekit; web falls back to
  navigator.share with a clipboard fallback when no native share method
  exists. Share-sheet dismissal no longer silently copies.

UI:
- New Dialog with a settings-card group: iOS-style segmented duration picker
  + toggle slider for "Share current page", on a single row each.
- Reader top-bar Share button, library context-menu Share entry, manage-
  shares list with cover thumbnails and overflow menu.
- New <SegmentedControl> primitive in src/components for reuse.

Coverage:
- Unit tests for token utils + URL parser (20 new tests, full suite at 3445).
- 31 locales translated for all new strings; en plurals hand-added per the
  project's hand-curated en convention.

DB migration in docker/volumes/db/migrations/002_add_book_shares.sql adds
the book_shares table, RLS policies, and the increment_book_share_download
RPC. Migration is idempotent.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 19:03:35 +02:00

4.6 KiB
Raw Blame History

name, description, type, originSessionId
name description type originSessionId
Share-a-Book Feature (in progress) Active implementation of /s/{token} share links + cherry-picks (CFI auto-include, 1-tap library import, branded OG images). All locked decisions and the plan file path. project e4ddc690-b1a9-4557-855f-d4e67055824f

Active feature on branch dev as of 2026-05-02. Plan file: /Users/chrox/.claude/plans/ok-we-will-learn-cosmic-acorn.md (always read for source of truth before continuing).

Why: complement just-shipped annotation deep-links (PRs #4018, #4019) with whole-book sharing. Cloud-sync infra exists; this layers public time-limited links on top.

How to apply: these decisions are locked across CEO + eng + design reviews. Do NOT re-litigate when implementing.

Locked decisions (authoritative)

  • Universal 7-day cap on share expiry, no tier differentiation, no "Never". All users pick [1, 3, 7] days. DMCA-risk reduction.
  • App Router for all share routes (mirrors /o precedent + recent Stripe / AI / IAP / OPDS). Pages API storage/* neighbors stay where they are.
  • Single non-dynamic landing page at src/app/s/page.tsx + rewrite '/s/:token' → '/s?token=:token' in next.config.mjs. Mirrors /o's pattern exactly. Avoids [token] dynamic-segment trap under output: 'export'.
  • R2 server-side byte-copy for /import (recipient-side library import). NOT a reference. Preserves invariant that every files row's file_key starts with that row's user_id — keeps stats / purge / delete / download routes working unchanged.
  • token_hash (sha256) in DB, never the raw token. Raw token shown to user once at create.
  • Live (user_id, book_hash) resolution at every access (no FK to files). Re-uploads of the same hash follow the share automatically.
  • GET /download is a 302 redirect with NO DB writes. Count via separate POST /download/confirm so unfurlers / prefetchers can't inflate counts.
  • Atomic SQL download_count = download_count + 1, not read-modify-write.
  • Per-user 50-share cap, enforced at create-time.
  • Auth detection on /s landing: server-render via Supabase auth cookie in app/s/layout.tsx. No layout shift. Falls back to anonymous flow + post-hydration upgrade if SSR fails.
  • Cover-less og.png fallback: text-only display-type card. NO placeholder rectangle, NO procedural pattern.
  • Universal Links / App Links: handle https://web.readest.com/s/... in v1 via useOpenShareLink. Tauri's applinks config already covers the host.

Cherry-picks accepted (CEO review SELECTIVE EXPANSION)

  1. Position-aware share — every share initiated from the reader auto-includes cfi; recipient lands at sharer's paragraph. Toggle in dialog (default on, only visible when reader-context).
  2. 1-tap "Add to my library" — logged-in recipient on /s gets primary action that calls /import (R2 byte-copy) and navigates to /reader?ids=...&cfi=....
  3. Branded OG image — /api/share/[token]/og.png server-renders via @vercel/og. Spec includes anti-slop checklist.

Deferred to TODOS.md: QR code on landing, notify-on-download toggle.

Open implementation questions (resolve mid-build)

  1. Upload-confirmation: HEAD R2 in /create, or add uploaded_at column to files? — recommend HEAD.
  2. Migration directory: project has no apps/readest-app/supabase/migrations/. Confirm where SQL actually lands before writing the file.
  3. @vercel/og runtime compat with CloudFlare Workers (OpenNextJS). Verify before relying on it; fallback to Satori + sharp if incompatible.
  4. App Router route handlers under src/app/api/share/... should be silently dropped by output: 'export' in Next 16.2.3. Confirm during first Tauri build.

Critical files for implementation

See "Critical Files (modify or create)" table in the plan. Key starting points:

  • src/libs/storage-server.ts — extract getDownloadSignedUrl from pages/api/storage/download.ts
  • src/libs/share-server.ts (new) — generateShareToken(), hashShareToken(raw)
  • src/libs/share.ts (new) — typed client used by dialog, manage section, deeplink hook, landing page
  • src/utils/share.ts (new) — buildShareUrl(token), parseShareDeepLink(url)
  • Dialog reference: src/components/Dialog.tsx, BookDetailModal.tsx
  • Landing reference: src/app/o/page.tsx (lift Card, BrandHeader, PageFooter to src/components/landing/)
  • Deeplink hook reference: src/hooks/useOpenAnnotationLink.ts, useOpenWithBooks.ts
  • App-level upload entry: appService.uploadBook(book) at src/services/appService.ts:269 (NOT cloudService.uploadBook — lower-level fn)
View Git Blame Copy Permalink