@inlang/sdk 2.0.0-prerelease.0 → 2.0.0

package/src/project/state/README.md

@@ -1,22 +0,0 @@
-Reactivity is a bitch. Hard to reason about. Hard to debug. Hard to maintain.
-
-The `/state` has been modelled under the following principles:
-
-1. The state is derived from the files in lix.
-
-   The files in lix are the source of truth. That's great for
-   reproducibility (you can send the file(s) around, the state
-   is always reproducible), crash resistance, and ensures that
-   the interplay with lix (tracking changes) works.
-
-2. Every setter writes to a lix file, not the in-memory state.
-
-   Avoids running out of sync with the project file and ensures
-   that lix is tracking changes correctly.
-
-3. Reactivity is contained in `/state` and does not leak outside.
-
-   Maintaining reactivity is a high effort. Especially if reactivity
-   is all over the codebase. We learned this the hard way
-   (like full refactor hard way). Thus, `/state` reactive side effects
-   are modeled in `/state` alone.

package/src/project/state/id$.test.ts

@@ -1,40 +0,0 @@
-import { expect, test } from "vitest";
-import { newLixFile, openLixInMemory } from "@lix-js/sdk";
-import { firstValueFrom } from "rxjs";
-import { createId$ } from "./id$.js";
-
-test("if the settings file has been updated in lix, the observable should emit the new id", async () => {
-	const lix = await openLixInMemory({ blob: await newLixFile() });
-
-	await lix.db
-		.insertInto("file")
-		.values({
-			path: "/project_id",
-			data: new TextEncoder().encode("foo-bar"),
-		})
-		.execute();
-
-	const id$ = createId$({ lix });
-
-	// todo the emitted events are always too high
-	// that could be due to polling. not important rn.
-	// let emittedEvents = 0;
-	// settings$.subscribe(() => {
-	// 	emittedEvents++;
-	// });
-
-	const id = await firstValueFrom(id$);
-
-	expect(id).toBe("foo-bar");
-
-	await lix.db
-		.updateTable("file")
-		.where("file.path", "=", "/project_id")
-		.set({
-			data: new TextEncoder().encode("foo-bar-box"),
-		})
-		.execute();
-
-	const id2 = await firstValueFrom(id$);
-	expect(id2).toBe("foo-bar-box");
-});

package/src/project/state/id$.ts

@@ -1,21 +0,0 @@
-import { type Lix } from "@lix-js/sdk";
-import { filter, map, share, type Observable } from "rxjs";
-import { pollQuery } from "../../query-utilities/pollQuery.js";
-
-export function createId$(args: { lix: Lix }): Observable<string> {
-	const settings$ = pollQuery(() =>
-		args.lix.db
-			.selectFrom("file")
-			.where("path", "=", "/project_id")
-			.selectAll()
-			.executeTakeFirst()
-	).pipe(
-		// undefined can happen if a project has no id yet
-		// the project id will be automatically generated
-		// shortly after
-		filter((file) => file !== undefined),
-		map((file) => new TextDecoder().decode(file.data)),
-		share()
-	);
-	return settings$;
-}

package/src/project/state/setSettings.test.ts

