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

package/src/change-proposal/create-change-proposal.test.ts

@@ -0,0 +1,106 @@
+import { test, expect } from "vitest";
+import { openLix } from "../lix/open-lix.js";
+import { createChangeSet } from "../change-set/create-change-set.js";
+import { createChangeProposal } from "./create-change-proposal.js";
+
+test.skip("creating a change proposal should compute the symmetric difference", async () => {
+	const lix = await openLix({});
+
+	// Create some changes for change sets
+	const mockChanges = await lix.db
+		.insertInto("change")
+		.values([
+			// Change 1 - only in source change set
+			{
+				schema_key: "file",
+				schema_version: "1.0",
+				entity_id: "value1",
+				file_id: "mock1",
+				plugin_key: "mock-plugin",
+				snapshot_content: null,
+			},
+			// Change 2 - in both source and target (so not in symmetric difference)
+			{
+				schema_key: "file",
+				schema_version: "1.0",
+				entity_id: "value2",
+				file_id: "mock2",
+				plugin_key: "mock-plugin",
+				snapshot_content: null,
+			},
+			// Change 3 - only in target change set
+			{
+				schema_key: "file",
+				entity_id: "value3",
+				file_id: "mock3",
+				schema_version: "1.0",
+				plugin_key: "mock-plugin",
+				snapshot_content: null,
+			},
+		])
+		.returningAll()
+		.execute();
+
+	// Create source change set with changes 1 and 2
+	const sourceChangeSet = await createChangeSet({
+		lix: lix,
+		elements: mockChanges.slice(0, 2).map((change) => ({
+			change_id: change.id,
+			entity_id: change.entity_id,
+			schema_key: change.schema_key,
+			file_id: change.file_id,
+		})),
+	});
+
+	// Create target change set with changes 2 and 3
+	const targetChangeSet = await createChangeSet({
+		lix: lix,
+		elements: mockChanges.slice(1, 3).map((change) => ({
+			change_id: change.id,
+			entity_id: change.entity_id,
+			schema_key: change.schema_key,
+			file_id: change.file_id,
+		})),
+	});
+
+	// Create a change proposal
+	const proposal = await createChangeProposal({
+		lix: lix,
+		sourceChangeSet: sourceChangeSet,
+		targetChangeSet: targetChangeSet,
+	});
+
+	// Verify the change proposal was created with the correct data
+	expect(proposal).toMatchObject({
+		id: expect.any(String),
+		source_change_set_id: sourceChangeSet.id,
+		target_change_set_id: targetChangeSet.id,
+	});
+
+	// The change_set_id should be a new change set
+	expect(proposal.change_set_id).not.toBe(sourceChangeSet.id);
+	expect(proposal.change_set_id).not.toBe(targetChangeSet.id);
+
+	// Verify the new change set contains only the changes in the symmetric difference
+	const changeSetElements = await lix.db
+		.selectFrom("change_set_element")
+		.selectAll()
+		.where("change_set_id", "=", proposal.change_set_id)
+		.execute();
+
+	// Should have 2 changes: change1 and change3, but not change2 (which is in both sets)
+	expect(changeSetElements).toHaveLength(2);
+
+	// Expected change IDs: the first and third change
+	const expectedChangeIds = [mockChanges[0]!.id, mockChanges[2]!.id];
+
+	// Verify that both expected change IDs are in the result
+	expect(changeSetElements.map((el) => el.change_id)).toEqual(
+		expect.arrayContaining(expectedChangeIds)
+	);
+
+	// Verify no other changes are included (particularly not the common change)
+	expect(
+		changeSetElements.some((el) => el.change_id === mockChanges[1]!.id)
+	).toBe(false);
+});

package/src/change-proposal/create-change-proposal.ts

