@lix-js/sdk 0.0.1 → 0.2.0

package/src/query-filter/version-change-in-difference.test.ts

@@ -4,6 +4,7 @@ import type { VersionChange } from "../database/schema.js";
 import { mockChange } from "../change/mock-change.js";
 import { createVersion } from "../version/create-version.js";
 import { versionChangeInDifference } from "./version-change-in-difference.js";
+import { updateChangesInVersion } from "../version/update-changes-in-version.js";
 
 test("should return the difference between two versions", async () => {
 	const lix = await openLixInMemory({});
@@ -11,42 +12,42 @@ test("should return the difference between two versions", async () => {
 	const versionA = await createVersion({ lix });
 	const versionB = await createVersion({ lix });
 
+	const mockChanges = [
+		mockChange({ id: "change0", entity_id: "entity0" }),
+		mockChange({ id: "change1", entity_id: "entity1" }),
+		mockChange({ id: "change2", entity_id: "entity2" }),
+		mockChange({ id: "change3", entity_id: "entity3" }),
+	] as const;
+
 	await lix.db
 		.insertInto("change")
-		.values([
-			mockChange({ id: "change1" }),
-			mockChange({ id: "change2" }),
-			mockChange({ id: "change3" }),
-			mockChange({ id: "change4" }),
-		])
+		.values(mockChanges)
 		.returningAll()
 		.execute();
 
-	const changesA: VersionChange[] = [
-		{ version_id: versionA.id, change_id: "change1" },
-		{ version_id: versionA.id, change_id: "change2" },
-	];
-
-	const changesB: VersionChange[] = [
-		{ version_id: versionB.id, change_id: "change2" },
-		{ version_id: versionB.id, change_id: "change3" },
-	];
+	await updateChangesInVersion({
+		lix,
+		version: versionA,
+		changes: [mockChanges[0], mockChanges[1]],
+	});
 
-	await lix.db
-		.insertInto("version_change")
-		.values([...changesA, ...changesB])
-		.execute();
+	await updateChangesInVersion({
+		lix,
+		version: versionB,
+		changes: [mockChanges[1], mockChanges[2]],
+	});
 
 	const result = await lix.db
 		.selectFrom("version_change")
 		.where(versionChangeInDifference(versionA, versionB))
-		.selectAll()
+		.select("version_id")
+		.select("change_id")
 		.execute();
 
 	expect(result).toEqual([
-		// change1 is in A but not in B
-		{ version_id: versionA.id, change_id: "change1" },
-	] satisfies VersionChange[]);
+		// change0 is in A but not in B
+		expect.objectContaining({ version_id: versionA.id, change_id: "change0" }),
+	] satisfies Partial<VersionChange>[]);
 });
 
 test("should return an empty array if there are no differences", async () => {
@@ -55,20 +56,28 @@ test("should return an empty array if there are no differences", async () => {
 	const versionA = await createVersion({ lix });
 	const versionB = await createVersion({ lix });
 
+	const mockChanges = [
+		mockChange({ id: "change0" }),
+		mockChange({ id: "change1" }),
+	];
+
 	await lix.db
 		.insertInto("change")
-		.values([mockChange({ id: "change1" }), mockChange({ id: "change2" })])
+		.values(mockChanges)
 		.returningAll()
 		.execute();
 
-	const changes: VersionChange[] = [
-		{ version_id: versionA.id, change_id: "change1" },
-		{ version_id: versionA.id, change_id: "change2" },
-		{ version_id: versionB.id, change_id: "change1" },
-		{ version_id: versionB.id, change_id: "change2" },
-	];
-
-	await lix.db.insertInto("version_change").values(changes).execute();
+	await updateChangesInVersion({
+		lix,
+		version: versionA,
+		changes: mockChanges,
+	});
+
+	await updateChangesInVersion({
+		lix,
+		version: versionB,
+		changes: mockChanges,
+	});
 
 	const result = await lix.db
 		.selectFrom("version_change")

package/src/query-filter/version-change-in-symmetric-difference.test.ts

@@ -4,6 +4,7 @@ import type { VersionChange } from "../database/schema.js";
 import { mockChange } from "../change/mock-change.js";
 import { createVersion } from "../version/create-version.js";
 import { versionChangeInSymmetricDifference } from "./version-change-in-symmetric-difference.js";
+import { updateChangesInVersion } from "../version/update-changes-in-version.js";
 
 test("should return the symmetric difference between two versions", async () => {
 	const lix = await openLixInMemory({});
@@ -11,31 +12,26 @@ test("should return the symmetric difference between two versions", async () =>
 	const versionA = await createVersion({ lix });
 	const versionB = await createVersion({ lix });
 
-	await lix.db
-		.insertInto("change")
-		.values([
-			mockChange({ id: "change1" }),
-			mockChange({ id: "change2" }),
-			mockChange({ id: "change3" }),
-			mockChange({ id: "change4" }),
-		])
-		.returningAll()
-		.execute();
+	const mockChanges = [
+		mockChange({ id: "change0", entity_id: "entity0" }),
+		mockChange({ id: "change1", entity_id: "entity1" }),
+		mockChange({ id: "change2", entity_id: "entity2" }),
+		mockChange({ id: "change3", entity_id: "entity3" }),
+	] as const;
 
-	const changesA: VersionChange[] = [
-		{ version_id: versionA.id, change_id: "change1" },
-		{ version_id: versionA.id, change_id: "change2" },
-	];
+	await lix.db.insertInto("change").values(mockChanges).execute();
 
-	const changesB: VersionChange[] = [
-		{ version_id: versionB.id, change_id: "change2" },
-		{ version_id: versionB.id, change_id: "change3" },
-	];
+	await updateChangesInVersion({
+		lix,
+		version: versionA,
+		changes: [mockChanges[0], mockChanges[1]],
+	});
 
-	await lix.db
-		.insertInto("version_change")
-		.values([...changesA, ...changesB])
-		.execute();
+	await updateChangesInVersion({
+		lix,
+		version: versionB,
+		changes: [mockChanges[1], mockChanges[2]],
+	});
 
 	const result = await lix.db
 		.selectFrom("version_change")
@@ -44,13 +40,13 @@ test("should return the symmetric difference between two versions", async () =>
 		.execute();
 
 	expect(result).toEqual([
-		// change 1 is in A but not in B
-		{ version_id: versionA.id, change_id: "change1" },
-		// change 3 is in B but not in A
-		{ version_id: versionB.id, change_id: "change3" },
-		// change 4 is in neither A nor B
+		// change 0 is in A but not in B
+		expect.objectContaining({ version_id: versionA.id, change_id: "change0" }),
+		// change 2 is in B but not in A
+		expect.objectContaining({ version_id: versionB.id, change_id: "change2" }),
+		// change 3 is in neither A nor B
 		// hence not in the symmetric difference
-	] satisfies VersionChange[]);
+	] satisfies Partial<VersionChange>[]);
 });
 
 test("should return an empty array if there are no differences", async () => {
@@ -59,25 +55,28 @@ test("should return an empty array if there are no differences", async () => {
 	const versionA = await createVersion({ lix });
 	const versionB = await createVersion({ lix });
 
+	const mockChanges = [
+		mockChange({ id: "change0", entity_id: "entity0" }),
+		mockChange({ id: "change1", entity_id: "entity1" }),
+	] as const;
+
 	await lix.db
 		.insertInto("change")
-		.values([
-			mockChange({ id: "change1" }),
-			mockChange({ id: "change2" }),
-			mockChange({ id: "change3" }),
-			mockChange({ id: "change4" }),
-		])
+		.values(mockChanges)
 		.returningAll()
 		.execute();
 
-	const changes: VersionChange[] = [
-		{ version_id: versionA.id, change_id: "change1" },
-		{ version_id: versionA.id, change_id: "change2" },
-		{ version_id: versionB.id, change_id: "change1" },
-		{ version_id: versionB.id, change_id: "change2" },
-	];
-
-	await lix.db.insertInto("version_change").values(changes).execute();
+	await updateChangesInVersion({
+		lix,
+		version: versionA,
+		changes: [mockChanges[0], mockChanges[1]],
+	});
+
+	await updateChangesInVersion({
+		lix,
+		version: versionB,
+		changes: [mockChanges[0], mockChanges[1]],
+	});
 
 	const result = await lix.db
 		.selectFrom("version_change")

package/src/server-api-handler/environment/create-in-memory-environment.test.ts

@@ -1,6 +1,7 @@
 import { test, expect } from "vitest";
 import { createLsaInMemoryEnvironment } from "./create-in-memory-environment.js";
 import { openLixInMemory } from "../../lix/open-lix-in-memory.js";
+import { toBlob } from "../../lix/to-blob.js";
 
 test("opening a lix works", async () => {
 	const environment = createLsaInMemoryEnvironment();
@@ -14,7 +15,7 @@ test("opening a lix works", async () => {
 		.executeTakeFirstOrThrow();
 
 	// initialize the env with the lix file
-	environment.setLix({ id: lixId, blob: await mockLix.toBlob() });
+	environment.setLix({ id: lixId, blob: await toBlob({ lix: mockLix }) });
 
 	const open0 = await environment.openLix({ id: lixId });
 
@@ -24,7 +25,7 @@ test("opening a lix works", async () => {
 		.returningAll()
 		.executeTakeFirstOrThrow();
 
-	expect(mockInsert).toEqual({
+	expect(mockInsert).toMatchObject({
 		key: "foo",
 		value: "bar",
 	});
@@ -44,7 +45,7 @@ test("opening a lix works", async () => {
 		.selectAll()
 		.executeTakeFirstOrThrow();
 
-	expect(mockSelect).toEqual({ key: "foo", value: "bar" });
+	expect(mockSelect).toMatchObject({ key: "foo", value: "bar" });
 
 	await environment.closeLix({ id: lixId, connectionId: open1.connectionId });
 });
@@ -61,7 +62,7 @@ test("it handles concurrent connections", async () => {
 		.executeTakeFirstOrThrow();
 
 	// initialize the env with the lix file
-	environment.setLix({ id: lixId, blob: await mockLix.toBlob() });
+	environment.setLix({ id: lixId, blob: await toBlob({ lix: mockLix }) });
 
 	const open0 = await environment.openLix({ id: lixId });
 	const open1 = await environment.openLix({ id: lixId });
@@ -72,7 +73,7 @@ test("it handles concurrent connections", async () => {
 		.returningAll()
 		.executeTakeFirstOrThrow();
 
-	expect(mockInsert).toEqual({
+	expect(mockInsert).toMatchObject({
 		key: "foo",
 		value: "bar",
 	});
@@ -83,7 +84,7 @@ test("it handles concurrent connections", async () => {
 		.selectAll()
 		.executeTakeFirstOrThrow();
 
-	expect(mockSelect).toEqual({ key: "foo", value: "bar" });
+	expect(mockSelect).toMatchObject({ key: "foo", value: "bar" });
 
 	// test both writing at the same time
 
@@ -124,7 +125,7 @@ test("it handles concurrent connections", async () => {
 		.selectAll()
 		.executeTakeFirstOrThrow();
 
-	expect(mockSelect2).toEqual({ key: "foo", value: "bar3" });
+	expect(mockSelect2).toMatchObject({ key: "foo", value: "bar3" });
 
 	await environment.closeLix({ id: lixId, connectionId: open2.connectionId });
 });

package/src/server-api-handler/environment/create-in-memory-environment.ts

@@ -1,5 +1,8 @@
+import { fileQueueSettled } from "../../file-queue/file-queue-settled.js";
+import { closeLix } from "../../lix/close-lix.js";
 import { openLixInMemory } from "../../lix/open-lix-in-memory.js";
 import type { Lix } from "../../lix/open-lix.js";
+import { toBlob } from "../../lix/to-blob.js";
 import type { LsaEnvironment } from "./environment.js";
 
 /**
@@ -72,7 +75,7 @@ export const createLsaInMemoryEnvironment = (): LsaEnvironment => {
 				lix = await openLixInMemory({
 					blob,
 					// don't sync the server with itself
-					keyValues: [{ key: "#lix_sync", value: "false" }],
+					keyValues: [{ key: "lix_sync", value: "false" }],
 				});
 
 				lix.sqlite.exec("PRAGMA foreign_keys = OFF;");
@@ -100,8 +103,9 @@ export const createLsaInMemoryEnvironment = (): LsaEnvironment => {
 			if (connections.size === 0) {
 				// TODO no concurrency guarantees
 				const lix = openLixes.get(args.id);
-				const blob = await lix!.toBlob();
-				await lix?.close();
+				await fileQueueSettled({ lix: lix! });
+				const blob = await toBlob({ lix: lix! });
+				await closeLix({ lix: lix! });
 				openConnections.delete(args.id);
 				openLixes.delete(args.id);
 				store.set(args.id, blob);

package/src/server-api-handler/routes/get-v1.test.ts

@@ -3,6 +3,7 @@ import { createServerApiHandler } from "../create-server-api-handler.js";
 import { newLixFile } from "../../lix/new-lix.js";
 import { openLixInMemory } from "../../lix/open-lix-in-memory.js";
 import { createLsaInMemoryEnvironment } from "../environment/create-in-memory-environment.js";
+import { toBlob } from "../../lix/to-blob.js";
 
 test("it should fetch the lix file from the server", async () => {
 	const lix = await openLixInMemory({
@@ -26,7 +27,7 @@ test("it should fetch the lix file from the server", async () => {
 	await lsaHandler(
 		new Request("http://localhost:3000/lsa/new-v1", {
 			method: "POST",
-			body: await lix.toBlob(),
+			body: await toBlob({ lix }),
 		})
 	);
 
@@ -103,20 +104,20 @@ test("it should return 400 for a request without lix_id", async () => {
 	expect(responseJson.error).toBe("Missing required field 'lix_id'");
 });
 
-test("#lix_sync is set to true", async () => {
+test("lix_sync is set to true", async () => {
 	const environment = createLsaInMemoryEnvironment();
 	const lsaHandler = await createServerApiHandler({ environment });
 
 	const lix = await openLixInMemory({
 		blob: await newLixFile(),
-		keyValues: [{ key: "#lix_sync", value: "false" }],
+		keyValues: [{ key: "lix_sync", value: "false" }],
 	});
 
 	// Store the lix file
 	const response0 = await lsaHandler(
 		new Request("http://localhost:3000/lsa/new-v1", {
 			method: "POST",
-			body: await lix.toBlob(),
+			body: await toBlob({ lix }),
 		})
 	);
 
@@ -138,7 +139,7 @@ test("#lix_sync is set to true", async () => {
 
 	const lixSync = await lixFromServer.db
 		.selectFrom("key_value")
-		.where("key", "=", "#lix_sync")
+		.where("key", "=", "lix_sync")
 		.selectAll()
 		.executeTakeFirstOrThrow();
 

package/src/server-api-handler/routes/get-v1.ts

@@ -47,12 +47,10 @@ export const route: LixServerApiHandlerRoute = async (context) => {
 		content: new Uint8Array(await blob!.arrayBuffer()),
 	});
 
-	sqlite.exec("UPDATE key_value SET value = 'true' WHERE key = '#lix_sync'");
+	sqlite.exec("UPDATE key_value SET value = 'true' WHERE key = 'lix_sync'");
 
 	const blob2 = new Blob([contentFromDatabase(sqlite)]);
 
-	sqlite.close();
-
 	return new Response(blob2, {
 		status: 200,
 		headers: {

package/src/server-api-handler/routes/new-v1.test.ts

@@ -3,6 +3,7 @@ import { createServerApiHandler } from "../create-server-api-handler.js";
 import { newLixFile } from "../../lix/new-lix.js";
 import { openLixInMemory } from "../../lix/open-lix-in-memory.js";
 import { createLsaInMemoryEnvironment } from "../environment/create-in-memory-environment.js";
+import { toBlob } from "../../lix/to-blob.js";
 
 test("it should store the lix file", async () => {
 	const initLix = await openLixInMemory({
@@ -22,7 +23,7 @@ test("it should store the lix file", async () => {
 	const response = await lsaHandler(
 		new Request("http://localhost:3000/lsa/new-v1", {
 			method: "POST",
-			body: await initLix.toBlob(),
+			body: await toBlob({ lix: initLix }),
 		})
 	);
 	const json = await response.json();

package/src/server-api-handler/routes/new-v1.ts

@@ -11,7 +11,9 @@ export const route: LixServerApiHandlerRoute = async (context) => {
 		lix = await openLixInMemory({
 			blob,
 			// turn off sync for server
-			keyValues: [{ key: "#lix_sync", value: "false" }],
+			keyValues: [
+				{ key: "lix_sync", value: "false", skip_change_control: true },
+			],
 		});
 	} catch {
 		return new Response(null, {

package/src/server-api-handler/routes/pull-v1.test.ts

@@ -5,6 +5,7 @@ import { createServerApiHandler } from "../create-server-api-handler.js";
 import { mockJsonSnapshot } from "../../snapshot/mock-json-snapshot.js";
 import { mockChange } from "../../change/mock-change.js";
 import { createLsaInMemoryEnvironment } from "../environment/create-in-memory-environment.js";
+import { toBlob } from "../../lix/to-blob.js";
 
 type RequestBody =
 	LixServerApi.paths["/lsa/pull-v1"]["post"]["requestBody"]["content"]["application/json"];
@@ -27,7 +28,7 @@ test("it should pull rows successfully", async () => {
 
 	const environment = createLsaInMemoryEnvironment();
 
-	await environment.setLix({ id: id.value, blob: await lix.toBlob() });
+	await environment.setLix({ id: id.value, blob: await toBlob({ lix }) });
 
 	const lsaHandler = await createServerApiHandler({ environment });
 
@@ -79,7 +80,7 @@ test("it should specifically be able to handle snapshots which use json binary a
 		.execute();
 
 	const environment = createLsaInMemoryEnvironment();
-	await environment.setLix({ id, blob: await lix.toBlob() });
+	await environment.setLix({ id, blob: await toBlob({ lix }) });
 
 	const lsa = await createServerApiHandler({ environment });
 
@@ -172,7 +173,7 @@ test("it should handle empty tables gracefully", async () => {
 		.executeTakeFirstOrThrow();
 
 	const environment = createLsaInMemoryEnvironment();
-	await environment.setLix({ id, blob: await lix.toBlob() });
+	await environment.setLix({ id, blob: await toBlob({ lix }) });
 
 	const lsa = await createServerApiHandler({ environment });
 

package/src/server-api-handler/routes/push-v1.test.ts

@@ -9,6 +9,7 @@ import { createVersion } from "../../version/create-version.js";
 import { switchVersion } from "../../version/switch-version.js";
 import { pullFromServer } from "../../sync/pull-from-server.js";
 import { createLsaInMemoryEnvironment } from "../environment/create-in-memory-environment.js";
+import { toBlob } from "../../lix/to-blob.js";
 
 test("it should push data successfully", async () => {
 	const lix = await openLixInMemory({});
@@ -19,7 +20,7 @@ test("it should push data successfully", async () => {
 		.executeTakeFirstOrThrow();
 
 	const environment = createLsaInMemoryEnvironment();
-	await environment.setLix({ id, blob: await lix.toBlob() });
+	await environment.setLix({ id, blob: await toBlob({ lix }) });
 
 	const lsaHandler = await createServerApiHandler({ environment });
 
@@ -130,7 +131,7 @@ test("it should return 400 for a failed insert operation", async () => {
 
 	const environment = createLsaInMemoryEnvironment();
 
-	environment.setLix({ id, blob: await lix.toBlob() });
+	environment.setLix({ id, blob: await toBlob({ lix }) });
 
 	const lsa = await createServerApiHandler({ environment });
 
@@ -169,7 +170,7 @@ test.skip("it should detect conflicts", async () => {
 
 	// initialize client
 	const lixOnClient = await openLixInMemory({
-		blob: await lixOnServer.toBlob(),
+		blob: await toBlob({ lix: lixOnServer }),
 	});
 
 	const lixId = await lixOnServer.db
@@ -192,7 +193,7 @@ test.skip("it should detect conflicts", async () => {
 
 	await environment.setLix({
 		id: lixId.value,
-		blob: await lixOnServer.toBlob(),
+		blob: await toBlob({ lix: lixOnServer }),
 	});
 
 	// client has/creates value1 for mock_key

package/src/services/env-variables/create-index-file.js

@@ -0,0 +1,35 @@
+/* eslint-disable no-undef */
+/**
+ * This script writes public environment variables
+ * to an importable env file.
+ *
+ * - The SDK must bundle this file with the rest of the SDK
+ * - This scripts avoids the need for a bundler
+ * - Must be ran before building the SDK
+ */
+
+import fs from "node:fs/promises";
+import url from "node:url";
+import path from "node:path";
+
+const dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+const packageJson = JSON.parse(
+	await fs.readFile(path.resolve(dirname, "../../../package.json"), "utf-8")
+);
+
+await fs.writeFile(
+	dirname + "/index.ts",
+	`
+export const ENV_VARIABLES = {
+  LIX_SDK_POSTHOG_TOKEN: ${ifDefined(process.env.LIX_SDK_POSTHOG_TOKEN)},
+	LIX_SDK_VERSION: ${ifDefined(packageJson.version)},
+}
+`
+);
+
+// console.log("✅ Created env variable index file.");
+
+function ifDefined(value) {
+	return value ? `"${value}"` : undefined;
+}

package/src/services/env-variables/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Avoiding TypeScript errors before the `createIndexFile` script
+ * is invoked by defining the type ahead of time.
+ */
+
+/**
+ * Env variables that are available at runtime.
+ */
+export declare const ENV_VARIABLES: {
+	LIX_SDK_POSTHOG_TOKEN?: string;
+	/**
+	 * As defined in the package.json
+	 */
+	LIX_SDK_VERSION?: string;
+};

package/src/services/telemetry/capture.test.ts

@@ -0,0 +1,44 @@
+import { expect, test, vi } from "vitest";
+import { capture } from "./capture.js";
+
+test("it should not capture if telemetry is off", async () => {
+	global.fetch = vi.fn(() => Promise.resolve(new Response()));
+
+	vi.mock("../env-variables/index.js", async () => {
+		return {
+			ENV_VARIABLES: {
+				LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+			},
+		};
+	});
+
+	await capture("LIX-SDK lix opened", {
+		lixId: "test",
+		accountId: "test",
+		telemetryKeyValue: "off",
+		properties: {},
+	});
+
+	expect(global.fetch).not.toHaveBeenCalled();
+});
+
+test("it should not capture if telemetry is NOT off", async () => {
+	global.fetch = vi.fn(() => Promise.resolve(new Response()));
+
+	vi.mock("../env-variables/index.js", async () => {
+		return {
+			ENV_VARIABLES: {
+				LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+			},
+		};
+	});
+
+	await capture("LIX-SDK lix opened", {
+		lixId: "test",
+		accountId: "test",
+		telemetryKeyValue: "on",
+		properties: {},
+	});
+
+	expect(global.fetch).toHaveBeenCalled();
+});