@lix-js/sdk 0.4.7 → 0.5.0-preview.0

package/src/database/mutation-log/database-schema.ts

@@ -1,128 +0,0 @@
-import type { Insertable, Selectable } from "kysely";
-import type { SqliteWasmDatabase } from "sqlite-wasm-kysely";
-
-export const tablesByDepencies: string[] = [
-	// no dependencies
-	"snapshot",
-	"label",
-	"version",
-	"account",
-	"file",
-	"change_set",
-	"key_value",
-	// Depends on: snapshot
-	"change",
-
-	// Depends on: file
-	"file_queue",
-	// Depends on: change
-	"change_author",
-	// Depends on: change
-	"change_edge",
-	// Depends on: change_set
-	"change_conflict",
-	// Depends on: change_conflict, change
-	"change_conflict_resolution",
-	// Depends on: change_set, change
-	"change_set_element",
-	// Depends on: label, change_set
-	"change_set_label",
-	//Depends on: change_set
-	"discussion",
-	// Depends on: account, discussion, comment
-	"comment",
-	// Depends on: version, change
-	"version_change",
-	// Depends on: version, change_conflict
-	"version_change_conflict",
-	// Depends on: version
-	"current_version",
-];
-
-export const tableIdColumns: Record<string, Array<string>> = {
-	// file - File is not synced. Is construcuted from the change table. (see https://github.com/opral/monorepo/pull/3242#discussion_r1863981413)
-	change: ["id"],
-	snapshot: ["id"],
-	change_conflict: ["id"],
-	change_edge: ["parent_id", "child_id"],
-	change_conflict_resolution: ["change_conflict_id", "resolved_change_id"],
-	version_change_conflict: ["version_id", "change_conflict_id"],
-	// version_change: ["version_id", "change_id"],
-};
-
-export function applyMutationLogDatabaseSchema(
-	sqlite: SqliteWasmDatabase
-): void {
-	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
-	sqlite.exec`
-  -- vector clock
-  CREATE TABLE IF NOT EXISTS mutation_log (
-    row_id BLOB,
-    table_name TEXT,
-    -- TODO SYNC - we might not need the operation as long as we don't expect a delete operation since we utilize upsert queries anyway
-    operation TEXT,
-    session TEXT NOT NULL DEFAULT (lix_session()),
-    session_time INTEGER NOT NULL DEFAULT (lix_session_clock_tick()),
-    wall_clock INTEGER DEFAULT (strftime('%s', 'now') * 1000 + (strftime('%f', 'now') - strftime('%S', 'now')) * 1000)
-  ) STRICT;
-   
-  CREATE TRIGGER IF NOT EXISTS ignore_mutation_during_sync
-  BEFORE INSERT ON mutation_log
-  FOR EACH ROW
-  WHEN EXISTS (SELECT 1 FROM mutation_log WHERE table_name = 'mutation_log')
-  BEGIN
-    SELECT RAISE(IGNORE);
-  END;
- 
-  `;
-
-	for (const [tableName, idColumns] of Object.entries(tableIdColumns)) {
-		if (idColumns.length === 0) {
-			throw new Error("at least one id required");
-		}
-		sqlite.exec(`
-      -- Trigger for INSERT operations
-      CREATE TRIGGER IF NOT EXISTS ${tableName}_after_insert_log
-      AFTER INSERT ON ${tableName}
-      BEGIN
-          INSERT INTO mutation_log (row_id, table_name, operation)
-          VALUES (JSONB(${toSqliteJson(idColumns)}), '${tableName}', 'INSERT');
-      END;
-  
-      -- Trigger for UPDATE operations
-      CREATE TRIGGER IF NOT EXISTS ${tableName}_after_update_log
-      AFTER UPDATE ON ${tableName}
-      BEGIN
-          INSERT INTO mutation_log (row_id, table_name, operation)
-          VALUES (JSONB(${toSqliteJson(idColumns)}), '${tableName}', 'UPDATE');
-      END;
-    `);
-	}
-}
-
-export type MutationLog = Selectable<MutationLogTable>;
-export type NewMutationLog = Insertable<MutationLogTable>;
-
-export type MutationLogTable = {
-	row_id: Record<string, string>;
-	table_name: string;
-	// -1 = delete, 0 = insert, 1 = update
-	// TODO SYNC - we might not need the operation as long as we don't expect a delete operation since we utilize upsert queries anyway
-	operation: "INSERT" | "UPDATE";
-	session: string;
-	session_time: number;
-	wall_clock: number;
-};
-
-function toSqliteJson(keyColumns: string[]) {
-	if (keyColumns.length === 0) {
-		throw new Error("Key columns array cannot be empty.");
-	}
-
-	const jsonObjectArgs = keyColumns.map(
-		(keyColumnName) => `'${keyColumnName}', NEW.${keyColumnName}`
-	);
-
-	const jsonObjectExpression = "json_object(" + jsonObjectArgs.join(", ") + ")";
-	return jsonObjectExpression;
-}

