@inlang/sdk 0.33.0 → 0.34.1

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { listProjects } from "./listProjects.js";
 export { solidAdapter, type InlangProjectWithSolidAdapter } from "./adapter/solidAdapter.js";
 export { createMessagesQuery } from "./createMessagesQuery.js";
 export { ProjectSettingsFileJSONSyntaxError, ProjectSettingsFileNotFoundError, ProjectSettingsInvalidError, PluginLoadMessagesError, PluginSaveMessagesError, } from "./errors.js";
+export { normalizeMessage } from "./storage/helper.js";
 export * from "./messages/variant.js";
 export * from "./versionedInterfaces.js";
 export { InlangModule } from "@inlang/module";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACX,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,YAAY,GACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,KAAK,6BAA6B,EAAE,MAAM,2BAA2B,CAAA;AAC5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EACN,kCAAkC,EAClC,gCAAgC,EAChC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,GACvB,MAAM,aAAa,CAAA;AAEpB,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACX,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,eAAe,EACf,YAAY,GACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,KAAK,6BAA6B,EAAE,MAAM,2BAA2B,CAAA;AAC5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EACN,kCAAkC,EAClC,gCAAgC,EAChC,2BAA2B,EAC3B,uBAAuB,EACvB,uBAAuB,GACvB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/index.js

@@ -11,6 +11,7 @@ export { listProjects } from "./listProjects.js";
 export { solidAdapter } from "./adapter/solidAdapter.js";
 export { createMessagesQuery } from "./createMessagesQuery.js";
 export { ProjectSettingsFileJSONSyntaxError, ProjectSettingsFileNotFoundError, ProjectSettingsInvalidError, PluginLoadMessagesError, PluginSaveMessagesError, } from "./errors.js";
+export { normalizeMessage } from "./storage/helper.js";
 export * from "./messages/variant.js";
 export * from "./versionedInterfaces.js";
 export { InlangModule } from "@inlang/module";

package/dist/loadProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAwBhF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAgChD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,GAAG,OAAO,CAAC,aAAa,CAAC,CA2XzB;AAsHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}
+{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAwBhF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAiChD;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,GAAG,OAAO,CAAC,aAAa,CAAC,CA2XzB;AAsHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}

package/dist/loadProject.js

@@ -18,7 +18,8 @@ import { maybeCreateFirstProjectId } from "./migrations/maybeCreateFirstProjectI
 import { capture } from "./telemetry/capture.js";
 import { identifyProject } from "./telemetry/groupIdentify.js";
 import _debug from "debug";
