Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(ext/node): support read-only database in node:sqlite #27930

Merged
merged 1 commit into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions ext/node/ops/sqlite/database.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ struct DatabaseSyncOptions {
open: bool,
#[serde(default = "true_fn")]
enable_foreign_key_constraints: bool,
read_only: bool,
}

fn true_fn() -> bool {
Expand All @@ -31,6 +32,7 @@ impl Default for DatabaseSyncOptions {
DatabaseSyncOptions {
open: true,
enable_foreign_key_constraints: true,
read_only: false,
}
}
}
Expand All @@ -43,17 +45,31 @@ pub struct DatabaseSync {

impl GarbageCollected for DatabaseSync {}

fn check_perms(state: &mut OpState, location: &str) -> Result<(), SqliteError> {
if location != ":memory:" {
state
.borrow::<PermissionsContainer>()
.check_read_with_api_name(location, Some("node:sqlite"))?;
state
.borrow::<PermissionsContainer>()
.check_write_with_api_name(location, Some("node:sqlite"))?;
fn open_db(
state: &mut OpState,
readonly: bool,
location: &str,
) -> Result<rusqlite::Connection, SqliteError> {
if location == ":memory:" {
return Ok(rusqlite::Connection::open_in_memory()?);
}

Ok(())
state
.borrow::<PermissionsContainer>()
.check_read_with_api_name(location, Some("node:sqlite"))?;

if readonly {
return Ok(rusqlite::Connection::open_with_flags(
location,
rusqlite::OpenFlags::SQLITE_OPEN_READ_ONLY,
)?);
}

state
.borrow::<PermissionsContainer>()
.check_write_with_api_name(location, Some("node:sqlite"))?;

Ok(rusqlite::Connection::open(location)?)
}

// Represents a single connection to a SQLite database.
Expand All @@ -75,9 +91,8 @@ impl DatabaseSync {
let options = options.unwrap_or_default();

let db = if options.open {
check_perms(state, &location)?;
let db = open_db(state, options.read_only, &location)?;

let db = rusqlite::Connection::open(&location)?;
if options.enable_foreign_key_constraints {
db.execute("PRAGMA foreign_keys = ON", [])?;
}
Expand All @@ -104,8 +119,7 @@ impl DatabaseSync {
return Err(SqliteError::AlreadyOpen);
}

check_perms(state, &self.location)?;
let db = rusqlite::Connection::open(&self.location)?;
let db = open_db(state, self.options.read_only, &self.location)?;
if self.options.enable_foreign_key_constraints {
db.execute("PRAGMA foreign_keys = ON", [])?;
}
Expand Down
29 changes: 28 additions & 1 deletion tests/unit_node/sqlite_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
import { DatabaseSync } from "node:sqlite";
import { assert, assertEquals, assertThrows } from "@std/assert";

const tempDir = Deno.makeTempDirSync();

Deno.test("[node/sqlite] in-memory databases", () => {
const db1 = new DatabaseSync(":memory:");
const db2 = new DatabaseSync(":memory:");
Expand Down Expand Up @@ -40,7 +42,6 @@ Deno.test(
name: "[node/sqlite] PRAGMAs are supported",
},
() => {
const tempDir = Deno.makeTempDirSync();
const db = new DatabaseSync(`${tempDir}/test.db`);

assertEquals(db.prepare("PRAGMA journal_mode = WAL").get(), {
Expand Down Expand Up @@ -99,5 +100,31 @@ Deno.test({
assertThrows(() => {
new DatabaseSync("test.db");
}, Deno.errors.NotCapable);
assertThrows(() => {
new DatabaseSync("test.db", { readOnly: true });
}, Deno.errors.NotCapable);
},
});

Deno.test({
name: "[node/sqlite] readOnly database",
permissions: { read: true, write: true },
fn() {
{
const db = new DatabaseSync(`${tempDir}/test3.db`);
db.exec("CREATE TABLE foo (id INTEGER PRIMARY KEY)");
db.close();
}
{
const db = new DatabaseSync(`${tempDir}/test3.db`, { readOnly: true });
assertThrows(
() => {
db.exec("CREATE TABLE test(key INTEGER PRIMARY KEY)");
},
Error,
"attempt to write a readonly database",
);
db.close();
}
},
});