@@ -1,73 +0,0 @@
-import { expect, test } from "vitest";
-import { newLixFile, openLixInMemory } from "@lix-js/sdk";
-import { ProjectSettings } from "../../json-schema/settings.js";
-import { createProjectState } from "./state.js";
-import { setSettings } from "./setSettings.js";
-
-test("setSettings an update to baseLocale and locales should update sourceLanguageTag and languageTags", async () => {
-	const lix = await openLixInMemory({ blob: await newLixFile() });
-
-	const settings: ProjectSettings = {
-		baseLocale: "en",
-		locales: ["en", "fr"],
-	};
-
-	await lix.db
-		.insertInto("file")
-		.values({
-			path: "/settings.json",
-			data: new TextEncoder().encode(JSON.stringify(settings)),
-		})
-		.execute();
-
-	await setSettings({ newSettings: settings, lix });
-
-	const settingsFile = await lix.db
-		.selectFrom("file")
-		.select("data")
-		.where("path", "=", "/settings.json")
-		.executeTakeFirstOrThrow();
-
-	const updatedSettings = JSON.parse(
-		new TextDecoder().decode(settingsFile.data)
-	) as ProjectSettings;
-
-	expect(updatedSettings.baseLocale).toBe("en");
-	expect(updatedSettings.sourceLanguageTag).toBe("en");
-	expect(updatedSettings.locales).toEqual(["en", "fr"]);
-	expect(updatedSettings.languageTags).toEqual(["en", "fr"]);
-});
-
-test("the settings should be persisted to lix", async () => {
-	const lix = await openLixInMemory({ blob: await newLixFile() });
-
-	await lix.db
-		.insertInto("file")
-		.values({
-			path: "/settings.json",
-			data: new TextEncoder().encode("{}"),
-		})
-		.execute();
-
-	const settings: ProjectSettings = {
-		baseLocale: "en",
-		locales: ["en", "fr"],
-	};
-
-	const state = createProjectState({ settings, lix });
-
-	await state.settings.set(settings);
-
-	const settingsFile = await lix.db
-		.selectFrom("file")
-		.select("data")
-		.where("path", "=", "/settings.json")
-		.executeTakeFirstOrThrow();
-
-	const updatedSettingsInLix = JSON.parse(
-		new TextDecoder().decode(settingsFile.data)
-	) as ProjectSettings;
-
-	expect(updatedSettingsInLix.baseLocale).toEqual("en");
-	expect(updatedSettingsInLix.locales).toEqual(["en", "fr"]);
-});

package/src/project/state/setSettings.ts

@@ -1,19 +0,0 @@
-import type { Lix } from "@lix-js/sdk";
-import type { ProjectSettings } from "../../json-schema/settings.js";
-
-export async function setSettings(args: {
-	newSettings: ProjectSettings;
-	lix: Lix;
-}) {
-	const cloned = structuredClone(args.newSettings);
-	cloned.languageTags = cloned.locales;
-	cloned.sourceLanguageTag = cloned.baseLocale;
-
-	await args.lix.db
-		.updateTable("file")
-		.where("path", "=", "/settings.json")
-		.set({
-			data: new TextEncoder().encode(JSON.stringify(cloned, undefined, 2)),
-		})
-		.execute();
-}

package/src/project/state/settings$.test.ts

@@ -1,63 +0,0 @@
-import { expect, test } from "vitest";
-import { createSettings$ } from "./settings$.js";
-import { newLixFile, openLixInMemory } from "@lix-js/sdk";
-import type { ProjectSettings } from "../../json-schema/settings.js";
-import { firstValueFrom } from "rxjs";
-import { withLanguageTagToLocaleMigration } from "../../migrations/v2/withLanguageTagToLocaleMigration.js";
-
-test("if the settings file has been updated in lix, the observable should emit the new settings", async () => {
-	const lix = await openLixInMemory({ blob: await newLixFile() });
-
-	const mockSettings: ProjectSettings = {
-		baseLocale: "en",
-		locales: ["en", "de"],
-		modules: [],
-	};
-
-	await lix.db
-		.insertInto("file")
-		.values({
-			path: "/settings.json",
-			data: new TextEncoder().encode(JSON.stringify(mockSettings)),
-		})
-		.execute();
-
-	const settings$ = createSettings$({ lix });
-
-	// todo the emitted events are always too high
-	// that could be due to polling. not important rn.
-	// let emittedEvents = 0;
-	// settings$.subscribe(() => {
-	// 	emittedEvents++;
-	// });
-
-	const settings = await firstValueFrom(settings$);
-
-	expect(settings).toStrictEqual(
-		withLanguageTagToLocaleMigration(mockSettings)
-	);
-
-	settings.baseLocale = "mock-locale";
-
-	// mutating a value from the observable should not affect the observable
-	const settings2 = await firstValueFrom(settings$);
-	expect(settings2.baseLocale).toBe("en");
-
-	await lix.db
-		.updateTable("file")
-		.where("file.path", "=", "/settings.json")
-		.set({
-			data: new TextEncoder().encode(
-				JSON.stringify({
-					...settings,
-					baseLocale: "mock-locale",
-					"plugin.mock": "mock",
-				})
-			),
-		})
-		.execute();
-
-	const settings3 = await firstValueFrom(settings$);
-	expect(settings3.baseLocale).toBe("mock-locale");
-	expect(settings3["plugin.mock"]).toBe("mock");
-});

