@verdant-web/server 2.1.2 → 3.0.0-next.0

package/src/Replicas.ts

@@ -1,274 +0,0 @@
-import { Database } from 'better-sqlite3';
-import { TokenInfo } from './TokenVerifier.js';
-import { ReplicaInfoSpec } from './types.js';
-
-export class ReplicaInfos {
-	constructor(
-		private db: Database,
-		private readonly replicaTruancyMinutes: number,
-	) {}
-
-	get truantCutoff() {
-		return Date.now() - this.replicaTruancyMinutes * 60 * 1000;
-	}
-
-	get = (libraryId: string, replicaId: string): ReplicaInfoSpec | null => {
-		const row = this.db
-			.prepare(
-				`
-					SELECT * FROM ReplicaInfo
-					WHERE id = ? AND libraryId = ?
-				`,
-			)
-			.get(replicaId, libraryId);
-		if (!row) {
-			return null;
-		}
-		return {
-			id: row.id,
-			libraryId: row.libraryId,
-			clientId: row.clientId,
-			lastSeenWallClockTime: row.lastSeenWallClockTime,
-			ackedLogicalTime: row.ackedLogicalTime,
-			type: row.type,
-			ackedServerOrder: row.ackedServerOrder,
-		};
-	};
-
-	getOrCreate = (
-		libraryId: string,
-		replicaId: string,
-		info: TokenInfo,
-	): {
-		status: 'new' | 'existing' | 'truant';
-		replicaInfo: ReplicaInfoSpec;
-	} => {
-		const replicaInfo: ReplicaInfoSpec = this.db
-			.prepare(
-				`
-			SELECT * FROM ReplicaInfo
-			WHERE id = ? AND libraryId = ?
-			`,
-			)
-			.get(replicaId, libraryId);
-
-		if (!replicaInfo) {
-			this.db
-				.prepare(
-					`
-			INSERT INTO ReplicaInfo (id, clientId, libraryId, type)
-			VALUES (?, ?, ?, ?)
-			`,
-				)
-				.run(replicaId, info.userId, libraryId, info.type);
-
-			return {
-				status: 'new',
-				replicaInfo: {
-					id: replicaId,
-					clientId: info.userId,
-					ackedLogicalTime: null,
-					lastSeenWallClockTime: null,
-					libraryId: libraryId,
-					type: info.type,
-					ackedServerOrder: 0,
-				},
-			};
-		}
-
-		if (replicaInfo.type !== info.type) {
-			// type should be updated if a new token changes it
-			this.db
-				.prepare(
-					`
-					UPDATE ReplicaInfo
-					SET type = ?
-					WHERE id = ? AND libraryId = ?
-					`,
-				)
-				.run(info.type, replicaId, libraryId);
-		}
-
-		if (replicaInfo.clientId !== info.userId) {
-			throw new Error(
-				`Replica ${replicaId} already exists with a different user ID`,
-			);
-		}
-
-		if (
-			replicaInfo.lastSeenWallClockTime &&
-			replicaInfo.lastSeenWallClockTime < this.truantCutoff
-		) {
-			return {
-				status: 'truant',
-				replicaInfo,
-			};
-		}
-
-		return {
-			status: 'existing',
-			replicaInfo,
-		};
-	};
-
-	getAllNonTruant = (libraryId: string): ReplicaInfoSpec[] => {
-		return this.db
-			.prepare(
-				`
-			SELECT * FROM ReplicaInfo
-			WHERE libraryId = ? AND lastSeenWallClockTime > ?
-		`,
-			)
-			.all(libraryId, this.truantCutoff);
-	};
-
-	getAll = (libraryId: string): ReplicaInfoSpec[] => {
-		return this.db
-			.prepare(
-				`
-			SELECT * FROM ReplicaInfo
-			WHERE libraryId = ?
-		`,
-			)
-			.all(libraryId);
-	};
-
-	updateLastSeen = (libraryId: string, replicaId: string) => {
-		const clockTime = new Date().getTime();
-		return this.db
-			.prepare(
-				`
-      UPDATE ReplicaInfo
-      SET lastSeenWallClockTime = ?
-      WHERE id = ? AND libraryId = ?
-    `,
-			)
-			.run(clockTime, replicaId, libraryId);
-	};
-
-	updateAcknowledged = (
-		libraryId: string,
-		replicaId: string,
-		timestamp: string,
-	) => {
-		this.db
-			.prepare(
-				`
-			UPDATE ReplicaInfo
-			SET ackedLogicalTime = ?
-			WHERE id = ? AND libraryId = ?
-		`,
-			)
-			.run(timestamp, replicaId, libraryId);
-	};
-
-	updateServerOrder = (
-		libraryId: string,
-		replicaId: string,
-		serverOrder: number,
-	) => {
-		// only increment the server order, never set it to lower than before
-		this.db
-			.prepare(
-				`
-			UPDATE ReplicaInfo
-			SET ackedServerOrder = MAX(ackedServerOrder, ?)
-			WHERE id = ? AND libraryId = ?
-		`,
-			)
-			.run(serverOrder, replicaId, libraryId);
-	};
-
-	getEarliestAckedServerOrder = (libraryId: string) => {
-		// get the earliest acked server order of all non-truant replicas
-		const allAcks = (
-			this.db
-				.prepare(
-					`
-			SELECT ackedServerOrder FROM ReplicaInfo
-			WHERE libraryId = ?
-			AND lastSeenWallClockTime > ?
-		`,
-				)
-				.all(libraryId, this.truantCutoff) as {
-				ackedServerOrder: number | null;
-			}[]
-		).map((row: { ackedServerOrder: number | null }) => row.ackedServerOrder);
-
-		if (allAcks.some((ack) => ack === null)) {
-			return null;
-		}
-		return Math.min(...(allAcks as number[]));
-	};
-
-	acknowledgeOperation = (
-		libraryId: string,
-		replicaId: string,
-		timestamp: string,
-	) => {
-		if (!timestamp) return;
-
-		// get the server order from the operation with the timestamp and update the replica's server order
-		// to the max of the current server order and the server order of the operation
-		this.db
-			.prepare(
-				`
-			UPDATE ReplicaInfo
-			SET ackedLogicalTime = ?, ackedServerOrder = MAX(ackedServerOrder, COALESCE((
-				SELECT serverOrder FROM OperationHistory
-				WHERE libraryId = ? AND timestamp = ?
-			), 0))
-			WHERE id = ? AND libraryId = ?
-			`,
-			)
-			.run(timestamp, libraryId, timestamp, replicaId, libraryId);
-	};
-
-	getGlobalAck = (libraryId: string, onlineReplicaIds?: string[]) => {
-		const nonTruant = this.getAllNonTruant(libraryId);
-		const globalAckEligible = nonTruant.filter(
-			(replica) => replica.type < 2 || onlineReplicaIds?.includes(replica.id),
-		);
-		// get the earliest acked time
-		return globalAckEligible.reduce(
-			(acc, replica) => {
-				if (!replica.ackedLogicalTime) {
-					return acc;
-				}
-				if (acc === undefined) {
-					return replica.ackedLogicalTime;
-				}
-				return acc < replica.ackedLogicalTime ? acc : replica.ackedLogicalTime;
-			},
-			undefined as string | undefined,
-		);
-	};
-
-	delete = (libraryId: string, replicaId: string) => {
-		return this.db
-			.prepare(
-				`
-			DELETE FROM ReplicaInfo
-			WHERE id = ? AND libraryId = ?
-		`,
-			)
-			.run(replicaId, libraryId);
-	};
-
-	deleteAll = (libraryId: string) => {
-		return this.db
-			.prepare(
-				`
-			DELETE FROM ReplicaInfo
-			WHERE libraryId = ?
-		`,
-			)
-			.run(libraryId);
-	};
-
-	deleteAllForUser = (libraryId: string, userId: string) => {
-		return this.db
-			.prepare(`DELETE FROM ReplicaInfo WHERE libraryId = ? AND clientId = ?`)
-			.run(libraryId, userId);
-	};
-}