package/src/database/mutation-log/lix-session.ts

@@ -1,19 +0,0 @@
-import { v4 as uuid_v4 } from "uuid";
-
-export function createSession() {
-	const sessionId = uuid_v4(); // we use v4 here since the order of session should explicetly not matter!
-	let time: number = 0;
-
-	return {
-		/**
-		 * Returns the current lix session id.
-		 */
-		id: (): string => {
-			return sessionId;
-		},
-		sessionClockTick: (): number => {
-			time += 1;
-			return time;
-		},
-	};
-}

package/src/discussion/create-comment.ts

@@ -1,18 +0,0 @@
-import type { Comment } from "../database/schema.js";
-import type { Lix } from "../lix/open-lix.js";
-
-export async function createComment(args: {
-	lix: Pick<Lix, "db">;
-	parentComment: Pick<Comment, "id" | "discussion_id">;
-	content: string;
-}): Promise<Comment> {
-	return args.lix.db
-		.insertInto("comment")
-		.values({
-			discussion_id: args.parentComment.discussion_id,
-			parent_id: args.parentComment.id,
-			content: args.content,
-		})
-		.returningAll()
-		.executeTakeFirstOrThrow();
-}

package/src/discussion/create-discussion.test.ts

@@ -1,45 +0,0 @@
-import { expect, test } from "vitest";
-import { openLixInMemory } from "../lix/open-lix-in-memory.js";
-import { createDiscussion } from "./create-discussion.js";
-import { createChangeSet } from "../change-set/create-change-set.js";
-
-test("should be able to start a discussion on changes", async () => {
-	const lix = await openLixInMemory({});
-
-	// produce a change
-	await lix.db
-		.insertInto("key_value")
-		.values({
-			key: "mock_key",
-			value: "mock_value",
-		})
-		.execute();
-
-	const changes = await lix.db
-		.selectFrom("change")
-		.selectAll("change")
-		.execute();
-
-	await lix.db.transaction().execute(async (trx) => {
-		await createDiscussion({
-			lix: { db: trx },
-			firstComment: { content: "Hello, world!" },
-			changeSet: await createChangeSet({ lix: { db: trx }, changes }),
-		});
-	});
-
-	const discussions = await lix.db
-		.selectFrom("discussion")
-		.selectAll()
-		.execute();
-
-	expect(discussions).toHaveLength(1);
-
-	const comments = await lix.db
-		.selectFrom("comment")
-		.selectAll()
-		.where("discussion_id", "=", discussions[0]!.id)
-		.execute();
-
-	expect(comments).toHaveLength(1);
-});

package/src/discussion/create-discussion.ts

