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

package/src/lix/merge.ts

@@ -1,244 +0,0 @@
-import type { Lix } from "./open-lix.js";
-import { getLeafChangesOnlyInSource } from "./merge.get-leaf-changes-only-in-source.js";
-import { withSkipFileQueue } from "../file-queue/with-skip-file-queue.js";
-import type { DetectedConflict } from "../plugin/lix-plugin.js";
-
-/**
- * Combined the changes of the source lix into the target lix.
- */
-export async function merge(args: {
-	targetLix: Lix;
-	sourceLix: Lix;
-	// TODO selectively merge changes
-	// onlyTheseChanges
-}): Promise<void> {
-	// TODO increase performance by using attach mode
-	//      and only get the changes that are not in target.
-	const sourceChangesWithSnapshot = await args.sourceLix.db
-		.selectFrom("change")
-		.innerJoin("snapshot", "snapshot.id", "change.snapshot_id")
-		.selectAll("change")
-		.select("snapshot.content")
-		.execute();
-
-	// TODO don't query the changes again. inefficient.
-	const leafChangesOnlyInSource = await getLeafChangesOnlyInSource({
-		sourceLix: args.sourceLix,
-		targetLix: args.targetLix,
-	});
-
-	// 2. Let the plugin detect conflicts
-
-	const plugins = await args.sourceLix.plugin.getAll();
-	const plugin = plugins[0];
-
-	// TODO function assumes that all changes belong to the same file
-	if (plugins.length > 1) {
-		throw new Error("Unimplemented. Only one plugin is supported for now");
-	}
-
-	const conflicts: DetectedConflict[] =
-		// (await plugin?.detectConflicts?.({
-		// 	sourceLix: args.sourceLix,
-		// 	targetLix: args.targetLix,
-		// })) ??
-
-		[];
-
-	const changesPerFile: Record<string, Uint8Array> = {};
-
-	const fileIds = new Set(sourceChangesWithSnapshot.map((c) => c.file_id));
-
-	for (const fileId of fileIds) {
-		// 3. apply non conflicting leaf changes
-		// TODO inefficient double looping
-		const nonConflictingLeafChangesInSourceForFile = leafChangesOnlyInSource
-			.filter((sourceChange) =>
-				conflicts.every(
-					(conflict) =>
-						conflict.conflictingChangeIds.has(sourceChange.id) === false
-				)
-			)
-			.filter((c) => c.file_id === fileId);
-
-		let file = await args.targetLix.db
-			.selectFrom("file")
-			.selectAll()
-			.where("id", "=", fileId)
-			.executeTakeFirst();
-
-		// If the file does not exist in the target lix - we just copy the whole file over
-		if (!file) {
-			file = await args.sourceLix.db
-				.selectFrom("file")
-				.selectAll()
-				.where("id", "=", fileId)
-				.executeTakeFirst();
-
-			if (file) {
-				const fileToInsert = {
-					id: file.id,
-					path: file.path,
-					data: file.data,
-					metadata: file.metadata,
-				};
-
-				await withSkipFileQueue(args.targetLix.db, async (trx) => {
-					await trx
-						.insertInto("file")
-						.values({ ...fileToInsert })
-						.executeTakeFirst();
-				});
-			}
-		}
-
-		if (!plugin?.applyChanges) {
-			throw new Error("Plugin does not support applying changes");
-		}
-
-		const { fileData } = await plugin.applyChanges({
-			changes: nonConflictingLeafChangesInSourceForFile,
-			// @ts-expect-error - TODO apply changes can be an undefined file
-			file,
-			lix: args.targetLix,
-		});
-
-		changesPerFile[fileId] = fileData;
-	}
-
-	// DISCUSSIONS
-
-	/**
-	 * NOTE:
-	 * this is a naiv implementation that selects just all discussions
-	 * and passes them to the target
-	 **/
-	// selecting all discussion related entries for later upsert
-	const sourceDiscussions = await args.sourceLix.db
-		.selectFrom("discussion")
-		.selectAll()
-		.execute();
-
-	const sourceComments = await args.sourceLix.db
-		.selectFrom("comment")
-		.selectAll()
-		.execute();
-
-	// change graph
-
-	const sourceEdges = await args.sourceLix.db
-		.selectFrom("change_edge")
-		.selectAll()
-		.execute();
-
-	// change sets
-
-	const sourceChangeSets = await args.sourceLix.db
-		.selectFrom("change_set")
-		.selectAll()
-		.execute();
-
-	const sourceChangeSetItems = await args.sourceLix.db
-		.selectFrom("change_set_element")
-		.selectAll()
-		.execute();
-
-	await args.targetLix.db.transaction().execute(async (trx) => {
-		if (sourceChangesWithSnapshot.length > 0) {
-			// copy the snapshots from source
-			await trx
-				.insertInto("snapshot")
-				.values(
-					// https://github.com/opral/inlang-message-sdk/issues/123
-					sourceChangesWithSnapshot.map((change) => ({
-						content: change.content,
-					}))
-				)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-
-			await trx
-				.insertInto("change")
-				.values(
-					sourceChangesWithSnapshot.map((c) => ({
-						...c,
-						content: undefined,
-					}))
-				)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-		}
-
-		// insert the conflicts of those changes
-		if (conflicts.length > 0) {
-			// await trx
-			// 	.insertInto("conflict")
-			// 	.values(conflicts)
-			// 	// ignore if already exists
-			// 	.onConflict((oc) => oc.doNothing())
-			// 	.execute();
-		}
-
-		for (const [fileId, fileData] of Object.entries(changesPerFile)) {
-			// update the file data with the applied changes
-			await withSkipFileQueue(trx, async (trx) => {
-				await trx
-					.updateTable("file")
-					.set("data", fileData)
-					.where("id", "=", fileId)
-					.execute();
-			});
-		}
-
-		// copy edges
-		if (sourceEdges.length > 0) {
-			await trx
-				.insertInto("change_edge")
-				.values(sourceEdges)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-		}
-
-		// add change sets and change_set_memberships
-		if (sourceChangeSets.length > 0) {
-			await trx
-				.insertInto("change_set")
-				.values(sourceChangeSets)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-		}
-		if (sourceChangeSetItems.length > 0) {
-			await trx
-				.insertInto("change_set_element")
-				.values(sourceChangeSetItems)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-		}
-
-		// add discussions, comments and discsussion_change_mappings
-
-		if (sourceDiscussions.length > 0) {
-			await trx
-				.insertInto("discussion")
-				.values(sourceDiscussions)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-				.execute();
-		}
-
-		if (sourceComments.length > 0) {
-			await trx
-				.insertInto("comment")
-				.values(sourceComments)
-				// ignore if already exists
-				.onConflict((oc) => oc.doNothing())
-
-				.execute();
-		}
-	});
-}