@@ -0,0 +1,71 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+
+import type { ChangeSet } from "../change-set/schema.js";
+import type { Lix } from "../lix/open-lix.js";
+import type { ChangeProposal } from "./database-schema.js";
+import { createChangeSet } from "../change-set/create-change-set.js";
+import { changeSetElementInSymmetricDifference } from "../query-filter/change-set-element-in-symmetric-difference.js";
+
+/**
+ * Creates a change proposal that represents the symmetric difference
+ * between the source and target change sets.
+ *
+ * The symmetric difference contains changes that are in either the source
+ * or target change set, but not in both.
+ */
+export async function createChangeProposal(args: {
+	lix: Lix;
+	sourceChangeSet: Pick<ChangeSet, "id">;
+	targetChangeSet: Pick<ChangeSet, "id">;
+}): Promise<ChangeProposal> {
+	const executeInTransaction = async (trx: Lix["db"]) => {
+		// Get the changes that are in the symmetric difference between the two change sets
+		const symmetricDifferenceChanges = await trx
+			.selectFrom("change_set_element")
+			.where(
+				changeSetElementInSymmetricDifference(
+					args.sourceChangeSet,
+					args.targetChangeSet
+				)
+			)
+			.select(["change_id as id", "entity_id", "schema_key", "file_id"])
+			.execute();
+
+		if (symmetricDifferenceChanges.length === 0) {
+			throw new Error(
+				"No changes in symmetric difference between source and target change sets."
+			);
+		}
+
+		// Create a new change set with the symmetric difference changes
+		const newChangeSet = await createChangeSet({
+			lix: { ...args.lix, db: trx },
+			elements: symmetricDifferenceChanges.map((change) => ({
+				change_id: change.id,
+				entity_id: change.entity_id,
+				schema_key: change.schema_key,
+				file_id: change.file_id,
+			})),
+		});
+
+		// Create the change proposal
+		const result = await trx
+			.insertInto("change_proposal")
+			.values({
+				change_set_id: newChangeSet.id,
+				source_change_set_id: args.sourceChangeSet.id,
+				target_change_set_id: args.targetChangeSet.id,
+			})
+			.returningAll()
+			.executeTakeFirstOrThrow();
+
+		return result;
+	};
+
+	if (args.lix.db.isTransaction) {
+		return executeInTransaction(args.lix.db);
+	} else {
+		return args.lix.db.transaction().execute(executeInTransaction);
+	}
+}

package/src/change-proposal/database-schema.test.ts

