feat: add browserdata/datautil helpers (#513)

* feat: add browserdata/datautil helpers (QuerySQLite, QueryRows, DecryptChromiumValue)

Phase 2 of architecture refactoring (RFC-002 Section 3):

- datautil/sqlite.go: QuerySQLite() — shared SQLite open/query/scan helper
  with optional journal_mode=off for Firefox databases
- datautil/query.go: QueryRows[T]() — generic helper (Go 1.20) that wraps
  QuerySQLite and collects results into a typed slice
- datautil/decrypt.go: DecryptChromiumValue() — unified Chromium decryption
  (DPAPI first, then AES-GCM/CBC fallback)
- datautil/sqlite_test.go: tests for all helpers

* refactor: move DecryptChromiumValue from datautil to browser/chromium

- Remove browserdata/datautil/decrypt.go (Chromium-specific, not a generic util)
- Will be added as browser/chromium/decrypt.go (unexported decryptValue)
  in the chromium extract methods PR
- Update RFCs to reflect the change
- Remove decrypt test from datautil tests

* refactor: move datautil to utils/sqliteutil for consistency

- Rename browserdata/datautil/ → utils/sqliteutil/
- Aligns with existing utils/ convention (fileutil, typeutil, byteutil)
- QuerySQLite/QueryRows are generic SQLite helpers, not browserdata-specific
- Update package name from datautil to sqliteutil
- Update both RFCs to reflect new location

* fix: apply review suggestions for sqliteutil

- QuerySQLite: validate dbPath exists before sql.Open to prevent
  silently creating empty databases
- Tests: check db.Close() errors with require.NoError
This commit is contained in:
Roger
2026-03-24 23:27:31 +08:00
committed by moonD4rk
parent b680d43caa
commit e86e3e62d6
5 changed files with 231 additions and 36 deletions
+21
View File
@@ -0,0 +1,21 @@
package sqliteutil
import "database/sql"
// QueryRows is a generic helper (Go 1.18+) that wraps QuerySQLite and collects
// results into a typed slice. Each extract method only needs to provide the
// scan function that converts one database row into a typed value.
//
// Rows that fail to scan are skipped (logged at debug level by QuerySQLite).
func QueryRows[T any](dbPath string, journalOff bool, query string, scanRow func(*sql.Rows) (T, error)) ([]T, error) {
var items []T
err := QuerySQLite(dbPath, journalOff, query, func(rows *sql.Rows) error {
item, err := scanRow(rows)
if err != nil {
return err
}
items = append(items, item)
return nil
})
return items, err
}
+51
View File
@@ -0,0 +1,51 @@
package sqliteutil
import (
"database/sql"
"fmt"
"os"
// sqlite3 driver for database/sql
_ "modernc.org/sqlite"
"github.com/moond4rk/hackbrowserdata/log"
)
// QuerySQLite opens a SQLite database, optionally disables journal mode (required
// for Firefox databases), runs the query, and calls scanFn for each row.
//
// It validates the database file exists before opening to prevent sql.Open from
// silently creating an empty database.
//
// scanFn should return nil to continue iteration, or an error to skip the current
// row (the error is logged at debug level and iteration continues).
func QuerySQLite(dbPath string, journalOff bool, query string, scanFn func(*sql.Rows) error) error {
if _, err := os.Stat(dbPath); err != nil {
return fmt.Errorf("database file: %w", err)
}
db, err := sql.Open("sqlite", dbPath)
if err != nil {
return err
}
defer db.Close()
if journalOff {
if _, err := db.Exec("PRAGMA journal_mode=off"); err != nil {
return err
}
}
rows, err := db.Query(query)
if err != nil {
return err
}
defer rows.Close()
for rows.Next() {
if err := scanFn(rows); err != nil {
log.Debugf("scan row error: %v", err)
continue
}
}
return rows.Err()
}
+138
View File
@@ -0,0 +1,138 @@
package sqliteutil
import (
"database/sql"
"path/filepath"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestQuerySQLite(t *testing.T) {
// Create a temp SQLite database
dir := t.TempDir()
dbPath := filepath.Join(dir, "test.db")
db, err := sql.Open("sqlite", dbPath)
require.NoError(t, err)
_, err = db.Exec("CREATE TABLE items (id INTEGER, name TEXT)")
require.NoError(t, err)
_, err = db.Exec("INSERT INTO items VALUES (1, 'alpha'), (2, 'beta'), (3, 'gamma')")
require.NoError(t, err)
require.NoError(t, db.Close())
// Query using our helper
var names []string
err = QuerySQLite(dbPath, false, "SELECT name FROM items ORDER BY id", func(rows *sql.Rows) error {
var name string
if err := rows.Scan(&name); err != nil {
return err
}
names = append(names, name)
return nil
})
assert.NoError(t, err)
assert.Equal(t, []string{"alpha", "beta", "gamma"}, names)
}
func TestQuerySQLite_JournalOff(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "test.db")
db, err := sql.Open("sqlite", dbPath)
require.NoError(t, err)
_, err = db.Exec("CREATE TABLE t (v TEXT)")
require.NoError(t, err)
_, err = db.Exec("INSERT INTO t VALUES ('ok')")
require.NoError(t, err)
require.NoError(t, db.Close())
var values []string
err = QuerySQLite(dbPath, true, "SELECT v FROM t", func(rows *sql.Rows) error {
var v string
if err := rows.Scan(&v); err != nil {
return err
}
values = append(values, v)
return nil
})
assert.NoError(t, err)
assert.Equal(t, []string{"ok"}, values)
}
func TestQuerySQLite_FileNotFound(t *testing.T) {
err := QuerySQLite("/nonexistent/path.db", false, "SELECT 1", func(rows *sql.Rows) error {
return nil
})
assert.Error(t, err)
}
func TestQuerySQLite_BadQuery(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "test.db")
db, err := sql.Open("sqlite", dbPath)
require.NoError(t, err)
_, err = db.Exec("CREATE TABLE t (v TEXT)")
require.NoError(t, err)
require.NoError(t, db.Close())
err = QuerySQLite(dbPath, false, "SELECT nonexistent FROM t", func(rows *sql.Rows) error {
return nil
})
assert.Error(t, err)
}
func TestQueryRows(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "test.db")
db, err := sql.Open("sqlite", dbPath)
require.NoError(t, err)
_, err = db.Exec("CREATE TABLE users (name TEXT, age INTEGER)")
require.NoError(t, err)
_, err = db.Exec("INSERT INTO users VALUES ('alice', 30), ('bob', 25)")
require.NoError(t, err)
require.NoError(t, db.Close())
type user struct {
Name string
Age int
}
users, err := QueryRows(dbPath, false, "SELECT name, age FROM users ORDER BY name",
func(rows *sql.Rows) (user, error) {
var u user
err := rows.Scan(&u.Name, &u.Age)
return u, err
})
assert.NoError(t, err)
assert.Equal(t, []user{{"alice", 30}, {"bob", 25}}, users)
}
func TestQueryRows_Empty(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "test.db")
db, err := sql.Open("sqlite", dbPath)
require.NoError(t, err)
_, err = db.Exec("CREATE TABLE empty (v TEXT)")
require.NoError(t, err)
require.NoError(t, db.Close())
results, err := QueryRows(dbPath, false, "SELECT v FROM empty",
func(rows *sql.Rows) (string, error) {
var v string
if err := rows.Scan(&v); err != nil {
return "", err
}
return v, nil
})
assert.NoError(t, err)
assert.Nil(t, results)
}