Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/configManager/__test__/configManager.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Config, { updateConfigFromUrl } from "../configManager";
import { getDefaultConfig } from "../config.default";
import { getDefaultConfig, getUserInitData } from "../config.default";
import { DeepSignal } from "deepsignal";
import { IConfig } from "../../types/types";

Expand Down Expand Up @@ -90,6 +90,18 @@ describe("Config", () => {
});
});

describe("config default flags", () => {
test("enableLivePreviewOutsideIframe defaults to false in getDefaultConfig", () => {
const defaultConfig = getDefaultConfig();
expect(defaultConfig.enableLivePreviewOutsideIframe).toBe(false);
});

test("enableLivePreviewOutsideIframe defaults to false in getUserInitData", () => {
const initData = getUserInitData();
expect(initData.enableLivePreviewOutsideIframe).toBe(false);
});
});

describe("update config from url", () => {
let config: DeepSignal<IConfig>;

Expand Down
35 changes: 35 additions & 0 deletions src/configManager/__test__/handleUserConfig.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,41 @@ describe("handleInitData()", () => {
});
});

describe("handleInitData() - enableLivePreviewOutsideIframe", () => {
let config: DeepSignal<IConfig>;

beforeEach(() => {
Config.reset();
config = Config.get();
});

afterAll(() => {
Config.reset();
});

test("should default to false when not provided", () => {
const initData: Partial<IInitData> = {};
handleInitData(initData);
expect(config.enableLivePreviewOutsideIframe).toBe(false);
});

test("should set to true when provided as true", () => {
const initData: Partial<IInitData> = {
enableLivePreviewOutsideIframe: true,
};
handleInitData(initData);
expect(config.enableLivePreviewOutsideIframe).toBe(true);
});

test("should remain false when provided as false", () => {
const initData: Partial<IInitData> = {
enableLivePreviewOutsideIframe: false,
};
handleInitData(initData);
expect(config.enableLivePreviewOutsideIframe).toBe(false);
});
});

describe("handleClientUrlParams()", () => {
let config: DeepSignal<IConfig>;

Expand Down
2 changes: 2 additions & 0 deletions src/configManager/config.default.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export function getUserInitData(): IInitData {
environment: "",
},
runScriptsOnUpdate: false,
enableLivePreviewOutsideIframe: false,
};
}

Expand Down Expand Up @@ -110,5 +111,6 @@ export function getDefaultConfig(): IConfig {
},
payload: [],
},
enableLivePreviewOutsideIframe: false,
};
}
2 changes: 2 additions & 0 deletions src/configManager/handleUserConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ export const handleInitData = (initData: Partial<IInitData>): void => {
"bottom-right",
})

Config.set("enableLivePreviewOutsideIframe", initData.enableLivePreviewOutsideIframe ?? config.enableLivePreviewOutsideIframe ?? false);

// client URL params
handleClientUrlParams(
initData.clientUrlParams ??
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ import {
import {
useOnEntryUpdatePostMessageEvent,
useHistoryPostMessageEvent,
sendInitializeLivePreviewPostMessageEvent,
} from "../postMessageEvent.hooks";
import { isOpeningInNewTab } from "../../../common/inIframe";

// Mock dependencies
vi.mock("../../../configManager/configManager", () => ({
default: {
get: vi.fn(),
set: vi.fn(),
},
setConfigFromParams: vi.fn(),
}));
Expand All @@ -35,13 +37,19 @@ vi.mock("../../../logger/logger", () => ({
vi.mock("../livePreviewEventManager", () => ({
default: {
on: vi.fn(),
send: vi.fn(),
},
}));

vi.mock("../../../common/inIframe", () => ({
isOpeningInNewTab: vi.fn(),
}));

vi.mock("../../../utils", () => ({
addParamsToUrl: vi.fn(),
isOpeningInTimeline: vi.fn(() => false),
}));

describe("postMessageEvent.hooks", () => {
let mockWindow: any;
let mockConfig: any;
Expand Down Expand Up @@ -415,4 +423,56 @@ describe("postMessageEvent.hooks", () => {
}).toThrow("Unhandled event: unknown");
});
});

describe("sendInitializeLivePreviewPostMessageEvent", () => {
beforeEach(() => {
// default send resolves with preview windowType, no contentType/entry to avoid side-effects
(livePreviewPostMessage as any).send.mockResolvedValue({
windowType: "preview",
});
});

it("should include enableLivePreviewOutsideIframe=false in INIT payload", async () => {
mockConfig = {
ssr: true, // avoid timers
mode: 1,
enableLivePreviewOutsideIframe: false,
};
(Config.get as any).mockReturnValue(mockConfig);

await sendInitializeLivePreviewPostMessageEvent();
// allow microtasks to flush
await Promise.resolve();

expect(livePreviewPostMessage?.send).toHaveBeenCalledWith(
LIVE_PREVIEW_POST_MESSAGE_EVENTS.INIT,
expect.objectContaining({
config: expect.objectContaining({
enableLivePreviewOutsideIframe: false,
}),
})
);
});

it("should include enableLivePreviewOutsideIframe=true in INIT payload", async () => {
mockConfig = {
ssr: true, // avoid timers
mode: 1,
enableLivePreviewOutsideIframe: true,
};
(Config.get as any).mockReturnValue(mockConfig);

await sendInitializeLivePreviewPostMessageEvent();
await Promise.resolve();

expect(livePreviewPostMessage?.send).toHaveBeenCalledWith(
LIVE_PREVIEW_POST_MESSAGE_EVENTS.INIT,
expect.objectContaining({
config: expect.objectContaining({
enableLivePreviewOutsideIframe: true,
}),
})
);
});
});
});
1 change: 1 addition & 0 deletions src/livePreview/eventManager/postMessageEvent.hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ export function sendInitializeLivePreviewPostMessageEvent(): void {
href: window.location.href,
sdkVersion: process?.env?.PACKAGE_VERSION,
mode: Config.get().mode,
enableLivePreviewOutsideIframe: Config.get().enableLivePreviewOutsideIframe,
},
}
)
Expand Down
2 changes: 2 additions & 0 deletions src/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ export declare interface IConfig {
highlightedElement: HTMLElement | null;
};
collab: ICollabConfig["collab"];
enableLivePreviewOutsideIframe: boolean;
}


Expand Down Expand Up @@ -132,6 +133,7 @@ export declare interface IInitData {
editButton: IConfigEditButton;
editInVisualBuilderButton: IConfigEditInVisualBuilderButton;
mode: ILivePreviewMode;
enableLivePreviewOutsideIframe: boolean; // default: false
}

// type PickPartial<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
Expand Down
Loading