package/src/files/FileMetadata.ts

@@ -1,112 +0,0 @@
-import { Database } from 'better-sqlite3';
-import { FileInfo } from './FileStorage.js';
-
-export interface FileMetadataConfig {
-	deleteExpirationDays?: number;
-}
-
-export class FileMetadata {
-	private deleteExpirationDays = 1;
-
-	constructor(
-		private db: Database,
-		{ deleteExpirationDays = 1 }: FileMetadataConfig = {},
-	) {
-		this.deleteExpirationDays = deleteExpirationDays;
-	}
-
-	get = (
-		libraryId: string,
-		fileId: string,
-	): {
-		libraryId: string;
-		fileId: string;
-		name: string;
-		type: string;
-	} => {
-		return this.db
-			.prepare(
-				`
-      SELECT * FROM FileMetadata
-      WHERE libraryId = ? AND fileId = ?
-    `,
-			)
-			.get(libraryId, fileId);
-	};
-
-	getAll = (libraryId: string) => {
-		return this.db
-			.prepare(
-				`
-			SELECT * FROM FileMetadata
-			WHERE libraryId = ?
-		`,
-			)
-			.all(libraryId);
-	};
-
-	deleteAll = (libraryId: string) => {
-		return this.db
-			.prepare(
-				`
-			DELETE FROM FileMetadata
-			WHERE libraryId = ?
-		`,
-			)
-			.run(libraryId);
-	};
-
-	put = (libraryId: string, fileInfo: FileInfo) => {
-		return this.db
-			.prepare(
-				`
-      INSERT OR REPLACE INTO FileMetadata (libraryId, fileId, name, type)
-      VALUES (?, ?, ?, ?)
-    `,
-			)
-			.run(libraryId, fileInfo.id, fileInfo.fileName, fileInfo.type);
-	};
-
-	markPendingDelete = (libraryId: string, fileId: string) => {
-		return this.db
-			.prepare(
-				`
-					UPDATE FileMetadata
-					SET pendingDeleteAt = ?
-					WHERE libraryId = ? AND fileId = ?
-				`,
-			)
-			.run(Date.now(), libraryId, fileId);
-	};
-
-	delete = (libraryId: string, fileId: string) => {
-		return this.db
-			.prepare(
-				`
-      DELETE FROM FileMetadata
-      WHERE libraryId = ? AND fileId = ?
-    `,
-			)
-			.run(libraryId, fileId);
-	};
-
-	getPendingDeletes = (libraryId: string) => {
-		return this.db
-			.prepare(
-				`
-					SELECT * FROM FileMetadata
-					WHERE libraryId = ? AND pendingDeleteAt < ?
-				`,
-			)
-			.all(
-				libraryId,
-				Date.now() - 1000 * 60 * 60 * 24 * this.deleteExpirationDays,
-			) as {
-			libraryId: string;
-			fileId: string;
-			name: string;
-			type: string;
-			pendingDeleteAt: number;
-		}[];
-	};
-}

