sqlite-persistence: deleted rows keep their full value in the tombstone table forever (local-only collections)

オープン
#2,344 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
node.js, sqlite, typescript

調査の方向性

Start with the tombstone INSERT that uses value = excluded.value in sqlite-core-adapter.js, and the mutation.original read in persisted.js that supplies the value. Reproduce with the Node snippet in the issue and check the sqlite_master tables for the value. Done means deleted rows keep only key and row version in tombstones, or a supported way to clear a local-only collection exists; this touches the sync and pruning logic, so design input from maintainers is needed first.

索引モデルが issue の本文から書いたものです。

説明

Versions: @tanstack/db, @tanstack/db-sqlite-persistence-core, @tanstack/node-db-sqlite-persistence, @tanstack/browser-db-sqlite-persistence and @tanstack/expo-db-sqlite-persistence 1.0.0-rc.1.2.

What happens

In a persisted collection with no sync (persistedCollectionOptions without sync, writes through utils.acceptMutations), deleting a row writes the row's whole value to the collection's tombstone table (t_<hash>). Nothing removes it later: a tombstone goes only when the same key is written again, on a truncate, or on a schema reset. A local-only collection can't truncate. The value also stays in applied_tx.replay_json until that table is pruned (1000 rows / 24 h by default).

So after delete(), the row is gone from the collection but still readable in the SQLite file (OPFS on the web, the app's files on phones).

Repro (Node)

import Database from 'better-sqlite3'
import { createCollection, createTransaction } from '@tanstack/db'
import { persistedCollectionOptions } from '@tanstack/db-sqlite-persistence-core'
import { createNodeSQLitePersistence } from '@tanstack/node-db-sqlite-persistence'

const database = new Database(':memory:')
const todos = createCollection(
  persistedCollectionOptions<{ id: string; text: string }, string>({
    id: 'todos',
    getKey: (todo) => todo.id,
    persistence: createNodeSQLitePersistence({ database }),
  }),
)
await todos.preload()
const write = async (change: () => void) => {
  const tx = createTransaction({
    autoCommit: false,
    mutationFn: async ({ transaction }) => {
      await todos.utils.acceptMutations(transaction)
    },
  })
  tx.mutate(change)
  await tx.commit()
}
await write(() => todos.insert({ id: '1', text: 'private note' }))
await write(() => todos.delete('1'))

console.log(todos.size) // 0
for (const { name } of database.prepare(`SELECT name FROM sqlite_master WHERE type = 'table'`).all()) {
  const rows = database.prepare(`SELECT * FROM "${name}"`).all()
  if (JSON.stringify(rows).includes('private note')) console.log(name)
}
// applied_tx    (replay_json has the inserted value)
// t_bicmgyk_5   {"key":"s:1","value":"{\"id\":\"1\",\"text\":\"private note\"}","row_version":2,"deleted_at":"…"}

Why it matters

  • Privacy on shared devices. We clear a person's data at Sign Out by deleting their rows. With this behaviour the next person on the device (or a script on the site) can still read them from the file. We now delete the whole SQLite file at Sign Out instead.
  • Growth. Every row that's written once and deleted (an outbox entry, say) leaves a tombstone for good, so the file grows without limit.

What would help

Any of these:

  • Store only the key (and row version) in a tombstone, not the value.
  • Prune tombstones (by count or age, like appliedTxPruneMaxRows / appliedTxPruneMaxAgeSeconds) once no tab needs them for catch-up.
  • A supported way to empty a local-only collection completely, tombstones and applied_tx included (a local truncate), or to delete a collection's tables.

The relevant code is in sqlite-core-adapter.js: the tombstone INSERT … value = excluded.value for deletes, and the only DELETE FROM tombstone paths (a truncate, a re-write of the same key, a schema reset). The value comes from mutation.original in persisted.js.

主要言語
TypeScript
スター
4k
フォーク
286
平均マージ
1日 8時間
マージ済み PR(30日)
105

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TanStack/db のほかの issue

TanStack/db の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。