-const debug = _debug("loadProject");
+const debug = _debug("sdk:loadProject");
+const debugLock = _debug("sdk:lockfile");
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings);
 /**
  * @param projectPath - Absolute path to the inlang settings file.
@@ -449,7 +450,7 @@ async function loadMessagesViaPlugin(fs, lockDirPath, messageState, messagesQuer
                 const importedEnecoded = stringifyMessage(loadedMessageClone);
                 // NOTE could use hash instead of the whole object JSON to save memory...
                 if (messageState.messageLoadHash[loadedMessageClone.id] === importedEnecoded) {
-                    debug("skipping upsert!");
+                    // debug("skipping upsert!")
                     continue;
                 }
                 // This logic is preventing cycles - could also be handled if update api had a parameter for who triggered update
@@ -630,10 +631,10 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
         throw new Error(lockOrigin + " exceeded maximum Retries (5) to acquire lockfile " + tryCount);
     }
     try {
-        debug(lockOrigin + " tries to acquire a lockfile Retry Nr.: " + tryCount);
+        debugLock(lockOrigin + " tries to acquire a lockfile Retry Nr.: " + tryCount);
         await fs.mkdir(lockDirPath);
         const stats = await fs.stat(lockDirPath);
-        debug(lockOrigin + " acquired a lockfile Retry Nr.: " + tryCount);
+        debugLock(lockOrigin + " acquired a lockfile Retry Nr.: " + tryCount);
         return stats.mtimeMs;
     }
     catch (error) {
@@ -650,12 +651,12 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
     catch (fstatError) {
         if (fstatError.code === "ENOENT") {
             // lock file seems to be gone :) - lets try again
-            debug(lockOrigin + " tryCount++ lock file seems to be gone :) - lets try again " + tryCount);
+            debugLock(lockOrigin + " tryCount++ lock file seems to be gone :) - lets try again " + tryCount);
             return acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1);
         }
         throw fstatError;
     }
-    debug(lockOrigin +
+    debugLock(lockOrigin +
         " tries to acquire a lockfile  - lock currently in use... starting probe phase " +
         tryCount);
     return new Promise((resolve, reject) => {
@@ -665,13 +666,13 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
                 probeCounts += 1;
                 let lockFileStats = undefined;
                 try {
-                    debug(lockOrigin + " tries to acquire a lockfile - check if the lock is free now " + tryCount);
+                    debugLock(lockOrigin + " tries to acquire a lockfile - check if the lock is free now " + tryCount);
                     // alright lets give it another try
                     lockFileStats = await fs.stat(lockDirPath);
                 }
                 catch (fstatError) {
                     if (fstatError.code === "ENOENT") {
-                        debug(lockOrigin +
+                        debugLock(lockOrigin +
                             " tryCount++ in Promise - tries to acquire a lockfile - lock file seems to be free now - try to acquire " +
                             tryCount);
                         const lock = acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1);
@@ -683,7 +684,7 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
                 if (lockFileStats.mtimeMs === currentLockTime) {
                     if (probeCounts >= nProbes) {
                         // ok maximum lock time ran up (we waitetd nProbes * probeInterval) - we consider the lock to be stale
-                        debug(lockOrigin +
+                        debugLock(lockOrigin +
                             " tries to acquire a lockfile  - lock not free - but stale lets drop it" +
                             tryCount);
                         try {
@@ -698,7 +699,7 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
                             return reject(rmLockError);
                         }
                         try {
-                            debug(lockOrigin +
+                            debugLock(lockOrigin +
                                 " tryCount++ same locker - try to acquire again after removing stale lock " +
                                 tryCount);
                             const lock = await acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1);
@@ -715,7 +716,7 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
                 }
                 else {
                     try {
-                        debug(lockOrigin + " tryCount++ different locker - try to acquire again " + tryCount);
+                        debugLock(lockOrigin + " tryCount++ different locker - try to acquire again " + tryCount);
                         const lock = await acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1);
                         return resolve(lock);
                     }
@@ -729,7 +730,7 @@ async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
     });
 }
 async function releaseLock(fs, lockDirPath, lockOrigin, lockTime) {
-    debug(lockOrigin + " releasing the lock ");
+    debugLock(lockOrigin + " releasing the lock ");
     try {
         const stats = await fs.stat(lockDirPath);
         if (stats.mtimeMs === lockTime) {
@@ -738,13 +739,13 @@ async function releaseLock(fs, lockDirPath, lockOrigin, lockTime) {
         }
     }
     catch (statError) {
-        debug(lockOrigin + " couldn't release the lock");
+        debugLock(lockOrigin + " couldn't release the lock");
         if (statError.code === "ENOENT") {
             // ok seeks like the log was released by someone else
-            debug(lockOrigin + " WARNING - the lock was released by a different process");
+            debugLock(lockOrigin + " WARNING - the lock was released by a different process");
             return;
         }
-        debug(statError);
+        debugLock(statError);
         throw statError;
     }
 }

package/dist/storage/helper.d.ts

@@ -1,5 +1,29 @@
 import { Message } from "../versionedInterfaces.js";
 export declare function getMessageIdFromPath(path: string): string | undefined;
 export declare function getPathFromMessageId(id: string): string;
+/**
+ * Returns a copy of a message object with sorted variants and object keys.
+ * This produces a deterministic result when passed to stringify
+ * independent of the initialization order.
+ */
+export declare function normalizeMessage(message: Message): {
+    id: string;
+    alias: Record<string, string>;
+    selectors: {
+        type: "VariableReference";
+        name: string;
+    }[];
+    variants: {
+        languageTag: string;
+        match: string[];
+        pattern: ({
+            type: "Text";
+            value: string;
+        } | {
+            type: "VariableReference";
+            name: string;
+        })[];
+    }[];
+};
 export declare function stringifyMessage(message: Message): string;
 //# sourceMappingURL=helper.d.ts.map