package/src/lix/open-lix-in-memory.test.ts

@@ -1,34 +0,0 @@
-import { test, expect } from "vitest";
-import { openLixInMemory } from "./open-lix-in-memory.js";
-import { toBlob } from "./to-blob.js";
-
-test("it should open a lix in memory", async () => {
-	const lix = await openLixInMemory({});
-	// querying a table to see if the schema is applied
-	const changes = await lix.db.selectFrom("change").selectAll().execute();
-	expect(changes).toEqual([]);
-});
-
-test("it should open a lix in memory from a blob", async () => {
-	const lix1 = await openLixInMemory({});
-
-	await lix1.db
-		.insertInto("file")
-		.values({
-			id: "1",
-			path: "/a.txt",
-			data: new TextEncoder().encode("hello"),
-		})
-		.execute();
-
-	const lix2 = await openLixInMemory({ blob: await toBlob({ lix: lix1 }) });
-	const files = await lix2.db.selectFrom("file").selectAll().execute();
-
-	expect(files).toEqual([
-		expect.objectContaining({
-			id: "1",
-			path: "/a.txt",
-			data: new TextEncoder().encode("hello"),
-		}),
-	]);
-});

package/src/lix/open-lix-in-memory.ts

@@ -1,28 +0,0 @@
-import { createInMemoryDatabase, importDatabase } from "sqlite-wasm-kysely";
-import { openLix } from "./open-lix.js";
-
-/**
- * Opens a lix in memory.
- *
- */
-export async function openLixInMemory(
-	args: {
-		/**
-		 * The lix file to open. If not provided, an empty (new) lix will be opened.
-		 */
-		blob?: Blob;
-	} & Omit<Parameters<typeof openLix>[0], "database">
-): Promise<ReturnType<typeof openLix>> {
-	const database = await createInMemoryDatabase({
-		readOnly: false,
-	});
-
-	if (args.blob) {
-		importDatabase({
-			db: database,
-			content: new Uint8Array(await args.blob.arrayBuffer()),
-		});
-	}
-
-	return openLix({ ...args, database });
-}

