@inlang/sdk 2.0.0-prerelease.0 → 2.0.1

package/node_modules/@lix-js/sdk/src/sync/pull-from-server.test.ts

@@ -1,425 +0,0 @@
-import { expect, test, vi } from "vitest";
-import { createServerApiHandler } from "../server-api-handler/create-server-api-handler.js";
-import { openLixInMemory } from "../lix/open-lix-in-memory.js";
-import { pullFromServer } from "./pull-from-server.js";
-import { mockJsonSnapshot } from "../snapshot/mock-json-snapshot.js";
-import { createLsaInMemoryEnvironment } from "../server-api-handler/environment/create-in-memory-environment.js";
-import { toBlob } from "../lix/to-blob.js";
-
-test("pull rows of multiple tables from server successfully and applies them", async () => {
-	const lixOnServer = await openLixInMemory({});
-
-	const lix = await openLixInMemory({
-		blob: await toBlob({ lix: lixOnServer }),
-	});
-
-	const { value: id } = await lixOnServer.db
-		.selectFrom("key_value")
-		.where("key", "=", "lix_id")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	const environment = createLsaInMemoryEnvironment();
-	const lsaHandler = await createServerApiHandler({ environment });
-
-	global.fetch = vi.fn((request) => lsaHandler(request));
-
-	await lixOnServer.db
-		.insertInto("account")
-		.values({ id: "account0", name: "test account" })
-		.execute();
-
-	await lixOnServer.db
-		.insertInto("key_value")
-		.values({
-			key: "mock-key",
-			value: "mock-value",
-		})
-		.execute();
-
-	// initialize the lix on the server with the mock data
-	await lsaHandler(
-		new Request("http://localhost:3000/lsa/new-v1", {
-			method: "POST",
-			body: await toBlob({ lix: lixOnServer }),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-
-	await pullFromServer({
-		id,
-		lix,
-		serverUrl: "http://localhost:3000",
-	});
-
-	// Verify the data is pulled into the local lix
-	// and applied to the local database
-	const account = await lix.db
-		.selectFrom("account")
-		.where("id", "=", "account0")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	const mockKey = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "mock-key")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	expect(account).toEqual({ id: "account0", name: "test account" });
-	expect(mockKey).toMatchObject({ key: "mock-key", value: "mock-value" });
-});
-
-test("it handles snapshot.content being json binary", async () => {
-	const lixOnServer = await openLixInMemory({});
-
-	const lix = await openLixInMemory({
-		blob: await toBlob({ lix: lixOnServer }),
-	});
-
-	const { value: id } = await lixOnServer.db
-		.selectFrom("key_value")
-		.where("key", "=", "lix_id")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	const environment = createLsaInMemoryEnvironment();
-	const lsaHandler = await createServerApiHandler({ environment });
-
-	global.fetch = vi.fn((request) => lsaHandler(request));
-
-	const mockSnapshot = mockJsonSnapshot({
-		location: "Berlin",
-	});
-
-	// insert mock data into server lix
-	await lixOnServer.db
-		.insertInto("snapshot")
-		.values({
-			content: mockSnapshot.content,
-		})
-		.execute();
-
-	// initialize the lix on the server with the mock data
-	await lsaHandler(
-		new Request("http://localhost:3000/lsa/new-v1", {
-			method: "POST",
-			body: await toBlob({ lix: lixOnServer }),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-
-	await pullFromServer({
-		id,
-		lix,
-		serverUrl: "http://localhost:3000",
-	});
-
-	// Verify the data is pulled into the local lix
-	const snapshots = await lix.db
-		.selectFrom("snapshot")
-		.where("id", "=", mockSnapshot.id)
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	expect(snapshots).toMatchObject(mockSnapshot);
-});
-
-test("rows changed on the client more recently should not be updated", async () => {
-	const lixOnServer = await openLixInMemory({});
-
-	const lixId = await lixOnServer.db
-		.selectFrom("key_value")
-		.where("key", "=", "lix_id")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	await lixOnServer.db
-		.insertInto("key_value")
-		.values({
-			key: "mock-key",
-			value: "mock-value-initial",
-		})
-		.executeTakeFirstOrThrow();
-
-	const lix = await openLixInMemory({
-		blob: await toBlob({ lix: lixOnServer }),
-	});
-
-	const environment = createLsaInMemoryEnvironment();
-	const lsaHandler = await createServerApiHandler({ environment });
-
-	global.fetch = vi.fn((request) => lsaHandler(request));
-
-	// initialize the lix on the server with the mock data
-	await lsaHandler(
-		new Request("http://localhost:3000/lsa/new-v1", {
-			method: "POST",
-			body: await toBlob({ lix: lixOnServer }),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-
-	// update the mock data on the client
-	await lix.db
-		.updateTable("key_value")
-		.set({ value: "mock-value-updated" })
-		.where("key", "=", "mock-key")
-		.execute();
-
-	await pullFromServer({
-		id: lixId.value,
-		lix,
-		serverUrl: "http://localhost:3000",
-	});
-
-	// verify data on client
-	const mockKey = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "mock-key")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	expect(mockKey).toMatchObject({
-		key: "mock-key",
-		value: "mock-value-updated",
-	});
-});
-
-// the change table now models "change control". no more last edit wins needed
-test.skip("rows changed on the server more recently should be updated on the client", async () => {
-	// setup mock server
-	const environment = createLsaInMemoryEnvironment();
-	const lsaHandler = await createServerApiHandler({ environment });
-
-	global.fetch = vi.fn((request) => lsaHandler(request));
-
-	// create a lix and clone it for the client - so they share the same lix id
-	const remoteLix = await openLixInMemory({});
-	const localLix = await openLixInMemory({
-		blob: await toBlob({ lix: remoteLix }),
-	});
-
-	// insert mock data into server lix
-	await remoteLix.db
-		.insertInto("account")
-		.values({ id: "account0", name: "test account" })
-		.execute();
-
-	await remoteLix.db
-		.insertInto("key_value")
-		.values({
-			key: "mock-key",
-			value: "mock-value",
-		})
-		.execute();
-
-	// let the wall clock move one ms forward
-	await new Promise((resolve) => setTimeout(resolve, 1));
-
-	// insert conflicting mock data into local lix
-	await localLix.db
-		.insertInto("account")
-		.values({
-			id: "account0",
-			name: "test account updated more recently on client",
-		})
-		.execute();
-
-	// let the wall clock move one ms forward
-	await new Promise((resolve) => setTimeout(resolve, 1));
-
-	// update the conflicting mock data on the server as well
-	await remoteLix.db
-		.updateTable("account")
-		.set({ name: "test account updated more recently on the server" })
-		.where("account.id", "=", "account0")
-		.execute();
-
-	// initialize the lix on the server with the mock data
-	await lsaHandler(
-		new Request("http://localhost:3000/lsa/new-v1", {
-			method: "POST",
-			body: await toBlob({ lix: remoteLix }),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-
-	const { value: id } = await localLix.db
-		.selectFrom("key_value")
-		.where("key", "=", "lix_id")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	await pullFromServer({
-		id,
-		lix: localLix,
-		serverUrl: "http://localhost:3000",
-	});
-
-	// Verify the data is pulled into the local lix
-	const account = await localLix.db
-		.selectFrom("account")
-		.where("id", "=", "account0")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	// TODO we don't sync tables without row id atm
-	// const mockKey = await lix.db
-	// 	.selectFrom("key_value")
-	// 	.where("key", "=", "mock-key")
-	// 	.selectAll()
-	// 	.executeTakeFirstOrThrow();
-
-	expect(account).toEqual({
-		id: "account0",
-		name: "test account updated more recently on the server",
-	});
-
-	const mockKey = await localLix.db
-		.selectFrom("key_value")
-		.where("key", "=", "mock-key")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	expect(mockKey).toEqual({ key: "mock-key", value: "mock-value" });
-});
-
-// test("it should handle files without syncing the data column", async () => {
-// 	const lix = await openLixInMemory({});
-
-// 	const { value: id } = await lix.db
-// 		.selectFrom("key_value")
-// 		.where("key", "=", "lix_id")
-// 		.selectAll()
-// 		.executeTakeFirstOrThrow();
-
-// 	const environment = createLsaInMemoryEnvironment();
-// 	const lsaHandler = await createServerApiHandler({ environment });
-
-// 	global.fetch = vi.fn((request) => lsaHandler(request));
-
-// 	// initialize the lix on the server
-// 	await lsaHandler(
-// 		new Request("http://localhost:3000/lsa/new", {
-// 			method: "POST",
-// 			body: await lix.toBlob(),
-// 		})
-// 	);
-
-// 	// Insert mock file data into the server's environment
-// 	await environment.executeSql(
-// 		"INSERT INTO file (id, path, data, metadata) VALUES ('file0', '/path.txt', ?, 'mock-metadata')",
-// 		[new TextEncoder().encode("Hello, World!")]
-// 	);
-
-// 	await pullFromServer({
-// 		id,
-// 		lix,
-// 		serverUrl: "http://localhost:3000",
-// 		tableNames: ["file"],
-// 	});
-
-// 	// Verify the data is pulled into the local database without the `data` column
-// 	const filesInDb = await lix.db.selectFrom("file").selectAll().execute();
-
-// 	expect(filesInDb).toEqual([
-// 		{
-// 			id: "file0",
-// 			path: "/path.txt",
-// 			metadata: "mock-metadata",
-// 		},
-// 	]);
-// });
-
-test("non-conflicting changes from the server should for the same version should be applied", async () => {
-	const lix = await openLixInMemory({});
-
-	const currentVersion = await lix.db
-		.selectFrom("current_version")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	const lixId = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "lix_id")
-		.selectAll()
-		.executeTakeFirstOrThrow();
-
-	const environment = createLsaInMemoryEnvironment();
-	const lsaHandler = await createServerApiHandler({ environment });
-
-	global.fetch = vi.fn((request) => lsaHandler(request));
-
-	const lixOnServer = await openLixInMemory({ blob: await toBlob({ lix }) });
-
-	// insert data on the server that the client does not have yet
-	await lixOnServer.db
-		.insertInto("key_value")
-		.values({ key: "mock-key", value: "mock-value" })
-		.execute();
-
-	const serverVersionChanges = await lixOnServer.db
-		.selectFrom("version_change")
-		.innerJoin("change", "version_change.change_id", "change.id")
-		.innerJoin("snapshot", "change.snapshot_id", "snapshot.id")
-		.where("version_id", "=", currentVersion.id)
-		.selectAll("version_change")
-		.select("snapshot.content as content")
-		.execute();
-
-	// the server should have the change we just made
-	expect(serverVersionChanges).toEqual(
-		expect.arrayContaining([
-			expect.objectContaining({
-				version_id: currentVersion.id,
-				content: expect.objectContaining({
-					key: "mock-key",
-					value: "mock-value",
-				}),
-			}),
-		])
-	);
-
-	await lsaHandler(
-		new Request("http://localhost:3000/lsa/new-v1", {
-			method: "POST",
-			body: await toBlob({ lix: lixOnServer }),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-
-	await pullFromServer({
-		id: lixId.value,
-		lix,
-		serverUrl: "http://localhost:3000",
-	});
-
-	const mockKey = await lix.db
-		.selectFrom("key_value")
-		.where("key", "=", "mock-key")
-		.selectAll()
-		.executeTakeFirst();
-
-	const versionChanges = await lix.db
-		.selectFrom("version_change")
-		.innerJoin("change", "version_change.change_id", "change.id")
-		.innerJoin("snapshot", "change.snapshot_id", "snapshot.id")
-		.where("version_id", "=", currentVersion.id)
-		.selectAll("version_change")
-		.select("snapshot.content as content")
-		.execute();
-
-	expect(mockKey).toMatchObject({ key: "mock-key", value: "mock-value" });
-	expect(versionChanges).toEqual(expect.arrayContaining(serverVersionChanges));
-});

package/node_modules/@lix-js/sdk/src/sync/pull-from-server.ts

@@ -1,144 +0,0 @@
-import type { Lix } from "../lix/open-lix.js";
-import * as LixServerApi from "@lix-js/server-api-schema";
-import { mergeTheirState, type VectorClock } from "./merge-state.js";
-import { applyChanges } from "../change/apply-changes.js";
-import type { Change } from "../database/schema.js";
-import { CompiledQuery } from "kysely";
-
-export async function pullFromServer(args: {
-	id: string;
-	lix: Pick<Lix, "db" | "plugin">;
-	serverUrl: string;
-}): Promise<VectorClock> {
-	// 1. get the current vector clock on the client "sessionStatesKnownByTheClient" and send it to the server
-	const sessionStatesClient = await args.lix.db
-		.selectFrom("mutation_log")
-		.select(({ fn }) => {
-			return ["session", fn.max<number>("session_time").as("time")];
-		})
-		.groupBy("session")
-		.execute();
-
-	// 2. query the state from the server using the clients vector clock
-	const response = await fetch(
-		new Request(`${args.serverUrl}/lsa/pull-v1`, {
-			method: "POST",
-			body: JSON.stringify({
-				lix_id: args.id,
-				vector_clock: sessionStatesClient,
-			} satisfies LixServerApi.paths["/lsa/pull-v1"]["post"]["requestBody"]["content"]["application/json"]),
-			headers: {
-				"Content-Type": "application/json",
-			},
-		})
-	);
-	if (response.ok === false) {
-		try {
-			const body = await response.json();
-			throw new Error(
-				`Failed to pull from server: ${body.code} ${body.message}`
-			);
-		} catch {
-			throw new Error(
-				`Failed to pull from server: ${response.status} ${response.statusText}`
-			);
-		}
-	}
-	const body = await response.json();
-
-	// 3. Client receives the data (added/changed rows + vector clock) from the server
-	//   - client could have moved forward in the meantime!
-	const data = (
-		body as LixServerApi.paths["/lsa/pull-v1"]["post"]["responses"]["200"]["content"]["application/json"]
-	).data;
-
-	const sessionStateServer = (
-		body as LixServerApi.paths["/lsa/pull-v1"]["post"]["responses"]["200"]["content"]["application/json"]
-	).vector_clock;
-
-	const changes = (data["change"] ?? []) as Change[];
-
-	await args.lix.db.transaction().execute(async (trx) => {
-		await trx.executeQuery(
-			CompiledQuery.raw("PRAGMA defer_foreign_keys = ON;")
-		);
-
-		const currentVersion = await trx
-			.selectFrom("current_version")
-			.select("id")
-			.executeTakeFirstOrThrow();
-
-		/**
-		 * The version change (pointers) need to be applied to the version_change table.
-		 *
-		 * Without the version change pointers, switching between versiond and
-		 * seeing "what changes are in this version" would not be possible.
-		 */
-		const versionChanges: Change[] = [];
-
-		/**
-		 * The version change conflict (pointers) need to be applied as well for
-		 * the same reason as applying version changes is necessary.
-		 *
-		 * Without the pointers, conflicts are not copied over.
-		 */
-		const versionChangeConflicts: Change[] = [];
-
-		/**
-		 * The changes that are part of the current version must all get applied.
-		 */
-		const changesInCurrentVersion: Change[] = [];
-
-		for (const change of changes) {
-			if (
-				change.schema_key === "lix_version_change_table" ||
-				change.schema_key === "lix_version_change_conflict_table"
-			) {
-				const [versionId] = change.entity_id.split(",") as [string, string];
-				if (change.schema_key === "lix_version_change_table") {
-					if (versionId === currentVersion.id) {
-						// the version change pointer of the current version updated.
-						// finding a matching change in the changes array
-						// and pushing it to the changesInCurrentVersion array
-						// to be applied in the next step.
-						const [, changeId] = change.entity_id.split(",");
-						// the find operation can be expensive. to be optimized later.
-						const matchingChange = changes.find((c) => c.id === changeId!);
-						if (!matchingChange) {
-							throw new Error("Expected matching change");
-						}
-						changesInCurrentVersion.push(matchingChange);
-					}
-					// in any case, push the version change to the version changes array
-					versionChanges.push(change);
-				} else if (change.schema_key === "lix_version_change_conflict_table") {
-					versionChangeConflicts.push(change);
-				} else {
-					throw new Error("Unexpected schema key");
-				}
-			}
-		}
-
-		// potential optimization by not creating a new array with immutability (spreading)
-		const changesToApply = [
-			...versionChanges,
-			...versionChangeConflicts,
-			...changesInCurrentVersion,
-		];
-
-		await mergeTheirState({
-			lix: { ...args.lix, db: trx },
-			sourceVectorClock: sessionStateServer,
-			sourceData: data,
-		});
-
-		if (changesToApply.length > 0) {
-			await applyChanges({
-				lix: { ...args.lix, db: trx },
-				changes: changesToApply,
-			});
-		}
-	});
-
-	return sessionStateServer;
-}