package/src/migrations/v0.ts

@@ -1,26 +0,0 @@
-export const sql = `
-CREATE TABLE IF NOT EXISTS ReplicaInfo (
-  id TEXT PRIMARY KEY NOT NULL,
-  libraryId TEXT NOT NULL,
-  clientId TEXT NOT NULL,
-  lastSeenWallClockTime INTEGER,
-  ackedLogicalTime TEXT,
-  type INTEGER NOT NULL DEFAULT 0
-);
-
-CREATE TABLE IF NOT EXISTS OperationHistory (
-  libraryId TEXT NOT NULL,
-  replicaId TEXT NOT NULL,
-  oid TEXT NOT NULL,
-  data TEXT NOT NULL,
-  timestamp INTEGER NOT NULL,
-  PRIMARY KEY (libraryId, replicaId, oid, timestamp)
-);
-
-CREATE TABLE IF NOT EXISTS DocumentBaseline (
-  oid TEXT PRIMARY KEY NOT NULL,
-  snapshot TEXT,
-  timestamp TEXT NOT NULL,
-  libraryId TEXT NOT NULL
-);
-`;

package/src/migrations/v1.ts

@@ -1,28 +0,0 @@
-export const sql = `
-ALTER TABLE
-  ReplicaInfo RENAME TO ReplicaInfoOld;
-
-CREATE TABLE ReplicaInfo (
-  id TEXT NOT NULL,
-  libraryId TEXT NOT NULL,
-  clientId TEXT NOT NULL,
-  lastSeenWallClockTime INTEGER,
-  ackedLogicalTime TEXT,
-  type INTEGER NOT NULL DEFAULT 0,
-  PRIMARY KEY (id, libraryId)
-);
-
-INSERT INTO
-  ReplicaInfo
-SELECT
-  id,
-  libraryId,
-  clientId,
-  lastSeenWallClockTime,
-  ackedLogicalTime,
-  type
-FROM
-  ReplicaInfoOld;
-
-DROP TABLE ReplicaInfoOld;
-`;