package/src/lix/to-blob.ts

@@ -1,14 +0,0 @@
-import { contentFromDatabase } from "sqlite-wasm-kysely";
-import type { Lix } from "./open-lix.js";
-
-/**
- * Convert the lix to a blob.
- *
- * @example
- *   const blob = await toBlob({ lix })
- */
-export async function toBlob(args: {
-	lix: Pick<Lix, "db" | "sqlite">;
-}): Promise<Blob> {
-	return new Blob([contentFromDatabase(args.lix.sqlite)]);
-}

package/src/own-change-control/apply-own-change.test.ts

@@ -1,361 +0,0 @@
-import { test, expect } from "vitest";
-import { openLixInMemory } from "../lix/open-lix-in-memory.js";
-import type {
-	Change,
-	ChangeSet,
-	ChangeSetElement,
-} from "../database/schema.js";
-import { applyOwnChanges } from "./apply-own-change.js";
-import { mockJsonSnapshot } from "../snapshot/mock-json-snapshot.js";
-import { type NewKeyValue } from "../key-value/database-schema.js";
-
-test("it should apply insert changes correctly", async () => {
-	const lix = await openLixInMemory({});
-
-	const snapshot = mockJsonSnapshot({
-		key: "key1",
-		value: "value1",
-	});
-
-	const change: Change = {
-		id: "change1",
-		entity_id: "key1",
-		schema_key: "lix_key_value_table",
-		plugin_key: "lix_own_change_control",
-		file_id: "lix_own_change_control",
-		snapshot_id: snapshot.id,
-		created_at: "2021-01-01T00:00:00.000Z",
-	};
-
-	await lix.db
-		.insertInto("snapshot")
-		.values({ content: snapshot.content })
-		.execute();
-
-	await applyOwnChanges({ lix, changes: [change] });
-
-	const result = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "key1")
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(result).toMatchObject({ key: "key1", value: "value1" });
-});
-
-test("it should apply update changes correctly", async () => {
-	const lix = await openLixInMemory({});
-
-	await lix.db
-		.insertInto("key_value")
-		.values({ key: "key1", value: "old_value" })
-		.execute();
-
-	const snapshot = mockJsonSnapshot({
-		key: "key1",
-		value: "new_value",
-	});
-
-	const change: Change = {
-		id: "change1",
-		schema_key: "lix_key_value_table",
-		entity_id: "key1",
-		file_id: "lix_own_change_control",
-		created_at: "2021-01-01T00:00:00.000Z",
-		plugin_key: "lix_own_change_control",
-		snapshot_id: snapshot.id,
-	};
-
-	await lix.db
-		.insertInto("snapshot")
-		.values({
-			content: snapshot.content,
-		})
-		.execute();
-
-	await applyOwnChanges({ lix, changes: [change] });
-
-	const result = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "key1")
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(result).toMatchObject({ key: "key1", value: "new_value" });
-});
-
-test("it should apply delete changes correctly", async () => {
-	const lix = await openLixInMemory({});
-
-	await lix.db
-		.insertInto("key_value")
-		.values({ key: "key1", value: "value1" })
-		.execute();
-
-	const change: Change = {
-		id: "change1",
-		schema_key: "lix_key_value_table",
-		file_id: "lix_own_change_control",
-		created_at: "2021-01-01T00:00:00.000Z",
-		entity_id: "key1",
-		plugin_key: "lix_own_change_control",
-		snapshot_id: "no-content",
-	};
-
-	await applyOwnChanges({ lix, changes: [change] });
-
-	const result = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "key1")
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(result).toBeUndefined();
-});
-
-test("it should throw an error for invalid plugin key", async () => {
-	const lix = await openLixInMemory({});
-
-	const change: Change = {
-		id: "change1",
-		schema_key: "lix_key_value_table",
-		entity_id: "key1",
-		file_id: "lix_own_change_control",
-		created_at: "2021-01-01T00:00:00.000Z",
-		plugin_key: "invalid-plugin",
-		snapshot_id: "snapshot1",
-	};
-
-	const snapshot = mockJsonSnapshot({
-		key: "key1",
-		value: "value1",
-	});
-
-	await lix.db
-		.insertInto("snapshot")
-		.values({
-			content: snapshot.content,
-		})
-		.execute();
-
-	await expect(applyOwnChanges({ lix, changes: [change] })).rejects.toThrow(
-		"Expected 'lix_own_change_control' as plugin key but received invalid-plugin"
-	);
-});
-
-test("file.data is not changed by applyOwnEntityChanges", async () => {
-	const lix = await openLixInMemory({});
-
-	const file = await lix.db
-		.insertInto("file")
-		.values({
-			path: "/test.txt",
-			data: new TextEncoder().encode("hello"),
-			metadata: {
-				foo: "bar",
-			},
-		})
-		.returningAll()
-		.executeTakeFirstOrThrow();
-
-	const change = await lix.db
-		.selectFrom("change")
-		.innerJoin("snapshot", "snapshot.id", "change.snapshot_id")
-		.where("schema_key", "=", "lix_file_table")
-		.where("entity_id", "=", file.id)
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(change).toBeDefined();
-	expect(change?.content?.metadata).toEqual({ foo: "bar" });
-
-	const snapshot = await lix.db
-		.insertInto("snapshot")
-		.values({
-			content: {
-				id: file.id,
-				path: "/test.txt",
-				metadata: {
-					foo: "baz",
-				},
-			},
-		})
-		.returningAll()
-		.executeTakeFirstOrThrow();
-
-	const mockChange: Change = {
-		id: "change1",
-		entity_id: file.id,
-		schema_key: "lix_file_table",
-		plugin_key: "lix_own_change_control",
-		file_id: "null",
-		snapshot_id: snapshot.id,
-		created_at: "2021-01-01T00:00:00.000Z",
-	};
-
-	await applyOwnChanges({ lix, changes: [mockChange] });
-
-	const result = await lix.db
-		.selectFrom("file")
-		.where("id", "=", file.id)
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(result).toEqual({
-		id: file.id,
-		data: new TextEncoder().encode("hello"),
-		path: "/test.txt",
-		metadata: { foo: "baz" },
-	});
-});
-
-test("foreign key constraints are deferred to make the order of applying changes irrelevant", async () => {
-	const lix = await openLixInMemory({});
-
-	const snapshots = [
-		mockJsonSnapshot({
-			id: "change-set-1",
-		} satisfies ChangeSet),
-		mockJsonSnapshot({
-			change_id: "change0",
-			change_set_id: "change-set-1",
-		} satisfies ChangeSetElement),
-	] as const;
-
-	const mockChanges: Change[] = [
-		// applying changes in reverse order
-		{
-			id: "change2",
-			entity_id: "change-set-1,change0",
-			schema_key: "lix_change_set_element_table",
-			plugin_key: "lix_own_change_control",
-			file_id: "null",
-			snapshot_id: snapshots[1].id,
-			created_at: "2021-01-01T00:00:00.000Z",
-		},
-		{
-			id: "change1",
-			entity_id: "change-set-1",
-			schema_key: "lix_change_set_table",
-			plugin_key: "lix_own_change_control",
-			file_id: "null",
-			snapshot_id: snapshots[0].id,
-			created_at: "2021-01-01T00:00:00.000Z",
-		},
-	];
-
-	for (const snapshot of snapshots) {
-		// @ts-expect-error - 'cannot' insert into generated column error
-		delete snapshot.id;
-	}
-
-	await lix.db
-		.insertInto("snapshot")
-		.values(snapshots.map((s) => ({ content: s.content })))
-		.execute();
-
-	// insert change that the change set element references
-	await lix.db
-		.insertInto("change")
-		.values({
-			id: "change0",
-			plugin_key: "mock",
-			file_id: "null",
-			entity_id: "mock",
-			schema_key: "mock",
-			snapshot_id: "no-content",
-		})
-		.execute();
-
-	await expect(
-		applyOwnChanges({ lix, changes: mockChanges })
-	).resolves.toBeUndefined();
-});
-
-test("foreign key constraints are obeyed", async () => {
-	const lix = await openLixInMemory({});
-
-	const snapshots = [
-		mockJsonSnapshot({
-			// both change 0 and the change set are missing
-			change_id: "change0",
-			change_set_id: "change-set-1",
-		} satisfies ChangeSetElement),
-	] as const;
-
-	const mockChanges: Change[] = [
-		{
-			id: "change2",
-			// the change set for this change does not exist
-			entity_id: "change-set-1,change0",
-			schema_key: "lix_change_set_element_table",
-			plugin_key: "lix_own_change_control",
-			file_id: "lix_own_change_control",
-			snapshot_id: snapshots[0].id,
-			created_at: "2021-01-01T00:00:00.000Z",
-		},
-	];
-
-	for (const snapshot of snapshots) {
-		// @ts-expect-error - 'cannot' insert into generated column error
-		delete snapshot.id;
-	}
-
-	await lix.db
-		.insertInto("snapshot")
-		.values(snapshots.map((s) => ({ content: s.content })))
-		.execute();
-
-	// insert change that the change set element references
-	await lix.db
-		.insertInto("change")
-		.values({
-			id: "change0",
-			plugin_key: "mock",
-			file_id: "null",
-			entity_id: "mock",
-			schema_key: "mock",
-			snapshot_id: "no-content",
-		})
-		.execute();
-
-	expect(applyOwnChanges({ lix, changes: mockChanges })).rejects.toThrow();
-});
-
-// https://github.com/opral/lix-sdk/issues/185
-test("applying own entity changes doesn't lead to the creation of new changes", async () => {
-	const lix = await openLixInMemory({});
-
-	const snapshot = mockJsonSnapshot({
-		key: "mock-key",
-		value: "1+1=2",
-	} satisfies NewKeyValue);
-
-	await lix.db
-		.insertInto("snapshot")
-		.values({
-			content: snapshot.content,
-		})
-		.execute();
-
-	const changesBefore = await lix.db.selectFrom("change").selectAll().execute();
-
-	await applyOwnChanges({
-		lix,
-		changes: [
-			{
-				id: "change0",
-				entity_id: "mock-key",
-				file_id: "null",
-				plugin_key: "lix_own_change_control",
-				schema_key: "lix_key_value_table",
-				snapshot_id: snapshot.id,
-				created_at: "2021-01-01T00:00:00Z",
-			},
-		],
-	});
-
-	const changesAfter = await lix.db.selectFrom("change").selectAll().execute();
-
-	expect(changesBefore).toEqual(changesAfter);
-});