package/src/project/state/settings$.ts

@@ -1,26 +0,0 @@
-import { type Lix } from "@lix-js/sdk";
-import { map, share, type Observable } from "rxjs";
-import type { ProjectSettings } from "../../json-schema/settings.js";
-import { withLanguageTagToLocaleMigration } from "../../migrations/v2/withLanguageTagToLocaleMigration.js";
-import { pollQuery } from "../../query-utilities/pollQuery.js";
-
-export function createSettings$(args: {
-	lix: Lix;
-}): Observable<ProjectSettings> {
-	const settings$ = pollQuery(() =>
-		args.lix.db
-			.selectFrom("file")
-			.where("path", "=", "/settings.json")
-			.selectAll()
-			.executeTakeFirstOrThrow()
-	).pipe(
-		map((settingsFile) => {
-			const decoded = new TextDecoder().decode(settingsFile.data);
-			const parsed = JSON.parse(decoded);
-			const withMigration = withLanguageTagToLocaleMigration(parsed);
-			return withMigration;
-		}),
-		share()
-	);
-	return settings$;
-}

package/src/project/state/state.test.ts

@@ -1,128 +0,0 @@
-import { test, expect, vi } from "vitest";
-import { createProjectState } from "./state.js";
-import { newLixFile, openLixInMemory } from "@lix-js/sdk";
-import type { ProjectSettings } from "../../json-schema/settings.js";
-import { loadProjectInMemory } from "../loadProjectInMemory.js";
-import { newProject } from "../newProject.js";
-import type { InlangPlugin } from "../../plugin/schema.js";
-
-test("plugins should be re-imported if the settings have been updated", async () => {
-	const mockImportPlugins = vi.hoisted(() =>
-		vi.fn().mockImplementation(async (args) => {
-			const plugins = args.settings.modules.map((uri: any) => {
-				return { key: uri };
-			});
-			return { plugins, errors: [] };
-		})
-	);
-
-	vi.mock(import("../../plugin/importPlugins.js"), async (importOriginal) => {
-		const mod = await importOriginal();
-		return {
-			...mod,
-			importPlugins: mockImportPlugins,
-		};
-	});
-
-	const lix = await openLixInMemory({ blob: await newLixFile() });
-
-	await lix.db
-		.insertInto("file")
-		.values({
-			path: "/settings.json",
-			data: new TextEncoder().encode(
-				JSON.stringify({
-					baseLocale: "en",
-					locales: ["en"],
-					modules: [],
-				} satisfies ProjectSettings)
-			),
-		})
-		.execute();
-
-	const state = createProjectState({
-		lix,
-		settings: {
-			baseLocale: "en",
-			locales: ["en"],
-			modules: [],
-		},
-	});
-
-	const plugins1 = await state.plugins.get();
-
-	expect(plugins1).toEqual([]);
-	// expect(mockImportPlugins).toHaveBeenCalledTimes(1);
-
-	const settings1 = {
-		baseLocale: "en",
-		locales: ["en"],
-		modules: ["@inlang/plugin-react"],
-	};
-
-	await state.settings.set(settings1);
-
-	const plugins2 = await state.plugins.get();
-	expect(plugins2).toEqual([{ key: "@inlang/plugin-react" }]);
-
-	await state.settings.set({
-		baseLocale: "en",
-		locales: ["en"],
-		modules: ["@inlang/plugin-react"],
-	});
-
-	const plugins3 = await state.plugins.get();
-	expect(plugins3).toEqual([{ key: "@inlang/plugin-react" }]);
-	// expect(mockImportPlugins).toHaveBeenCalledTimes(2);
-
-	state.settings.set({
-		baseLocale: "en",
-		locales: ["en"],
-		modules: [],
-	});
-
-	const plugins4 = await state.plugins.get();
-
-	expect(plugins4).toEqual([]);
-	// expect(mockImportPlugins).toHaveBeenCalledTimes(3);
-});
-
-test("subscribing to plugins should work", async () => {
-	// vite hoists the import plugin from the previous test :/
-	const project = await loadProjectInMemory({ blob: await newProject() });
-
-	const state = createProjectState({
-		lix: project.lix,
-		settings: {
-			baseLocale: "en",
-			locales: ["en"],
-			modules: [],
-		},
-	});
-
-	expect(await state.plugins.get()).toEqual([]);
-
-	let pluginsFromSub: readonly InlangPlugin[] = [];
-	const sub = state.plugins.subscribe((value) => {
-		pluginsFromSub = value;
-	});
-
-	await project.lix.db
-		.updateTable("file")
-		.where("path", "=", "/settings.json")
-		.set({
-			data: new TextEncoder().encode(
-				JSON.stringify({
-					baseLocale: "en",
-					locales: ["en"],
-					modules: ["broken-module.js"],
-				})
-			),
-		})
-		.execute();
-
-	const plugins = await state.plugins.get();
-	expect(plugins.length).toBe(1);
-	expect(pluginsFromSub).toStrictEqual(plugins);
-	sub.unsubscribe();
-});