package/src/migrations/v2.ts

@@ -1,26 +0,0 @@
-// fixes primary key for document baselines to include libraryId
-
-export const sql = `
-  ALTER TABLE
-    DocumentBaseline RENAME TO DocumentBaselineOld;
-
-  CREATE TABLE DocumentBaseline (
-    oid TEXT NOT NULL,
-    snapshot TEXT,
-    timestamp TEXT NOT NULL,
-    libraryId TEXT NOT NULL,
-    PRIMARY KEY (libraryId, oid)
-  );
-
-  INSERT INTO
-    DocumentBaseline
-  SELECT
-    oid,
-    snapshot,
-    timestamp,
-    libraryId
-  FROM
-    DocumentBaselineOld;
-
-  DROP TABLE DocumentBaselineOld;
-`;

package/src/migrations/v3.ts

@@ -1,12 +0,0 @@
-// add the FileMetadata table
-
-export const sql = `
-  CREATE TABLE IF NOT EXISTS FileMetadata (
-    libraryId TEXT NOT NULL,
-    fileId TEXT NOT NULL,
-    name TEXT NOT NULL,
-    type TEXT NOT NULL,
-    pendingDeleteAt INTEGER,
-    PRIMARY KEY (libraryId, fileId)
-  );
-`;

package/src/migrations/v4.ts

@@ -1,6 +0,0 @@
-// add server order to replicas and operations
-
-export const sql = `
-  ALTER TABLE ReplicaInfo ADD COLUMN ackedServerOrder INTEGER DEFAULT 0 NOT NULL;
-  ALTER TABLE OperationHistory ADD COLUMN serverOrder INTEGER DEFAULT 0 NOT NULL;
-`;

package/src/migrations/v5.ts

@@ -1,49 +0,0 @@
-import {
-	convertLegacyOid,
-	replaceLegacyOidsInJsonString,
-} from '@verdant-web/common';
-import SQL from 'better-sqlite3';
-
-// read all operations and write them back without legacy IDs.
-export const procedure = (db: SQL.Database) => {
-	const operations = db
-		.prepare(/* sql */ `SELECT * from OperationHistory;`)
-		.all();
-	for (const op of operations) {
-		db.prepare(
-			/* sql */ `
-    UPDATE OperationHistory
-      SET oid = ?,
-          data = ?
-      WHERE oid = ? AND timestamp = ? AND libraryId = ?;
-    `,
-		).run(
-			convertLegacyOid(op.oid),
-			// data is already a string, so just leave it and do the conversion on the string
-			op.data ? replaceLegacyOidsInJsonString(op.data) : op.data,
-			op.oid,
-			op.timestamp,
-			op.libraryId,
-		);
-	}
-	const baselines = db
-		.prepare(/* sql */ `SELECT * from DocumentBaseline;`)
-		.all();
-	for (const baseline of baselines) {
-		db.prepare(
-			/* sql */ `
-    UPDATE DocumentBaseline
-      SET oid = ?,
-          snapshot = ?
-      WHERE oid = ? AND libraryId = ?;
-    `,
-		).run(
-			convertLegacyOid(baseline.oid),
-			baseline.snapshot
-				? replaceLegacyOidsInJsonString(baseline.snapshot)
-				: baseline.snapshot,
-			baseline.oid,
-			baseline.libraryId,
-		);
-	}
-};

package/src/migrations/v6.ts

@@ -1,4 +0,0 @@
-// delete all DocumentBaselines where snapshot = NULL
-export const sql = `
-  DELETE FROM DocumentBaseline WHERE snapshot IS NULL;
-`

package/src/migrations/v7.ts

@@ -1,6 +0,0 @@
-// delete all DocumentBaselines where snapshot = NULL
-export const sql = `
-  ALTER TABLE
-    DocumentBaseline
-  ADD COLUMN serverOrder INTEGER DEFAULT 0 NOT NULL;
-`;