package/dist/storage/helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/storage/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAI5D,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,sBAahD;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,UAG9C;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,UAuBhD"}
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../src/storage/helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,2BAA2B,CAAA;AAI5D,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,sBAahD;AAED,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,UAG9C;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO;;;;;;;;;;;;;;;;;;EAwChD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,UAEhD"}

package/dist/storage/helper.js

@@ -15,21 +15,49 @@ export function getPathFromMessageId(id) {
     const path = id.replace("_", "/") + fileExtension;
     return path;
 }
-export function stringifyMessage(message) {
-    // create a new object do specify key output order
+/**
+ * Returns a copy of a message object with sorted variants and object keys.
+ * This produces a deterministic result when passed to stringify
+ * independent of the initialization order.
+ */
+export function normalizeMessage(message) {
+    // order keys in message
     const messageWithSortedKeys = {};
     for (const key of Object.keys(message).sort()) {
         messageWithSortedKeys[key] = message[key];
     }
-    // lets order variants as well
-    messageWithSortedKeys["variants"] = messageWithSortedKeys["variants"].sort((variantA, variantB) => {
-        // First, compare by language
+    // order variants
+    messageWithSortedKeys["variants"] = messageWithSortedKeys["variants"]
+        .sort((variantA, variantB) => {
+        // compare by language
         const languageComparison = variantA.languageTag.localeCompare(variantB.languageTag);
-        // If languages are the same, compare by match
+        // if languages are the same, compare by match
         if (languageComparison === 0) {
             return variantA.match.join("-").localeCompare(variantB.match.join("-"));
         }
         return languageComparison;
+    })
+        // order keys in each variant
+        .map((variant) => {
+        const variantWithSortedKeys = {};
+        for (const variantKey of Object.keys(variant).sort()) {
+            if (variantKey === "pattern") {
+                variantWithSortedKeys[variantKey] = variant["pattern"].map((token) => {
+                    const tokenWithSortedKey = {};
+                    for (const tokenKey of Object.keys(token).sort()) {
+                        tokenWithSortedKey[tokenKey] = token[tokenKey];
+                    }
+                    return tokenWithSortedKey;
+                });
+            }
+            else {
+                variantWithSortedKeys[variantKey] = variant[variantKey];
+            }
+        }
+        return variantWithSortedKeys;
     });
-    return JSON.stringify(messageWithSortedKeys, undefined, 4);
+    return messageWithSortedKeys;
+}
+export function stringifyMessage(message) {
+    return JSON.stringify(normalizeMessage(message), undefined, 4);
 }

package/dist/storage/helpers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=helpers.test.d.ts.map

package/dist/storage/helpers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.test.d.ts","sourceRoot":"","sources":["../../src/storage/helpers.test.ts"],"names":[],"mappings":""}

package/dist/storage/helpers.test.js

@@ -0,0 +1,84 @@
+import { describe, it, expect } from "vitest";
+// import { parseLixUri, parseOrigin } from "./helpers.js"
+import { normalizeMessage, stringifyMessage } from "./helper.js";
+const unsortedMessageRaw = {
+    alias: {},
+    selectors: [],
+    id: "footer_categories_apps",
+    variants: [
+        { languageTag: "a", match: ["*", "1"], pattern: [{ type: "Text", value: "2" }] },
+        { languageTag: "a", match: ["*", "*"], pattern: [{ type: "Text", value: "1" }] },
+        {
+            languageTag: "a",
+            match: ["1", "*"],
+            pattern: [
+                { type: "Text", value: "2" },
+                { type: "Text", value: "2" },
+            ],
+        },
+        { languageTag: "b", match: [], pattern: [{ type: "Text", value: "4" }] },
+        { languageTag: "a", match: ["1", "1"], pattern: [{ type: "Text", value: "2" }] },
+        { languageTag: "c", match: [], pattern: [{ value: "5", type: "Text" }] },
+        { match: [], languageTag: "d", pattern: [{ type: "Text", value: "6" }] },
+        { languageTag: "e", match: [], pattern: [{ type: "Text", value: "7" }] },
+        { languageTag: "f", match: [], pattern: [{ type: "Text", value: "8" }] },
+        { languageTag: "g", match: [], pattern: [{ type: "Text", value: "9" }] },
+    ],
+};
+const sortedMessageRaw = {
+    alias: {},
+    id: "footer_categories_apps",
+    selectors: [],
+    variants: [
+        { languageTag: "a", match: ["*", "*"], pattern: [{ type: "Text", value: "1" }] },
+        { languageTag: "a", match: ["*", "1"], pattern: [{ type: "Text", value: "2" }] },
+        {
+            languageTag: "a",
+            match: ["1", "*"],
+            pattern: [
+                { type: "Text", value: "2" },
+                { type: "Text", value: "2" },
+            ],
+        },
+        { languageTag: "a", match: ["1", "1"], pattern: [{ type: "Text", value: "2" }] },
+        { languageTag: "b", match: [], pattern: [{ type: "Text", value: "4" }] },
+        { languageTag: "c", match: [], pattern: [{ type: "Text", value: "5" }] },
+        { languageTag: "d", match: [], pattern: [{ type: "Text", value: "6" }] },
+        { languageTag: "e", match: [], pattern: [{ type: "Text", value: "7" }] },
+        { languageTag: "f", match: [], pattern: [{ type: "Text", value: "8" }] },
+        { languageTag: "g", match: [], pattern: [{ type: "Text", value: "9" }] },
+    ],
+};
+// stringify with no indentation
+function str(obj) {
+    return JSON.stringify(obj);
+}
+// stringify with 2 space indentation
+function str2(obj) {
+    return JSON.stringify(obj, undefined, 2);
+}
+// stringify with 4 space indentation
+function str4(obj) {
+    return JSON.stringify(obj, undefined, 4);
+}
+describe("normalizeMessage", () => {
+    it("should return the message with sorted keys and variants", () => {
+        // test cases are not the same (deep equal) before normalization
+        // array order of variants is different
+        expect(unsortedMessageRaw).not.toEqual(sortedMessageRaw);
+        // test cases are the same after normalization
+        expect(normalizeMessage(unsortedMessageRaw)).toEqual(sortedMessageRaw);
+        // stringify results are not the same before normalization
+        expect(str(unsortedMessageRaw)).not.toBe(str(sortedMessageRaw));
+        // stringify results are the same after normalization
+        expect(str(normalizeMessage(unsortedMessageRaw))).toBe(str(sortedMessageRaw));
+        expect(str2(normalizeMessage(unsortedMessageRaw))).toBe(str2(sortedMessageRaw));
+        expect(str4(normalizeMessage(unsortedMessageRaw))).toBe(str4(sortedMessageRaw));
+    });
+});
+describe("stringifyMessage", () => {
+    it("should normalize and JSON stringify a message with 4 space indentation", () => {
+        expect(stringifyMessage(unsortedMessageRaw)).toBe(str4(sortedMessageRaw));
+        expect(stringifyMessage(sortedMessageRaw)).toBe(str4(sortedMessageRaw));
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@inlang/sdk",
   "type": "module",
-  "version": "0.33.0",
+  "version": "0.34.1",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -34,14 +34,14 @@
     "throttle-debounce": "^5.0.0",
     "@inlang/json-types": "1.1.0",
     "@inlang/language-tag": "1.5.1",
+    "@inlang/message-lint-rule": "1.4.6",
+    "@inlang/module": "1.2.10",
     "@inlang/message": "2.1.0",
-    "@inlang/message-lint-rule": "1.4.5",
-    "@inlang/module": "1.2.9",
-    "@inlang/plugin": "2.4.9",
+    "@inlang/plugin": "2.4.10",
+    "@inlang/project-settings": "2.4.1",
     "@inlang/result": "1.1.0",
-    "@inlang/project-settings": "2.4.0",
+    "@lix-js/client": "1.4.0",
     "@inlang/translatable": "1.3.1",
-    "@lix-js/client": "1.2.1",
     "@lix-js/fs": "1.0.0"
   },
   "devDependencies": {

package/src/index.ts

@@ -26,6 +26,7 @@ export {
 	PluginSaveMessagesError,
 } from "./errors.js"
 
+export { normalizeMessage } from "./storage/helper.js"
 export * from "./messages/variant.js"
 export * from "./versionedInterfaces.js"
 export { InlangModule } from "@inlang/module"

package/src/loadProject.ts

@@ -39,7 +39,8 @@ import { identifyProject } from "./telemetry/groupIdentify.js"
 import type { NodeishStats } from "@lix-js/fs"
 
 import _debug from "debug"
-const debug = _debug("loadProject")
+const debug = _debug("sdk:loadProject")
+const debugLock = _debug("sdk:lockfile")
 
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings)
 
@@ -663,7 +664,7 @@ async function loadMessagesViaPlugin(
 
 				// NOTE could use hash instead of the whole object JSON to save memory...
 				if (messageState.messageLoadHash[loadedMessageClone.id] === importedEnecoded) {
-					debug("skipping upsert!")
+					// debug("skipping upsert!")
 					continue
 				}
 
@@ -902,10 +903,10 @@ async function acquireFileLock(
 	}
 
 	try {
-		debug(lockOrigin + " tries to acquire a lockfile Retry Nr.: " + tryCount)
+		debugLock(lockOrigin + " tries to acquire a lockfile Retry Nr.: " + tryCount)
 		await fs.mkdir(lockDirPath)
 		const stats = await fs.stat(lockDirPath)
-		debug(lockOrigin + " acquired a lockfile Retry Nr.: " + tryCount)
+		debugLock(lockOrigin + " acquired a lockfile Retry Nr.: " + tryCount)
 		return stats.mtimeMs
 	} catch (error: any) {
 		if (error.code !== "EEXIST") {
@@ -922,12 +923,14 @@ async function acquireFileLock(
 	} catch (fstatError: any) {
 		if (fstatError.code === "ENOENT") {
 			// lock file seems to be gone :) - lets try again
-			debug(lockOrigin + " tryCount++ lock file seems to be gone :) - lets try again " + tryCount)
+			debugLock(
+				lockOrigin + " tryCount++ lock file seems to be gone :) - lets try again " + tryCount
+			)
 			return acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1)
 		}
 		throw fstatError
 	}
-	debug(
+	debugLock(
 		lockOrigin +
 			" tries to acquire a lockfile  - lock currently in use... starting probe phase " +
 			tryCount
@@ -940,7 +943,7 @@ async function acquireFileLock(
 				probeCounts += 1
 				let lockFileStats: undefined | NodeishStats = undefined
 				try {
-					debug(
+					debugLock(
 						lockOrigin + " tries to acquire a lockfile - check if the lock is free now " + tryCount
 					)
 
@@ -948,7 +951,7 @@ async function acquireFileLock(
 					lockFileStats = await fs.stat(lockDirPath)
 				} catch (fstatError: any) {
 					if (fstatError.code === "ENOENT") {
-						debug(
+						debugLock(
 							lockOrigin +
 								" tryCount++ in Promise - tries to acquire a lockfile - lock file seems to be free now - try to acquire " +
 								tryCount
@@ -963,7 +966,7 @@ async function acquireFileLock(
 				if (lockFileStats.mtimeMs === currentLockTime) {
 					if (probeCounts >= nProbes) {
 						// ok maximum lock time ran up (we waitetd nProbes * probeInterval) - we consider the lock to be stale
-						debug(
+						debugLock(
 							lockOrigin +
 								" tries to acquire a lockfile  - lock not free - but stale lets drop it" +
 								tryCount
@@ -979,7 +982,7 @@ async function acquireFileLock(
 							return reject(rmLockError)
 						}
 						try {
-							debug(
+							debugLock(
 								lockOrigin +
 									" tryCount++ same locker - try to acquire again after removing stale lock " +
 									tryCount
@@ -995,7 +998,9 @@ async function acquireFileLock(
 					}
 				} else {
 					try {
-						debug(lockOrigin + " tryCount++ different locker - try to acquire again " + tryCount)
+						debugLock(
+							lockOrigin + " tryCount++ different locker - try to acquire again " + tryCount
+						)
 						const lock = await acquireFileLock(fs, lockDirPath, lockOrigin, tryCount + 1)
 						return resolve(lock)
 					} catch (error) {
@@ -1014,7 +1019,7 @@ async function releaseLock(
 	lockOrigin: string,
 	lockTime: number
 ) {
-	debug(lockOrigin + " releasing the lock ")
+	debugLock(lockOrigin + " releasing the lock ")
 	try {
 		const stats = await fs.stat(lockDirPath)
 		if (stats.mtimeMs === lockTime) {
@@ -1022,13 +1027,13 @@ async function releaseLock(
 			await fs.rmdir(lockDirPath)
 		}
 	} catch (statError: any) {
-		debug(lockOrigin + " couldn't release the lock")
+		debugLock(lockOrigin + " couldn't release the lock")
 		if (statError.code === "ENOENT") {
 			// ok seeks like the log was released by someone else
-			debug(lockOrigin + " WARNING - the lock was released by a different process")
+			debugLock(lockOrigin + " WARNING - the lock was released by a different process")
 			return
 		}
-		debug(statError)
+		debugLock(statError)
 		throw statError
 	}
 }

package/src/migrations/maybeCreateFirstProjectId.test.ts

@@ -28,4 +28,4 @@ it("should return undefined if repoMeta contains error", async () => {
 		projectPath: "mocked_project_path",
 	})
 	expect(projectId).toBeUndefined()
-})
+})

package/src/storage/helper.ts

@@ -22,27 +22,53 @@ export function getPathFromMessageId(id: string) {
 	return path
 }
 
-export function stringifyMessage(message: Message) {
-	// create a new object do specify key output order
+/**
+ * Returns a copy of a message object with sorted variants and object keys.
+ * This produces a deterministic result when passed to stringify
+ * independent of the initialization order.
+ */
+export function normalizeMessage(message: Message) {
+	// order keys in message
 	const messageWithSortedKeys: any = {}
 	for (const key of Object.keys(message).sort()) {
 		messageWithSortedKeys[key] = (message as any)[key]
 	}
 
-	// lets order variants as well
-	messageWithSortedKeys["variants"] = messageWithSortedKeys["variants"].sort(
-		(variantA: Variant, variantB: Variant) => {
-			// First, compare by language
+	// order variants
+	messageWithSortedKeys["variants"] = messageWithSortedKeys["variants"]
+		.sort((variantA: Variant, variantB: Variant) => {
+			// compare by language
 			const languageComparison = variantA.languageTag.localeCompare(variantB.languageTag)
 
-			// If languages are the same, compare by match
+			// if languages are the same, compare by match
 			if (languageComparison === 0) {
 				return variantA.match.join("-").localeCompare(variantB.match.join("-"))
 			}
 
 			return languageComparison
-		}
-	)
+		})
+		// order keys in each variant
+		.map((variant: Variant) => {
+			const variantWithSortedKeys: any = {}
+			for (const variantKey of Object.keys(variant).sort()) {
+				if (variantKey === "pattern") {
+					variantWithSortedKeys[variantKey] = (variant as any)["pattern"].map((token: any) => {
+						const tokenWithSortedKey: any = {}
+						for (const tokenKey of Object.keys(token).sort()) {
+							tokenWithSortedKey[tokenKey] = token[tokenKey]
+						}
+						return tokenWithSortedKey
+					})
+				} else {
+					variantWithSortedKeys[variantKey] = (variant as any)[variantKey]
+				}
+			}
+			return variantWithSortedKeys
+		})
 
-	return JSON.stringify(messageWithSortedKeys, undefined, 4)
+	return messageWithSortedKeys as Message
+}
+
+export function stringifyMessage(message: Message) {
+	return JSON.stringify(normalizeMessage(message), undefined, 4)
 }

package/src/storage/helpers.test.ts

@@ -0,0 +1,95 @@
+import { describe, it, expect } from "vitest"
+// import { parseLixUri, parseOrigin } from "./helpers.js"
+import { normalizeMessage, stringifyMessage } from "./helper.js"
+import type { Message } from "@inlang/message"
+
+const unsortedMessageRaw: Message = {
+	alias: {},
+	selectors: [],
+	id: "footer_categories_apps",
+	variants: [
+		{ languageTag: "a", match: ["*", "1"], pattern: [{ type: "Text", value: "2" }] },
+		{ languageTag: "a", match: ["*", "*"], pattern: [{ type: "Text", value: "1" }] },
+		{
+			languageTag: "a",
+			match: ["1", "*"],
+			pattern: [
+				{ type: "Text", value: "2" },
+				{ type: "Text", value: "2" },
+			],
+		},
+		{ languageTag: "b", match: [], pattern: [{ type: "Text", value: "4" }] },
+		{ languageTag: "a", match: ["1", "1"], pattern: [{ type: "Text", value: "2" }] },
+		{ languageTag: "c", match: [], pattern: [{ value: "5", type: "Text" }] },
+		{ match: [], languageTag: "d", pattern: [{ type: "Text", value: "6" }] },
+		{ languageTag: "e", match: [], pattern: [{ type: "Text", value: "7" }] },
+		{ languageTag: "f", match: [], pattern: [{ type: "Text", value: "8" }] },
+		{ languageTag: "g", match: [], pattern: [{ type: "Text", value: "9" }] },
+	],
+}
+
+const sortedMessageRaw: Message = {
+	alias: {},
+	id: "footer_categories_apps",
+	selectors: [],
+	variants: [
+		{ languageTag: "a", match: ["*", "*"], pattern: [{ type: "Text", value: "1" }] },
+		{ languageTag: "a", match: ["*", "1"], pattern: [{ type: "Text", value: "2" }] },
+		{
+			languageTag: "a",
+			match: ["1", "*"],
+			pattern: [
+				{ type: "Text", value: "2" },
+				{ type: "Text", value: "2" },
+			],
+		},
+		{ languageTag: "a", match: ["1", "1"], pattern: [{ type: "Text", value: "2" }] },
+		{ languageTag: "b", match: [], pattern: [{ type: "Text", value: "4" }] },
+		{ languageTag: "c", match: [], pattern: [{ type: "Text", value: "5" }] },
+		{ languageTag: "d", match: [], pattern: [{ type: "Text", value: "6" }] },
+		{ languageTag: "e", match: [], pattern: [{ type: "Text", value: "7" }] },
+		{ languageTag: "f", match: [], pattern: [{ type: "Text", value: "8" }] },
+		{ languageTag: "g", match: [], pattern: [{ type: "Text", value: "9" }] },
+	],
+}
+
+// stringify with no indentation
+function str(obj: any) {
+	return JSON.stringify(obj)
+}
+
+// stringify with 2 space indentation
+function str2(obj: any) {
+	return JSON.stringify(obj, undefined, 2)
+}
+
+// stringify with 4 space indentation
+function str4(obj: any) {
+	return JSON.stringify(obj, undefined, 4)
+}
+
+describe("normalizeMessage", () => {
+	it("should return the message with sorted keys and variants", () => {
+		// test cases are not the same (deep equal) before normalization
+		// array order of variants is different
+		expect(unsortedMessageRaw).not.toEqual(sortedMessageRaw)
+
+		// test cases are the same after normalization
+		expect(normalizeMessage(unsortedMessageRaw)).toEqual(sortedMessageRaw)
+
+		// stringify results are not the same before normalization
+		expect(str(unsortedMessageRaw)).not.toBe(str(sortedMessageRaw))
+
+		// stringify results are the same after normalization
+		expect(str(normalizeMessage(unsortedMessageRaw))).toBe(str(sortedMessageRaw))
+		expect(str2(normalizeMessage(unsortedMessageRaw))).toBe(str2(sortedMessageRaw))
+		expect(str4(normalizeMessage(unsortedMessageRaw))).toBe(str4(sortedMessageRaw))
+	})
+})
+
+describe("stringifyMessage", () => {
+	it("should normalize and JSON stringify a message with 4 space indentation", () => {
+		expect(stringifyMessage(unsortedMessageRaw)).toBe(str4(sortedMessageRaw))
+		expect(stringifyMessage(sortedMessageRaw)).toBe(str4(sortedMessageRaw))
+	})
+})