@@ -0,0 +1,180 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+
+import { expect, test } from "vitest";
+import { openLix } from "../lix/open-lix.js";
+import { createChangeSet } from "../change-set/create-change-set.js";
+import { validate } from "uuid";
+
+test.skip("change_proposal.id should default to uuid_v7", async () => {
+	const lix = await openLix({});
+
+	// Create some changes first
+	const mockChange = await lix.db
+		.insertInto("change")
+		.values({
+			schema_key: "file",
+			entity_id: "entity1",
+			file_id: "mock",
+			plugin_key: "mock-plugin",
+			snapshot_content: null,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	// Create a change set to use in the proposal
+	const changeSet = await createChangeSet({
+		lix,
+		elements: [
+			{
+				change_id: mockChange.id,
+				entity_id: mockChange.entity_id,
+				schema_key: mockChange.schema_key,
+				file_id: mockChange.file_id,
+			},
+		],
+	});
+
+	// Now we can test the change proposal with valid foreign keys
+	const result = await lix.db
+		.insertInto("change_proposal")
+		.values({
+			change_set_id: changeSet.id,
+			source_change_set_id: changeSet.id,
+			target_change_set_id: changeSet.id,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	expect(validate(result.id)).toBe(true);
+});
+
+test.skip("change proposals are change controlled", async () => {
+	const lix = await openLix({});
+
+	const mockChange = await lix.db
+		.insertInto("change")
+		.values({
+			schema_key: "file",
+			entity_id: "entity1",
+			file_id: "mock",
+			plugin_key: "mock-plugin",
+			snapshot_content: null,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	// Create a change set to use in the proposal
+	const changeSet = await createChangeSet({
+		lix,
+		elements: [
+			{
+				change_id: mockChange.id,
+				entity_id: mockChange.entity_id,
+				schema_key: mockChange.schema_key,
+				file_id: mockChange.file_id,
+			},
+		],
+	});
+
+	const result = await lix.db
+		.insertInto("change_proposal")
+		.values({
+			change_set_id: changeSet.id,
+			source_change_set_id: changeSet.id,
+			target_change_set_id: changeSet.id,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	const change = await lix.db
+		.selectFrom("change")
+		.where("entity_id", "=", result.id)
+		.where("schema_key", "=", "lix_change_proposal_table")
+		.selectAll()
+		.executeTakeFirstOrThrow();
+
+	expect(change.entity_id).toBe(result.id);
+});
+
+test.skip("source change set id is nullable", async () => {
+	const lix = await openLix({});
+
+	const mockChange = await lix.db
+		.insertInto("change")
+		.values({
+			schema_key: "file",
+			entity_id: "entity1",
+			file_id: "mock",
+			plugin_key: "mock-plugin",
+			snapshot_content: null,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	// Create a change set to use in the proposal
+	const changeSet = await createChangeSet({
+		lix,
+		elements: [
+			{
+				change_id: mockChange.id,
+				entity_id: mockChange.entity_id,
+				schema_key: mockChange.schema_key,
+				file_id: mockChange.file_id,
+			},
+		],
+	});
+
+	const result = await lix.db
+		.insertInto("change_proposal")
+		.values({
+			change_set_id: changeSet.id,
+			source_change_set_id: null,
+			target_change_set_id: changeSet.id,
+		})
+		.onConflict((oc) => oc.doNothing())
+		.execute();
+
+	expect(result).toBeDefined();
+});
+
+test.skip("target change set id is not nullable", async () => {
+	const lix = await openLix({});
+
+	const mockChange = await lix.db
+		.insertInto("change")
+		.values({
+			schema_key: "file",
+			entity_id: "entity1",
+			file_id: "mock",
+			plugin_key: "mock-plugin",
+			snapshot_content: null,
+		})
+		.returningAll()
+		.executeTakeFirstOrThrow();
+
+	// Create a change set to use in the proposal
+	const changeSet = await createChangeSet({
+		lix,
+		elements: [
+			{
+				change_id: mockChange.id,
+				entity_id: mockChange.entity_id,
+				schema_key: mockChange.schema_key,
+				file_id: mockChange.file_id,
+			},
+		],
+	});
+
+	const result = await lix.db
+		.insertInto("change_proposal")
+		.values({
+			change_set_id: changeSet.id,
+			source_change_set_id: changeSet.id,
+			target_change_set_id: null,
+		})
+		.onConflict((oc) => oc.doNothing())
+		.execute();
+
+	expect(result).toBeDefined();
+});

package/src/change-proposal/database-schema.ts

@@ -0,0 +1,32 @@
+import type { Generated, Insertable, Selectable, Updateable } from "kysely";
+import type { SqliteWasmDatabase } from "sqlite-wasm-kysely";
+
+export function applyChangeProposalDatabaseSchema(
+	sqlite: SqliteWasmDatabase
+): SqliteWasmDatabase {
+	const sql = `
+  CREATE TABLE IF NOT EXISTS change_proposal (
+    id TEXT PRIMARY KEY DEFAULT (uuid_v7()),
+
+    change_set_id TEXT NOT NULL,
+    source_change_set_id TEXT,
+    target_change_set_id  TEXT,
+
+    FOREIGN KEY(change_set_id) REFERENCES change_set(id),
+    FOREIGN KEY(source_change_set_id) REFERENCES change_set(id),
+    FOREIGN KEY(target_change_set_id) REFERENCES change_set(id)
+  ) STRICT;
+`;
+
+	return sqlite.exec(sql);
+}
+
+export type ChangeProposal = Selectable<ChangeProposalTable>;
+export type NewChangeProposal = Insertable<ChangeProposalTable>;
+export type ChangeProposalUpdate = Updateable<ChangeProposalTable>;
+export type ChangeProposalTable = {
+	id: Generated<string>;
+	change_set_id: string;
+	source_change_set_id: string | null;
+	target_change_set_id: string | null;
+};

package/src/change-proposal/index.ts

@@ -0,0 +1,2 @@
+export * from "./database-schema.js";
+export * from "./create-change-proposal.js";