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

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

@@ -1,110 +0,0 @@
-import {
-	CompiledQuery,
-	type DeleteQueryBuilder,
-	type DeleteResult,
-	type InsertQueryBuilder,
-	type InsertResult,
-} from "kysely";
-import type { Change, LixDatabaseSchema } from "../database/schema.js";
-import type { Lix } from "../lix/open-lix.js";
-import {
-	changeControlledTableIds,
-	primaryKeysForEntityId,
-} from "./change-controlled-tables.js";
-import { withSkipOwnChangeControl } from "./with-skip-own-change-control.js";
-
-/**
- * Applies own changes to lix itself.
- */
-export async function applyOwnChanges(args: {
-	lix: Pick<Lix, "db">;
-	changes: Change[];
-}): Promise<void> {
-	const executeInTransaction = async (trx: Lix["db"]) => {
-		await withSkipOwnChangeControl(trx, async (trx) => {
-			// defer foreign keys to avoid constraint violations
-			// until the end of the transaction. otherwise, we would
-			// need to apply the changes in the correct order.
-			await trx.executeQuery(
-				CompiledQuery.raw("PRAGMA defer_foreign_keys = ON;")
-			);
-
-			await Promise.all(
-				args.changes.map(async (change) => {
-					if (change.plugin_key !== "lix_own_change_control") {
-						throw new Error(
-							"Expected 'lix_own_change_control' as plugin key but received " +
-								change.plugin_key
-						);
-					}
-					const snapshot = await trx
-						.selectFrom("snapshot")
-						.where("id", "=", change.snapshot_id)
-						.select("content")
-						.executeTakeFirstOrThrow();
-
-					// remove the prefix and suffix from the schema key
-					// `lix_key_value_table` -> `key_value`
-					const tableName = change.schema_key
-						.replace(/^lix_/, "")
-						.replace(/_table$/, "") as keyof typeof changeControlledTableIds;
-
-					const primaryKeys = primaryKeysForEntityId(
-						tableName,
-						change.entity_id
-					);
-
-					let query:
-						| DeleteQueryBuilder<
-								LixDatabaseSchema,
-								keyof typeof changeControlledTableIds,
-								DeleteResult
-						  >
-						| InsertQueryBuilder<
-								LixDatabaseSchema,
-								keyof typeof changeControlledTableIds,
-								InsertResult
-						  >;
-
-					// deletion
-					if (snapshot.content === null) {
-						query = trx.deleteFrom(tableName);
-						for (const [key, value] of primaryKeys) {
-							query = query.where(key as any, "=", value);
-						}
-					}
-					// upsert
-					else {
-						// take the current file data if the table is `file`
-						// (can be optimized later to adjust the query instead)
-						if (tableName === "file") {
-							const data = await trx
-								.selectFrom("file")
-								.where("id", "=", change.entity_id)
-								.select("data")
-								.executeTakeFirst();
-
-							snapshot.content.data =
-								data?.data ??
-								// empty uint8array will trigger applyChanges() to pass an empty file to the plugin
-								new Uint8Array();
-						}
-
-						query = trx
-							.insertInto(tableName)
-							.values(snapshot.content)
-							.onConflict((oc) => oc.doUpdateSet(snapshot.content!));
-					}
-
-					await query.execute();
-				})
-			);
-		});
-	};
-
-	if (args.lix.db.isTransaction) {
-		return await executeInTransaction(args.lix.db);
-	} else {
-		return await args.lix.db.transaction().execute(executeInTransaction);
-	}
-}

package/src/own-change-control/change-controlled-tables.test.ts

