get deterministic serialization using stableStringify (#1064)

Author: anserwaseem

.changeset/giant-owls-exercise.md

@@ -0,0 +1,5 @@
+---
+"@ensembleui/js-commons": patch
+---
+
+get deterministic serialization using stableStringify

packages/js-commons/package.json

@@ -42,6 +42,7 @@
     "dayjs": "^1.11.10",
     "eslint-config-custom": "workspace:*",
     "firebase": "9.10.0",
+    "json-stable-stringify": "^1.2.1",
     "lodash-es": "^4.17.21",
     "tsconfig": "workspace:*",
     "tsup": "^7.2.0"

packages/js-commons/src/core/local-files.ts

@@ -16,6 +16,7 @@ import {
   pick,
   values,
 } from "lodash-es";
+import stableStringify from "json-stable-stringify";
 import type { LocalApplicationTransporter } from "./transporter";
 import { ArtifactProps, EnsembleDocumentType } from "./dto";
 import type {
@@ -272,7 +273,7 @@ export const localStoreAsset = async (
   await writeFile(assetPath, fileData); // write the file to disk
   await writeFile(
     join(assetDir, `${fileName}.json`),
-    JSON.stringify(assetDocument),
+    stableStringify(assetDocument, { space: 2 }) || "",
   ); // write file's metadata separately in json
 
   const { relativePath } = await saveArtifact(assetDocument, appMetadata, {
@@ -359,7 +360,9 @@ export const saveArtifact = async (
   if (!isAssetOrFont(artifact)) {
     await writeFile(
       join(artifactSubDir, pathToWrite),
-      isConfigOrSecret(artifact) ? JSON.stringify(artifact) : artifact.content,
+      isConfigOrSecret(artifact)
+        ? stableStringify(artifact, { space: 2 }) || ""
+        : artifact.content,
       "utf-8",
     );
   }
@@ -437,7 +440,7 @@ const writeJsonData = async (
   data: unknown,
   hideFile = false,
 ): Promise<void> => {
-  await writeFile(filePath, JSON.stringify(data, null, 2), "utf-8");
+  await writeFile(filePath, stableStringify(data, { space: 2 }) || "", "utf-8");
 
   if (hideFile) hideOnWindow(filePath);
 };