Merge pull request #111 from contentstack/EB-1200-implement-signals-i…

…n-live-preview-sdk EB-1200: Implement signals in live preview sdk
contentstack · Mar 12, 2024 · 373761f · 373761f
2 parents d1e36f9 + 42a90fb
commit 373761f
Show file tree

Hide file tree

Showing 18 changed files with 277 additions and 208 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -76,6 +76,7 @@
         "@preact/compat": "^17.1.2",
         "@preact/signals": "^1.2.2",
         "classnames": "^2.5.1",
+        "deepsignal": "^1.5.0",
         "just-camel-case": "^6.2.0",
         "lodash-es": "^4.17.21",
         "mustache": "^4.2.0",

diff --git a/src/configManager/__test__/configManager.test.ts b/src/configManager/__test__/configManager.test.ts
@@ -1,28 +1,34 @@
 import Config, { updateConfigFromUrl } from "../configManager";
 import { getDefaultConfig } from "../config.default";
+import { DeepSignal } from "deepsignal";
+import { IConfig } from "../../types/types";
 
 describe("Config", () => {
+    let config: DeepSignal<IConfig>;
+
     beforeEach(() => {
         Config.reset();
+        config = Config.get();
     });
+
     afterAll(() => {
         Config.reset();
     });
 
     test("should return default value", () => {
         const defaultConfig = getDefaultConfig();
-        const receivedConfig = Config.get();
+        const receivedConfig = config;
 
-        //@ts-expect-error
+        // @ts-expect-error
         delete defaultConfig.onChange;
-        //@ts-expect-error
+        // @ts-expect-error
         delete receivedConfig.onChange;
-        expect(Config.get()).toStrictEqual(defaultConfig);
+        expect(config).toStrictEqual(defaultConfig);
     });
 
     test("should set and get value", () => {
         const defaultConfig = getDefaultConfig();
-        let receivedConfig = Config.get();
+        let receivedConfig = config;
 
         // @ts-expect-error
         delete defaultConfig.onChange;
@@ -32,7 +38,7 @@ describe("Config", () => {
         expect(receivedConfig).toEqual({ ...defaultConfig, ssr: true });
 
         Config.set("ssr", false);
-        receivedConfig = Config.get();
+        receivedConfig = config;
 
         // @ts-expect-error
         delete receivedConfig.onChange;
@@ -48,7 +54,7 @@ describe("Config", () => {
 
     test("should replace config", () => {
         const defaultConfig = getDefaultConfig();
-        let receivedConfig = Config.get();
+        let receivedConfig = config;
 
         // @ts-expect-error
         delete defaultConfig.onChange;
@@ -66,7 +72,7 @@ describe("Config", () => {
             },
         });
 
-        receivedConfig = Config.get();
+        receivedConfig = config;
 
         // @ts-expect-error
         delete receivedConfig.onChange;
@@ -85,8 +91,11 @@ describe("Config", () => {
 });
 
 describe("update config from url", () => {
+    let config: DeepSignal<IConfig>;
+
     beforeEach(() => {
         Config.reset();
+        config = Config.get();
     });
 
     afterEach(() => {
@@ -116,26 +125,28 @@ describe("update config from url", () => {
             },
         });
 
-        expect(Config.get().stackDetails.contentTypeUid).toEqual("");
-        expect(Config.get().stackDetails.entryUid).toEqual("");
-        expect(Config.get().hash).toEqual("");
+        const config = Config.get();
+
+        expect(config.stackDetails.contentTypeUid).toEqual("");
+        expect(config.stackDetails.entryUid).toEqual("");
+        expect(config.hash).toEqual("");
 
         updateConfigFromUrl();
 
-        expect(Config.get().stackDetails.contentTypeUid).toEqual("test");
-        expect(Config.get().stackDetails.entryUid).toEqual("test");
-        expect(Config.get().hash).toEqual("test");
+        expect(config.stackDetails.contentTypeUid).toEqual("test");
+        expect(config.stackDetails.entryUid).toEqual("test");
+        expect(config.hash).toEqual("test");
     });
 
     it("should be default config if url params are not available", () => {
-        expect(Config.get().stackDetails.contentTypeUid).toEqual("");
-        expect(Config.get().stackDetails.entryUid).toEqual("");
-        expect(Config.get().hash).toEqual("");
+        expect(config.stackDetails.contentTypeUid).toEqual("");
+        expect(config.stackDetails.entryUid).toEqual("");
+        expect(config.hash).toEqual("");
 
         updateConfigFromUrl();
 
-        expect(Config.get().stackDetails.contentTypeUid).toEqual("");
-        expect(Config.get().stackDetails.entryUid).toEqual("");
-        expect(Config.get().hash).toEqual("");
+        expect(config.stackDetails.contentTypeUid).toEqual("");
+        expect(config.stackDetails.entryUid).toEqual("");
+        expect(config.hash).toEqual("");
     });
 });