mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-18 09:04:19 +01:00
162 lines
6.2 KiB
TypeScript
162 lines
6.2 KiB
TypeScript
import { registerFileAtWorker, unregisterFileAtWorker } from "@tursodatabase/database-wasm-common"
|
|
import { DatabasePromise } from "@tursodatabase/database-common"
|
|
import { ProtocolIo, run, DatabaseOpts, EncryptionOpts, RunOpts, DatabaseRowMutation, DatabaseRowStatement, DatabaseRowTransformResult, DatabaseStats, SyncEngineGuards } from "@tursodatabase/sync-common";
|
|
import { SyncEngine, SyncEngineProtocolVersion, initThreadPool, MainWorker } from "./index-default.js";
|
|
|
|
let BrowserIO: ProtocolIo = {
|
|
async read(path: string): Promise<Buffer | Uint8Array | null> {
|
|
const result = localStorage.getItem(path);
|
|
if (result == null) {
|
|
return null;
|
|
}
|
|
return new TextEncoder().encode(result);
|
|
},
|
|
async write(path: string, data: Buffer | Uint8Array): Promise<void> {
|
|
const array = new Uint8Array(data);
|
|
const value = new TextDecoder('utf-8').decode(array);
|
|
localStorage.setItem(path, value);
|
|
}
|
|
};
|
|
|
|
function memoryIO(): ProtocolIo {
|
|
let values = new Map();
|
|
return {
|
|
async read(path: string): Promise<Buffer | Uint8Array | null> {
|
|
return values.get(path);
|
|
},
|
|
async write(path: string, data: Buffer | Uint8Array): Promise<void> {
|
|
values.set(path, data);
|
|
}
|
|
}
|
|
};
|
|
|
|
async function init(): Promise<Worker> {
|
|
await initThreadPool();
|
|
if (MainWorker == null) {
|
|
throw new Error("panic: MainWorker is not initialized");
|
|
}
|
|
return MainWorker;
|
|
}
|
|
|
|
class Database extends DatabasePromise {
|
|
#runOpts: RunOpts;
|
|
#engine: any;
|
|
#io: ProtocolIo;
|
|
#guards: SyncEngineGuards;
|
|
#worker: Worker | null;
|
|
constructor(opts: DatabaseOpts) {
|
|
const engine = new SyncEngine({
|
|
path: opts.path,
|
|
clientName: opts.clientName,
|
|
useTransform: opts.transform != null,
|
|
protocolVersion: SyncEngineProtocolVersion.V1,
|
|
longPollTimeoutMs: opts.longPollTimeoutMs,
|
|
tracing: opts.tracing,
|
|
});
|
|
super(engine.db() as unknown as any);
|
|
|
|
|
|
let headers = typeof opts.authToken === "function" ? () => ({
|
|
...(opts.authToken != null && { "Authorization": `Bearer ${(opts.authToken as any)()}` }),
|
|
...(opts.encryption != null && {
|
|
"x-turso-encryption-key": opts.encryption.key,
|
|
"x-turso-encryption-cipher": opts.encryption.cipher,
|
|
})
|
|
}) : {
|
|
...(opts.authToken != null && { "Authorization": `Bearer ${opts.authToken}` }),
|
|
...(opts.encryption != null && {
|
|
"x-turso-encryption-key": opts.encryption.key,
|
|
"x-turso-encryption-cipher": opts.encryption.cipher,
|
|
})
|
|
};
|
|
this.#runOpts = {
|
|
url: opts.url,
|
|
headers: headers,
|
|
preemptionMs: 1,
|
|
transform: opts.transform,
|
|
};
|
|
this.#engine = engine;
|
|
this.#io = this.memory ? memoryIO() : BrowserIO;
|
|
this.#guards = new SyncEngineGuards();
|
|
}
|
|
/**
|
|
* connect database and initialize it in case of clean start
|
|
*/
|
|
override async connect() {
|
|
if (!this.memory) {
|
|
this.#worker = await init();
|
|
await Promise.all([
|
|
registerFileAtWorker(this.#worker, this.name),
|
|
registerFileAtWorker(this.#worker, `${this.name}-wal`),
|
|
registerFileAtWorker(this.#worker, `${this.name}-wal-revert`),
|
|
registerFileAtWorker(this.#worker, `${this.name}-info`),
|
|
registerFileAtWorker(this.#worker, `${this.name}-changes`),
|
|
]);
|
|
}
|
|
await run(this.#runOpts, this.#io, this.#engine, this.#engine.connect());
|
|
}
|
|
/**
|
|
* pull new changes from the remote database
|
|
* if {@link DatabaseOpts.longPollTimeoutMs} is set - then server will hold the connection open until either new changes will appear in the database or timeout occurs.
|
|
* @returns true if new changes were pulled from the remote
|
|
*/
|
|
async pull() {
|
|
const changes = await this.#guards.wait(async () => await run(this.#runOpts, this.#io, this.#engine, this.#engine.wait()));
|
|
if (changes.empty()) {
|
|
return false;
|
|
}
|
|
await this.#guards.apply(async () => await run(this.#runOpts, this.#io, this.#engine, this.#engine.apply(changes)));
|
|
return true;
|
|
}
|
|
/**
|
|
* push new local changes to the remote database
|
|
* if {@link DatabaseOpts.transform} is set - then provided callback will be called for every mutation before sending it to the remote
|
|
*/
|
|
async push() {
|
|
await this.#guards.push(async () => await run(this.#runOpts, this.#io, this.#engine, this.#engine.push()));
|
|
}
|
|
/**
|
|
* checkpoint WAL for local database
|
|
*/
|
|
async checkpoint() {
|
|
await this.#guards.checkpoint(async () => await run(this.#runOpts, this.#io, this.#engine, this.#engine.checkpoint()));
|
|
}
|
|
/**
|
|
* @returns statistic of current local database
|
|
*/
|
|
async stats(): Promise<DatabaseStats> {
|
|
return (await run(this.#runOpts, this.#io, this.#engine, this.#engine.stats()));
|
|
}
|
|
/**
|
|
* close the database and relevant files
|
|
*/
|
|
async close() {
|
|
if (this.name != null && this.#worker != null) {
|
|
await Promise.all([
|
|
unregisterFileAtWorker(this.#worker, this.name),
|
|
unregisterFileAtWorker(this.#worker, `${this.name}-wal`),
|
|
unregisterFileAtWorker(this.#worker, `${this.name}-wal-revert`),
|
|
unregisterFileAtWorker(this.#worker, `${this.name}-info`),
|
|
unregisterFileAtWorker(this.#worker, `${this.name}-changes`),
|
|
]);
|
|
}
|
|
await super.close();
|
|
this.#engine.close();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a new database connection asynchronously.
|
|
*
|
|
* @param {Object} opts - Options for database behavior.
|
|
* @returns {Promise<Database>} - A promise that resolves to a Database instance.
|
|
*/
|
|
async function connect(opts: DatabaseOpts): Promise<Database> {
|
|
const db = new Database(opts);
|
|
await db.connect();
|
|
return db;
|
|
}
|
|
|
|
export { connect, Database }
|
|
export type { DatabaseOpts, EncryptionOpts, DatabaseRowMutation, DatabaseRowStatement, DatabaseRowTransformResult }
|