@@ -1,48 +0,0 @@
-import type { ChangeSet, Comment, Discussion } from "../database/schema.js";
-import type { Lix } from "../lix/open-lix.js";
-
-/**
- * Creates a new discussion with the first comment.
- *
- * @example
- *   ```ts
- *   const changeSet = await createChangeSet({ lix, changes: ["change1", "change2"] });
- *   const discussion = await createDiscussion({ lix, changeSet, firstComment: { content: "first comment" } });
- *   ```
- *
- * @returns the created discussion
- */
-export async function createDiscussion(args: {
-	lix: Pick<Lix, "db">;
-	changeSet: Pick<ChangeSet, "id">;
-	firstComment: Pick<Comment, "content">;
-}): Promise<Discussion & { firstComment: Comment }> {
-	const executeInTransaction = async (trx: Lix["db"]) => {
-		const discussion = await trx
-			.insertInto("discussion")
-			.values({
-				change_set_id: args.changeSet.id,
-			})
-			.returningAll()
-			.executeTakeFirstOrThrow();
-
-		const firstComment = await trx
-			.insertInto("comment")
-			.values({
-				parent_id: null,
-				discussion_id: discussion.id,
-				content: args.firstComment.content,
-			})
-			.returningAll()
-			.executeTakeFirstOrThrow();
-
-		return { ...discussion, firstComment };
-	};
-
-	// user provided an open transaction
-	if (args.lix.db.isTransaction) {
-		return executeInTransaction(args.lix.db);
-	} else {
-		return args.lix.db.transaction().execute(executeInTransaction);
-	}
-}

package/src/discussion/index.ts

@@ -1,2 +0,0 @@
-export { createDiscussion } from "./create-discussion.js";
-export { createComment } from "./create-comment.js";

package/src/file/validate-file-path.test.ts

@@ -1,44 +0,0 @@
-import { test, expect } from "vitest";
-import { isValidFilePath } from "./validate-file-path.js";
-
-test("valid cases", () => {
-	const validCases = [
-		"/path/to/file",
-		"/path/to/file/with/multiple/segments",
-		"/path/to/file.with.dots",
-		"/path/to/file-with-hyphens_and_underscores",
-		"/path/with-file-extension.txt",
-	];
-
-	for (const validCase of validCases) {
-		expect(isValidFilePath(validCase)).toBe(true);
-		// testing for RFC 3986 URI
-		expect(URL.canParse(`file://${validCase}`)).toBe(true);
-	}
-});
-
-// invalid cases
-
-test("an empty path should be invalid", () => {
-	expect(isValidFilePath("")).toBe(false);
-});
-
-test("a path that contains only a slash should be invalid", () => {
-	expect(isValidFilePath("/")).toBe(false);
-});
-
-test("a path that does not start with a slash should be invalid", () => {
-	expect(isValidFilePath("path/to/file")).toBe(false);
-});
-
-test("a path that ends with a slash should be invalid", () => {
-	expect(isValidFilePath("/path/to/file/")).toBe(false);
-});
-
-test("a path that contains consecutive slashes should be invalid", () => {
-	expect(isValidFilePath("/path//to/file")).toBe(false);
-});
-
-test("a path that contains backslashes should be invalid", () => {
-	expect(isValidFilePath("/path\\to\\file")).toBe(false);
-});

package/src/file/validate-file-path.ts

@@ -1,60 +0,0 @@
-/**
- * Idea is to have a minimal spec that can be extended over time.
- *
- * Every valid file path must also be a valid RFC 3986 URI.
- */
-
-/**
- * Validates a file path.
- *
- * @throws {Error} If the file path is invalid.
- */
-export function validateFilePath(path: string): void {
-	// validate beginning
-
-	if (path.length === 0) {
-		throw new Error("File path must not be empty.");
-	}
-
-	if (path[0] !== "/") {
-		throw new Error(
-			"File path must start with a slash.\n\nFiles must start with a root slash to identify the path as root."
-		);
-	}
-
-	// validate middle
-
-	// validate ending
-
-	if (path.endsWith("/")) {
-		throw new Error(
-			"File path must not end with a slash.\n\nEnding a file with a slash leads to ambiguity whether or not the path is a directory or a file."
-		);
-	}
-
-	// validate general
-
-	if (path.includes("//")) {
-		throw new Error(
-			"File path must not contain consecutive slashes.\n\nConsecutive slashes lead to ambiguity whether or not the path is a directory or a file."
-		);
-	}
-
-	if (path.includes("\\")) {
-		throw new Error(
-			"File path must not contain backslashes.\n\nThe restriction might be loosened in the future."
-		);
-	}
-}
-
-/**
- *
- */
-export function isValidFilePath(path: string): boolean {
-	try {
-		validateFilePath(path);
-		return true;
-	} catch {
-		return false;
-	}
-}

package/src/file-queue/file-handlers.ts