package/src/migrations.test.ts

@@ -1,133 +0,0 @@
-import { describe, it, expect, afterAll, beforeAll } from 'vitest';
-import create from 'better-sqlite3';
-import { migrations } from './migrations.js';
-import fs from 'fs';
-
-describe('the v5->v6 migration', () => {
-	let dbFile: string;
-	let db: create.Database;
-	beforeAll(() => {
-		dbFile = `v5-migration-test-${Math.random()}.sqlite`;
-		db = create(dbFile);
-	});
-	afterAll(() => {
-		db.close();
-		fs.rmSync(dbFile);
-	});
-
-	it('rewrites legacy oids in all ops and baselines', () => {
-		// manually migrate to v4 before starting and seed the database with some
-		// operations and baselines.
-		migrations(db, 5);
-		// manually insert some operations and baselines
-		db.transaction(() => {
-			[
-				{
-					libraryId: 'test-1',
-					replicaId: 'foo',
-					oid: 'weirds/b',
-					data: {
-						op: 'set',
-						value: { '@@type': 'ref', id: 'weirds/b.objectMap.one:ghi' },
-					},
-					timestamp: '1',
-					serverOrder: 1,
-				},
-				{
-					libraryId: 'test-1',
-					replicaId: 'foo',
-					oid: 'weirds/b.list:ghi',
-					data: {
-						op: 'list-push',
-						value: { '@@type': 'ref', id: 'weirds/b.list.#:abc' },
-					},
-					timestamp: '1',
-					serverOrder: 2,
-				},
-				{
-					libraryId: 'test-1',
-					replicaId: 'foo',
-					oid: 'weirds/b.list:ghi',
-					data: {
-						op: 'list-remove',
-						value: { '@@type': 'ref', id: 'weirds/b.list.#:abc' },
-					},
-					timestamp: '2',
-					serverOrder: 3,
-				},
-				{
-					libraryId: 'test-2',
-					replicaId: 'bar',
-					oid: 'weirds/b',
-					data: {
-						op: 'set',
-						value: { '@@type': 'ref', id: 'weirds/b.objectMap.one:ghi' },
-					},
-					timestamp: '1a',
-					serverOrder: 1,
-				},
-			].forEach(
-				({ libraryId, replicaId, oid, data, timestamp, serverOrder }) => {
-					db.prepare(
-						/* sql */ `
-        INSERT INTO OperationHistory (libraryId, replicaId, oid, data, timestamp, serverOrder)
-        VALUES (?, ?, ?, ?, ?, ?);
-      `,
-					).run(
-						libraryId,
-						replicaId,
-						oid,
-						JSON.stringify(data),
-						timestamp,
-						serverOrder,
-					);
-				},
-			);
-			[
-				{
-					libraryId: 'test-1',
-					oid: 'weirds/b.objectMap.one:ghi',
-					snapshot: { '@@type': 'ref', id: 'weirds/b.list.#:abc' },
-					timestamp: '1',
-				},
-				{
-					libraryId: 'test-2',
-					oid: 'weirds/b.objectMap.one:ghi',
-					snapshot: { '@@type': 'ref', id: 'weirds/b.list.#:abc' },
-					timestamp: '1a',
-				},
-			].forEach(({ libraryId, oid, snapshot, timestamp }) => {
-				db.prepare(
-					/* sql */ `
-        INSERT INTO DocumentBaseline (libraryId, oid, snapshot, timestamp)
-        VALUES (?, ?, ?, ?);
-      `,
-				).run(libraryId, oid, JSON.stringify(snapshot), timestamp);
-			});
-		})();
-
-		migrations(db);
-
-		// check that the operations and baselines have been rewritten
-		db.transaction(() => {
-			const operations = db
-				.prepare(
-					/* sql */ `
-      SELECT * from OperationHistory;
-    `,
-				)
-				.all();
-			expect(operations).toMatchSnapshot();
-			const baselines = db
-				.prepare(
-					/* sql */ `
-      SELECT * from DocumentBaseline;
-    `,
-				)
-				.all();
-			expect(baselines).toMatchSnapshot();
-		})();
-
-		db.close();
-	});
-});