Merge pull request #3175 from opral/lixdk-107-plugindifffiletype-plug…

…indetectchanges refactor: plugin.diff.file|type -> plugin.detectChanges
opral · Oct 17, 2024 · 0b4eb14 · 0b4eb14
2 parents 31ec2d6 + f375f42
commit 0b4eb14
Show file tree

Hide file tree

Showing 16 changed files with 276 additions and 472 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,6 +5,7 @@
 		"esbenp.prettier-vscode",
 		"inlang.vs-code-extension",
 		"vitest.explorer",
-		"aaron-bond.better-comments"
+		"aaron-bond.better-comments",
+		"yoavbls.pretty-ts-errors"
 	]
 }
diff --git a/lix/packages/sdk/src/change-queue.test.ts b/lix/packages/sdk/src/change-queue.test.ts
@@ -1,33 +1,30 @@
 import { expect, test, vi } from "vitest";
 import { openLixInMemory } from "./open/openLixInMemory.js";
 import { newLixFile } from "./newLix.js";
-import type { DiffReport, LixPlugin } from "./plugin.js";
+import type { DetectedChange, LixPlugin } from "./plugin.js";
 
 test("should use queue and settled correctly", async () => {
 	const mockPlugin: LixPlugin = {
 		key: "mock-plugin",
 		glob: "*",
-		diff: {
-			file: async ({ before, after }) => {
-				const textBefore = before
-					? new TextDecoder().decode(before?.data)
-					: undefined;
-				const textAfter = after
-					? new TextDecoder().decode(after.data)
-					: undefined;
-
-				if (textBefore === textAfter) {
-					return [];
-				}
-				return [
-					{
-						type: "text",
-						entity_id: "test",
-						before: textBefore ? { text: textBefore } : undefined,
-						after: textAfter ? { text: textAfter } : undefined,
-					},
-				];
-			},
+		detectChanges: async ({ before, after }) => {
+			const textBefore = before
+				? new TextDecoder().decode(before?.data)
+				: undefined;
+			const textAfter = after
+				? new TextDecoder().decode(after.data)
+				: undefined;
+
+			if (textBefore === textAfter) {
+				return [];
+			}
+			return [
+				{
+					type: "text",
+					entity_id: "test",
+					snapshot: textAfter ? { text: textAfter } : undefined,
+				},
+			];
 		},
 	};
 
@@ -210,28 +207,22 @@ test("changes should contain the author", async () => {
 	const mockPlugin: LixPlugin = {
 		key: "mock-plugin",
 		glob: "*",
-		diff: {
-			file: vi.fn().mockResolvedValue([
-				{
-					type: "mock",
-					entity_id: "mock",
-					before: undefined,
-					after: {
-						text: "value1",
-					},
+		detectChanges: vi.fn().mockResolvedValue([
+			{
+				type: "mock",
+				entity_id: "mock",
+				snapshot: {
+					text: "value1",
 				},
-				{
-					type: "mock",
-					entity_id: "mock",
-					before: {
-						text: "value1",
-					},
-					after: {
-						text: "value2",
-					},
+			},
+			{
+				type: "mock",
+				entity_id: "mock",
+				snapshot: {
+					text: "value2",
 				},
-			] satisfies DiffReport[]),
-		},
+			},
+		] satisfies DetectedChange[]),
 	};
 	const lix = await openLixInMemory({
 		blob: await newLixFile(),

diff --git a/lix/packages/sdk/src/commit.test.ts b/lix/packages/sdk/src/commit.test.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
+ 
 import { expect, test } from "vitest";
 import { openLixInMemory } from "./open/openLixInMemory.js";
 import { newLixFile } from "./newLix.js";
@@ -9,27 +9,24 @@ test("should be able to add and commit changes", async () => {
 	const mockPlugin: LixPlugin = {
 		key: "mock-plugin",
 		glob: "*",
-		diff: {
-			file: async ({ before, after }) => {
-				const textBefore = before
-					? new TextDecoder().decode(before?.data)
-					: undefined;
-				const textAfter = after
-					? new TextDecoder().decode(after.data)
-					: undefined;
-
-				if (textBefore === textAfter) {
-					return [];
-				}
-				return [
-					{
-						type: "text",
-						entity_id: "test",
-						before: textBefore ? { text: textBefore } : undefined,
-						after: textAfter ? { text: textAfter } : undefined,
-					},
-				];
-			},
+		detectChanges: async ({ before, after }) => {
+			const textBefore = before
+				? new TextDecoder().decode(before?.data)
+				: undefined;
+			const textAfter = after
+				? new TextDecoder().decode(after.data)
+				: undefined;
+
+			if (textBefore === textAfter) {
+				return [];
+			}
+			return [
+				{
+					type: "text",
+					entity_id: "test",
+					snapshot: textAfter ? { text: textAfter } : undefined,
+				},
+			];
 		},
 	};
 

diff --git a/lix/packages/sdk/src/discussion/discussion.test.ts b/lix/packages/sdk/src/discussion/discussion.test.ts
@@ -6,30 +6,16 @@ import type { LixPlugin } from "../plugin.js";
 const mockPlugin: LixPlugin = {
 	key: "mock-plugin",
 	glob: "*",
-	diff: {
-		file: async ({ before }) => {
-			return [
-				!before
-					? {
-							type: "text",
-							before: undefined,
-							entity_id: "test",
-							after: {
-								text: "inserted text",
-							},
-						}
-					: {
-							type: "text",
-							entity_id: "test",
-							before: {
-								text: "inserted text",
-							},
-							after: {
-								text: "updated text",
-							},
-						},
-			];
-		},
+	detectChanges: async ({ after }) => {
+		return [
+			{
+				type: "text",
+				entity_id: "test",
+				snapshot: {
+					text: after ? new TextDecoder().decode(after.data) : undefined,
+				},
+			},
+		];
 	},
 };
 
@@ -52,9 +38,7 @@ test("should be able to start a discussion on changes", async () => {
 
 	const changes = await lix.db
 		.selectFrom("change")
-		.innerJoin("snapshot", "snapshot.id", "change.snapshot_id")
 		.selectAll("change")
-		.select("snapshot.value")
 		.execute();
 
 	const discussion = await lix.createDiscussion({