@@ -1,69 +0,0 @@
-import { test, expect } from "vitest";
-import type { LixDatabaseSchema } from "../database/schema.js";
-import {
-	changeControlledTableIds,
-	entityIdForRow,
-	primaryKeysForEntityId,
-	type PragmaTableInfo,
-} from "./change-controlled-tables.js";
-import { loadDatabaseInMemory } from "sqlite-wasm-kysely";
-import { newLixFile } from "../lix/new-lix.js";
-
-test("roundtrip entity_id test for single primary key", () => {
-	const tableName: keyof LixDatabaseSchema = "key_value";
-	const row = ["lix_mock_key", "value1"];
-
-	const entityId = entityIdForRow(tableName, ...row);
-	const primaryKeys = primaryKeysForEntityId(tableName, entityId);
-
-	expect(entityId).toBe("lix_mock_key");
-	expect(primaryKeys).toEqual([["key", "lix_mock_key"]]);
-});
-
-test("roundtrip entity_id test for compound primary keys", () => {
-	const tableName: keyof LixDatabaseSchema = "change_author";
-
-	const row = ["294u-2345", "0128-34928"];
-
-	const entityId = entityIdForRow(tableName, ...row);
-	const primaryKeys = primaryKeysForEntityId(tableName, entityId);
-
-	expect(entityId).toBe("294u-2345,0128-34928");
-	expect(primaryKeys).toEqual([
-		["change_id", "294u-2345"],
-		["account_id", "0128-34928"],
-	]);
-});
-
-// otherwise the change controlled entity_id will be wrong.
-//* if this tests fails, someone did a db schema change
-//* on the primary key order that should not have been done.
-test("the primary key order matches the order the primary keys in the database schema", async () => {
-	const sqlite = await loadDatabaseInMemory(
-		await (await newLixFile()).arrayBuffer()
-	);
-
-	const tableInfos: Record<string, PragmaTableInfo> = {};
-
-	for (const table of Object.keys(changeControlledTableIds)) {
-		tableInfos[table] = sqlite.exec({
-			sql: `PRAGMA table_info(${table});`,
-			returnValue: "resultRows",
-			rowMode: "object",
-		}) as PragmaTableInfo;
-	}
-
-	for (const table of Object.keys(changeControlledTableIds)) {
-		const tableInfo = tableInfos[table]!;
-
-		const primaryKeys = tableInfo
-			.filter((column) => column.pk)
-			.sort((a, b) => a.pk - b.pk)
-			.map((c) => c.name);
-
-		expect(primaryKeys).toEqual(
-			// @ts-expect-error - some type narrowing problem. not important
-			changeControlledTableIds[table]
-		);
-	}
-});

package/src/own-change-control/change-controlled-tables.ts

@@ -1,102 +0,0 @@
-export const changeControlledTableIds = {
-	account: ["id"],
-	comment: ["id"],
-	change_set: ["id"],
-	change_author: ["change_id", "account_id"],
-	change_set_element: ["change_set_id", "change_id"],
-	change_set_label: ["label_id", "change_set_id"],
-	discussion: ["id"],
-	file: ["id"],
-	key_value: ["key"],
-	version: ["id"],
-	version_change: ["version_id", "change_id"],
-} as const;
-
-//
-// uo28ns,-3-9u2h
-
-/**
- * The result of a PRAGMA table_info call.
- *
- * @example
- *   	const tableInfo = sqlite.exec({
- *		  sql: `PRAGMA table_info(change_author);`,
- *		  returnValue: "resultRows",
- *		  rowMode: "object",
- *	  }) as PragmaTableInfo;
- */
-export type PragmaTableInfo = Array<{
-	/**
-	 * The column name
-	 */
-	name: string;
-	/**
-	 * 0 if not a primary key
-	 * 1 if primary key
-	 * 2... if part of a multi-column primary key
-	 */
-	pk: number;
-}>;
-
-/**
- * Returns the entity id for a row in a change controlled table.
- */
-export function entityIdForRow(
-	/**
-	 * The name of the table.
-	 */
-	tableName: keyof typeof changeControlledTableIds,
-	/**
-	 * The values of the row.
-	 */
-	...values: any[]
-): string {
-	let entityId = "";
-
-	// only has one primary key
-	if (changeControlledTableIds[tableName]!.length === 1) {
-		const index = changeControlledTableIds[tableName]!.indexOf(
-			// @ts-expect-error - no clue why
-			changeControlledTableIds[tableName]![0]
-		);
-		entityId = values[index];
-	}
-	// has compound primary key that are joined with a comma.
-	else {
-		for (const column of changeControlledTableIds[tableName]!) {
-			const index = changeControlledTableIds[tableName]!.indexOf(
-				// @ts-expect-error - no clue why
-				column
-			);
-			if (entityId === "") {
-				entityId = values[index];
-			} else {
-				entityId = [entityId, values[index]].join(",");
-			}
-		}
-	}
-
-	return entityId;
-}
-
-/**
- * Returns the primary keys for a row in a change controlled table.
- */
-export function primaryKeysForEntityId(
-	/**
-	 * The name of the table.
-	 */
-	tableName: keyof typeof changeControlledTableIds,
-	/**
-	 * The values of the row.
-	 */
-	entitiyId: string
-): [string, any][] {
-	const primaryKeys = changeControlledTableIds[tableName]!;
-
-	if (primaryKeys.length === 1) {
-		return [[primaryKeys[0]!, entitiyId]];
-	} else {
-		return entitiyId.split(",").map((id, index) => [primaryKeys[index]!, id]);
-	}
-}