package/src/project/state/state.ts

@@ -1,94 +0,0 @@
-import { firstValueFrom, map, merge, share, switchMap } from "rxjs";
-import type { InlangPlugin } from "../../plugin/schema.js";
-import type { ProjectSettings } from "../../json-schema/settings.js";
-import {
-	importPlugins,
-	type PreprocessPluginBeforeImportFunction,
-} from "../../plugin/importPlugins.js";
-import { setSettings } from "./setSettings.js";
-import type { Lix } from "@lix-js/sdk";
-import { createSettings$ } from "./settings$.js";
-import { createId$ } from "./id$.js";
-
-/**
- * State of a project.
- */
-export type ProjectState = Awaited<ReturnType<typeof createProjectState>>;
-
-/**
- * The state of a project derived from the settings file in lix.
- *
- * Everything that's not in the database is stored here. Settings,
- * loaded plugins etc. The principal is "everything is derived
- * from the settings file in lix":
- *
- *   - the source of truth is the file.
- *      - crash resistance: if the state is lost, it can be re-imported.
- *      - portable: copy the file, open on another machine = same state.
- *
- *   - simple(r) unit testing (provide the settings file observable, done)
- */
-export function createProjectState(args: {
-	lix: Lix;
-	providePlugins?: InlangPlugin[];
-	preprocessPluginBeforeImport?: PreprocessPluginBeforeImportFunction;
-	settings: ProjectSettings;
-}) {
-	const settings$ = createSettings$(args);
-
-	const _importPluginsResult$ = settings$.pipe(
-		// distinctUntilChanges is bypassed for whatever reason
-		// not important for now if the plugins re-import even if the modules are identical.
-		// distinctUntilChanged((prev, curr) => {
-		// 	console.log("distinct called");
-		// 	return true;
-		// }),
-		switchMap((settings) =>
-			// re-import the plugins when the settings change
-			importPlugins({
-				settings,
-				lix: args.lix,
-				preprocessPluginBeforeImport: args.preprocessPluginBeforeImport,
-			})
-		),
-		share()
-	);
-
-	const plugins$ = _importPluginsResult$.pipe(
-		map((result) => [...(args.providePlugins ?? []), ...result.plugins]),
-		share()
-	);
-
-	const errors$ = merge(
-		_importPluginsResult$.pipe(map((result) => result.errors))
-	).pipe(share());
-
-	const id$ = createId$({ lix: args.lix });
-
-	return {
-		id: {
-			get: () => firstValueFrom(id$),
-			// bind to keep the context of this
-			subscribe: id$.subscribe.bind(id$),
-		},
-		settings: {
-			get: () => firstValueFrom(settings$),
-			set: (settings: ProjectSettings) =>
-				setSettings({
-					newSettings: settings,
-					lix: args.lix,
-				}),
-			subscribe: settings$.subscribe,
-		},
-		errors: {
-			get: () => firstValueFrom(errors$),
-			// bind to keep the context of this
-			subscribe: errors$.subscribe.bind(errors$),
-		},
-		plugins: {
-			get: () => firstValueFrom(plugins$),
-			// bind to keep the context of this
-			subscribe: plugins$.subscribe.bind(plugins$),
-		},
-	};
-}