@@ -1,267 +0,0 @@
-import type { FileQueueEntry } from "../database/schema.js";
-import type { DetectedChange } from "../plugin/lix-plugin.js";
-import type { Lix } from "../lix/open-lix.js";
-import { sql } from "kysely";
-import { createChange } from "../change/create-change.js";
-import { changeIsLeafInVersion } from "../query-filter/change-is-leaf-in-version.js";
-
-async function glob(args: {
-	lix: Pick<Lix, "db">;
-	glob: string;
-	path: string;
-}) {
-	const result =
-		await sql`SELECT CASE WHEN ${args.path} GLOB ${args.glob} THEN 1 ELSE 0 END AS matches`.execute(
-			args.lix.db
-		);
-
-	// Extract the result from the response
-
-	return (result.rows[0] as any)?.matches === 1;
-}
-
-// creates initial changes for new files
-export async function handleFileInsert(args: {
-	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	fileQueueEntry: FileQueueEntry;
-}): Promise<void> {
-	const detectedChanges: Array<DetectedChange & { pluginKey: string }> = [];
-
-	const plugins = await args.lix.plugin.getAll();
-
-	// the path of the file is either the after path or the before path
-	// depending on whether the file was deleted, updated, or created
-	const path =
-		args.fileQueueEntry.path_after ?? args.fileQueueEntry.path_before;
-
-	if (path === null) {
-		throw new Error("Both before and after paths are null");
-	}
-
-	for (const plugin of plugins) {
-		// glob expressions and paths should be properly normalized
-		if (
-			!plugin.detectChangesGlob ||
-			!(await glob({
-				lix: args.lix,
-				path,
-				glob: plugin.detectChangesGlob,
-			}))
-		) {
-			break;
-		}
-
-		if (plugin.detectChanges === undefined) {
-			const error = new Error(
-				"Plugin does not support detecting changes even though the glob matches."
-			);
-			// https://linear.app/opral/issue/LIXDK-195/await-change-queue-to-log-errors
-			console.error(error);
-			throw error;
-		}
-
-		if (args.fileQueueEntry.data_after === null) {
-			throw new Error("Data after is null");
-		}
-
-		for (const change of await plugin.detectChanges({
-			lix: args.lix,
-			before: undefined,
-			after: {
-				id: args.fileQueueEntry.file_id,
-				path,
-				metadata: args.fileQueueEntry.metadata_after,
-				data: args.fileQueueEntry.data_after,
-			},
-		})) {
-			detectedChanges.push({
-				...change,
-				pluginKey: plugin.key,
-			});
-		}
-	}
-
-	await args.lix.db.transaction().execute(async (trx) => {
-		const currentAuthors = await trx
-			.selectFrom("active_account")
-			.selectAll()
-			.execute();
-
-		const currentVersion = await trx
-			.selectFrom("current_version")
-			.innerJoin("version", "current_version.id", "version.id")
-			.selectAll()
-			.executeTakeFirstOrThrow();
-
-		await Promise.all(
-			detectedChanges.map(async (detectedChange) => {
-				await createChange({
-					lix: { ...args.lix, db: trx },
-					authors: currentAuthors,
-					version: currentVersion,
-					entityId: detectedChange.entity_id,
-					fileId: args.fileQueueEntry.file_id,
-					pluginKey: detectedChange.pluginKey,
-					schemaKey: detectedChange.schema.key,
-					snapshotContent: detectedChange.snapshot,
-				});
-			})
-		);
-
-		await trx
-			.deleteFrom("file_queue")
-			.where("id", "=", args.fileQueueEntry.id)
-			.execute();
-	});
-}
-
-export async function handleFileUpdate(args: {
-	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	fileQueueEntry: FileQueueEntry;
-}): Promise<void> {
-	const detectedChanges: Array<DetectedChange & { pluginKey: string }> = [];
-
-	const plugins = await args.lix.plugin.getAll();
-
-	// the path of the file is either the after path or the before path
-	// depending on whether the file was deleted, updated, or created
-	const path =
-		args.fileQueueEntry.path_after ?? args.fileQueueEntry.path_before;
-
-	if (path === null) {
-		throw new Error("Both before and after paths are null");
-	}
-
-	for (const plugin of plugins) {
-		// glob expressions and paths should be properly normalized
-		if (
-			!plugin.detectChangesGlob ||
-			!(await glob({
-				lix: args.lix,
-				path,
-				glob: plugin.detectChangesGlob,
-			}))
-		) {
-			break;
-		}
-		if (plugin.detectChanges === undefined) {
-			const error = new Error(
-				"Plugin does not support detecting changes even though the glob matches."
-			);
-			// https://linear.app/opral/issue/LIXDK-195/await-change-queue-to-log-errors
-			console.error(error);
-			throw error;
-		}
-		for (const change of await plugin.detectChanges({
-			lix: args.lix,
-			before: args.fileQueueEntry.data_before
-				? {
-						id: args.fileQueueEntry.file_id,
-						path: path,
-						metadata: args.fileQueueEntry.metadata_before,
-						data: args.fileQueueEntry.data_before,
-					}
-				: undefined,
-			after: {
-				id: args.fileQueueEntry.file_id,
-				path,
-				metadata: args.fileQueueEntry.metadata_after,
-				data: args.fileQueueEntry.data_after!,
-			},
-		})) {
-			detectedChanges.push({
-				...change,
-				pluginKey: plugin.key,
-			});
-		}
-	}
-
-	await args.lix.db.transaction().execute(async (trx) => {
-		const currentAuthors = await trx
-			.selectFrom("active_account")
-			.selectAll()
-			.execute();
-
-		const currentVersion = await trx
-			.selectFrom("current_version")
-			.innerJoin("version", "current_version.id", "version.id")
-			.selectAll()
-			.executeTakeFirstOrThrow();
-
-		await Promise.all(
-			detectedChanges.map(async (detectedChange) => {
-				await createChange({
-					lix: { ...args.lix, db: trx },
-					authors: currentAuthors,
-					version: currentVersion,
-					entityId: detectedChange.entity_id,
-					fileId: args.fileQueueEntry.file_id,
-					pluginKey: detectedChange.pluginKey,
-					schemaKey: detectedChange.schema.key,
-					snapshotContent: detectedChange.snapshot,
-				});
-			})
-		);
-
-		await trx
-			.deleteFrom("file_queue")
-			.where("id", "=", args.fileQueueEntry.id)
-			.execute();
-	});
-}
-
-/**
- * File deletions don't need to invoke a plugin to detect changes.
- *
- * Instead, we can simply query the database for all changes that are related to the file
- * and create the corresponding deletion changes for the current version.
- *
- * - simpler plugin API (because deletions don't need to be accounted for)
- * - faster file deletion (because we don't need to invoke plugins)
- */
-export async function handleFileDelete(args: {
-	lix: Pick<Lix, "db" | "plugin" | "sqlite">;
-	fileQueueEntry: FileQueueEntry;
-}): Promise<void> {
-	await args.lix.db.transaction().execute(async (trx) => {
-		const currentVersion = await trx
-			.selectFrom("current_version")
-			.innerJoin("version", "current_version.id", "version.id")
-			.selectAll()
-			.executeTakeFirstOrThrow();
-
-		const toBeDeletedEntities = await trx
-			.selectFrom("change")
-			.where("file_id", "=", args.fileQueueEntry.file_id)
-			.where(changeIsLeafInVersion(currentVersion))
-			.select("entity_id")
-			.select("schema_key")
-			.select("plugin_key")
-			.execute();
-
-		const currentAuthors = await trx
-			.selectFrom("active_account")
-			.selectAll()
-			.execute();
-
-		await Promise.all(
-			toBeDeletedEntities.map(async (change) => {
-				await createChange({
-					lix: { ...args.lix, db: trx },
-					authors: currentAuthors,
-					version: currentVersion,
-					entityId: change.entity_id,
-					fileId: args.fileQueueEntry.file_id,
-					pluginKey: change.plugin_key,
-					schemaKey: change.schema_key,
-					snapshotContent: null, // Snapshot is null for deletions
-				});
-			})
-		);
-
-		await trx
-			.deleteFrom("file_queue")
-			.where("id", "=", args.fileQueueEntry.id)
-			.execute();
-	});
-}