package/src/own-change-control/database-triggers.test.ts

@@ -1,259 +0,0 @@
-import { expect, test } from "vitest";
-import { openLixInMemory } from "../lix/open-lix-in-memory.js";
-import { createAccount } from "../account/create-account.js";
-import { createChange } from "../change/create-change.js";
-
-test("it works for inserts, updates and deletions", async () => {
-	const lix = await openLixInMemory({});
-
-	// insert
-	await lix.db
-		.insertInto("key_value")
-		.values({ key: "key1", value: "value1" })
-		.execute();
-
-	// update
-	await lix.db
-		.updateTable("key_value")
-		.set("value", "value2")
-		.where("key", "=", "key1")
-		.execute();
-
-	// delete
-	await lix.db.deleteFrom("key_value").where("key", "=", "key1").execute();
-
-	const changes = await lix.db
-		.selectFrom("change")
-		.innerJoin("snapshot", "snapshot.id", "change.snapshot_id")
-		.where("schema_key", "=", "lix_key_value_table")
-		.selectAll()
-		.execute();
-
-	const snapshots = changes.map((change) => change.content);
-
-	expect(changes.length).toBe(3);
-
-	for (const change of changes) {
-		expect(change.entity_id).toBe("key1");
-		expect(change.file_id).toBe("lix_own_change_control");
-		expect(change.plugin_key).toBe("lix_own_change_control");
-		expect(change.schema_key).toBe("lix_key_value_table");
-	}
-
-	expect(snapshots).toMatchObject([
-		// insert
-		{ key: "key1", value: "value1" },
-		// update
-		{ key: "key1", value: "value2" },
-		// delete
-		null,
-	]);
-});
-
-test("it works for compound entity ids like change_author", async () => {
-	const lix = await openLixInMemory({});
-
-	const account1 = await createAccount({ lix, name: "account1" });
-
-	const currentVersion = await lix.db
-		.selectFrom("current_version")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	await createChange({
-		lix,
-		version: currentVersion,
-		authors: [account1],
-		pluginKey: "mock-plugin",
-		schemaKey: "mock",
-		fileId: "mock",
-		entityId: "mock",
-		snapshotContent: null,
-	});
-
-	const changes = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_change_author_table")
-		.innerJoin("snapshot", "snapshot.id", "change.snapshot_id")
-		.selectAll()
-		.execute();
-
-	expect(changes.length).toBe(1);
-});
-
-test("if the trigger throws, the transaction is rolled back", async () => {
-	const lix = await openLixInMemory({});
-
-	const account1 = await createAccount({ lix, name: "account1" });
-
-	const insertChange = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_account_table")
-		.where("entity_id", "=", account1.id)
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	expect(insertChange).toBeDefined();
-
-	// deleting the active accounts aka there will be no change author
-	// which will lead to a throw in the trigger
-	await lix.db.deleteFrom("active_account").execute();
-
-	// now we are deleting the account we just created
-	try {
-		await lix.db.deleteFrom("account").where("id", "=", account1.id).execute();
-	} catch (e) {
-		expect(e).toBeDefined();
-	}
-
-	const account1AfterFailedDeleted = await lix.db
-		.selectFrom("account")
-		.where("id", "=", account1.id)
-		.selectAll()
-		.executeTakeFirst();
-
-	const deleteChange = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_account_table")
-		.where("entity_id", "=", account1.id)
-		.where("snapshot_id", "=", "no-content")
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(account1AfterFailedDeleted).toBeDefined();
-	expect(account1AfterFailedDeleted).toStrictEqual(account1);
-	expect(deleteChange).toBeUndefined();
-});
-
-test("skips change control of key values if `skip_change_control` is set to true", async () => {
-	const lix = await openLixInMemory({});
-
-	await lix.db
-		.insertInto("key_value")
-		.values({ key: "key1", value: "value1", skip_change_control: true })
-		.execute();
-
-	const key1 = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "key1")
-		.selectAll()
-		.executeTakeFirst();
-
-	const key1Change = await lix.db
-		.selectFrom("change")
-		.where("entity_id", "=", "key1")
-		.selectAll()
-		.executeTakeFirst();
-
-	expect(key1).toBeDefined();
-	expect(key1Change).toBeUndefined();
-});
-
-// the sqlite jsonb representation should not be used externally
-// hence, we need to store the metadata as string in the snapshot
-test("file.metadata is tracked as json string, not binary.", async () => {
-	const lix = await openLixInMemory({});
-
-	const file = await lix.db
-		.insertInto("file")
-		.values({
-			data: new Uint8Array(),
-			path: "/mock.txt",
-			metadata: { key: "value" },
-		})
-		.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()
-		.executeTakeFirstOrThrow();
-
-	expect(change.content?.metadata).toStrictEqual({
-		key: "value",
-	});
-});
-
-test("file.data is not own change controlled as plugins handle the change control of file data", async () => {
-	const lix = await openLixInMemory({});
-
-	const file = await lix.db
-		.insertInto("file")
-		.values({
-			path: "/mock.txt",
-			data: new TextEncoder().encode("hello world"),
-		})
-		.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()
-		.executeTakeFirstOrThrow();
-
-	expect(change.content?.data).toBe(undefined);
-});
-
-test("updating file.data does not trigger own change control", async () => {
-	const lix = await openLixInMemory({});
-
-	const file = await lix.db
-		.insertInto("file")
-		.values({
-			id: "file1",
-			data: new TextEncoder().encode("hello world"),
-			path: "/mock.txt",
-			metadata: null,
-		})
-		.returningAll()
-		.executeTakeFirstOrThrow();
-
-	let changes = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_file_table")
-		.where("entity_id", "=", file.id)
-		.selectAll()
-		.execute();
-
-	expect(changes.length).toBe(1);
-
-	await lix.db
-		.updateTable("file")
-		.set({ data: new TextEncoder().encode("hello world 2") })
-		.where("id", "=", file.id)
-		.execute();
-
-	changes = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_file_table")
-		.where("entity_id", "=", file.id)
-		.selectAll()
-		.execute();
-
-	expect(changes.length).toBe(1);
-
-	// the metadata should be change controlled
-	// hence, this should trigger a change
-	await lix.db
-		.updateTable("file")
-		.set({
-			data: new TextEncoder().encode("hello world 3"),
-			metadata: { key: "value" },
-		})
-		.execute();
-
-	changes = await lix.db
-		.selectFrom("change")
-		.where("schema_key", "=", "lix_file_table")
-		.where("entity_id", "=", file.id)
-		.selectAll()
-		.execute();
-
-	expect(changes.length).toBe(2);
-});