package/src/query-utilities/pollQuery.test.ts

@@ -1,88 +0,0 @@
-import { test, expect } from "vitest";
-import { createDialect, createInMemoryDatabase } from "sqlite-wasm-kysely";
-import { Kysely } from "kysely";
-import { pollQuery } from "./pollQuery.js";
-import { firstValueFrom } from "rxjs";
-
-test("it should immediately execute the query irrespective of the interval", async () => {
-	const observable = pollQuery(() => Promise.resolve("hello"), {
-		interval: 100000,
-	});
-
-	const timeBefore = Date.now();
-	const value = await firstValueFrom(observable);
-	const timeAfter = Date.now();
-
-	expect(value).toBe("hello");
-	expect(timeAfter - timeBefore).toBeLessThan(100);
-});
-
-test("polling should work", async () => {
-	const database = await createInMemoryDatabase({});
-
-	const db = new Kysely<{
-		mock: {
-			id: string;
-			path: string;
-		};
-	}>({
-		dialect: createDialect({
-			database,
-		}),
-	});
-
-	await db.schema
-		.createTable("mock")
-		.addColumn("id", "text")
-		.addColumn("path", "text")
-		.execute();
-
-	const emittedValues: any[] = [];
-
-	const interval = 10;
-
-	const observable = pollQuery(
-		() => db.selectFrom("mock").where("id", "=", "joker").selectAll().execute(),
-		{ interval }
-	);
-
-	observable.subscribe((value) => emittedValues.push(value));
-
-	expect(emittedValues).lengthOf(0);
-
-	// first Value from should work
-	await db.insertInto("mock").values({ id: "joker", path: "batman" }).execute();
-	await firstValueFrom(observable);
-	expect(emittedValues).lengthOf(1);
-	expect(emittedValues.at(-1)).toEqual([{ id: "joker", path: "batman" }]);
-
-	// unrelated query
-	await db.insertInto("mock").values({ id: "color", path: "robin" }).execute();
-	await new Promise((resolve) => setTimeout(resolve, interval * 2));
-	await db
-		.updateTable("mock")
-		.where("id", "=", "color")
-		.set({ path: "barney" })
-		.execute();
-
-	// the observable should return the last value if a new subscripton is created.
-	// the subscription is simulated with `firstValueFrom`
-	const valueInObservable = await firstValueFrom(observable);
-	expect(emittedValues).lengthOf(1);
-	expect(emittedValues.at(-1)).toEqual([{ id: "joker", path: "batman" }]);
-	expect(valueInObservable).toEqual([{ id: "joker", path: "batman" }]);
-
-	// mutating the query of interest, this should trigger the observable
-	await db
-		.updateTable("mock")
-		.where("id", "=", "joker")
-		.set({ path: "superman" })
-		.execute();
-
-	await new Promise((resolve) => setTimeout(resolve, interval * 2));
-	const valueInObservable2 = await firstValueFrom(observable);
-
-	expect(emittedValues).lengthOf(2);
-	expect(emittedValues.at(-1)).toEqual([{ id: "joker", path: "superman" }]);
-	expect(valueInObservable2).toEqual([{ id: "joker", path: "superman" }]);
-});

package/src/query-utilities/pollQuery.ts

@@ -1,26 +0,0 @@
-import { distinctUntilChanged, from, switchMap, timer } from "rxjs";
-
-/**
- * Polls a query at a given interval and only emits an
- * event if the result of the query has changed.
- *
- * @example
- *   pollQuery(
- * 	   () => db.selectFrom("mock").where("id", "=", "joker").selectAll().execute(),
- *     { interval: 100 }
- *   ).subscribe((value) => console.log(value));
- */
-export function pollQuery<T>(
-	query: () => Promise<T>,
-	options?: { interval?: number }
-) {
-	return timer(0, options?.interval ?? 1000).pipe(
-		switchMap(() => from(query())),
-		distinctUntilChanged(
-			// using simplified comparison because a deep equal
-			// is not worth the cost (compute, dependency, maintenance)
-			// if a false positives slip through it's not a big deal
-			(prev, curr) => JSON.stringify(prev) === JSON.stringify(curr)
-		)
-	);
-}