@thoughtspot/visual-embed-sdk
Version:
ThoughtSpot Embed SDK
943 lines • 46.3 kB
JavaScript
import { AppEmbed, DataPanelCustomColumnGroupsAccordionState, Page, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, ListPage, } from './app';
import { init } from '../index';
import { Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp } from '../types';
import { executeAfterWait, getDocumentBody, getIFrameSrc, getRootEl, getIFrameEl, mockMessageChannel, defaultParams, defaultParamsForPinboardEmbed, defaultParamsWithoutHiddenActions, expectUrlMatchesWithParams, } from '../test/test-utils';
import * as config from '../config';
import { TsEmbed } from './ts-embed';
import { logger } from '../utils/logger';
import * as auth from '../auth';
const defaultViewConfig = {
frameParams: {
width: 1280,
height: 720,
},
};
const thoughtSpotHost = 'tshost';
const defaultParamsPost = '';
const originalResizeObserver = window.ResizeObserver;
beforeAll(() => {
init({
thoughtSpotHost,
authType: AuthType.None,
});
jest.spyOn(auth, 'postLoginService').mockImplementation(() => Promise.resolve({}));
window.ResizeObserver =
window.ResizeObserver ||
jest.fn().mockImplementation(() => ({
disconnect: jest.fn(),
observe: jest.fn(),
unobserve: jest.fn(),
}));
});
const cleanUp = () => {
document.body.innerHTML = getDocumentBody();
window.ResizeObserver = originalResizeObserver;
};
describe('App embed tests', () => {
beforeEach(() => {
cleanUp();
});
test('should render home page by default', async () => {
const appEmbed = new AppEmbed(getRootEl(), defaultViewConfig);
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should hide the primary nav bar', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should hide the help and profile buttons from nav bar', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
disableProfileAndHelp: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should hide the application switcher button from nav bar', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideApplicationSwitcher: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&applicationSwitcherHidden=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should hide the org switcher button from nav bar', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideOrgSwitcher: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&orgSwitcherHidden=true${defaultParams}${defaultParamsPost}#/home`);
});
});
describe('should render the correct routes for pages', () => {
const pageRouteMap = {
[Page.Search]: 'answer',
[Page.Answers]: 'answers',
[Page.Pinboards]: 'pinboards',
[Page.Liveboards]: 'pinboards',
[Page.Data]: 'data/tables',
[Page.Home]: 'home',
[Page.SpotIQ]: 'insights/results',
[Page.Monitor]: 'insights/monitor-alerts',
};
const pageIds = Object.keys(pageRouteMap);
for (let i = 0; i < pageIds.length; i++) {
const pageId = pageIds[i];
test(`${pageId}`, async () => {
const route = pageRouteMap[pageId];
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
pageId: pageId,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/${route}`);
cleanUp();
});
});
}
const pageRouteMapForModularHome = {
[Page.Search]: 'answer',
[Page.Answers]: 'home/answers',
[Page.Pinboards]: 'home/liveboards',
[Page.Liveboards]: 'home/liveboards',
[Page.Data]: 'data/tables',
[Page.Home]: 'home',
[Page.SpotIQ]: 'home/spotiq-analysis',
[Page.Monitor]: 'home/monitor-alerts',
};
const pageIdsForModularHomes = Object.keys(pageRouteMapForModularHome);
for (let i = 0; i < pageIdsForModularHomes.length; i++) {
const pageIdsForModularHome = pageIdsForModularHomes[i];
test(`${pageIdsForModularHome}`, async () => {
const route = pageRouteMapForModularHome[pageIdsForModularHome];
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
modularHomeExperience: true,
pageId: pageIdsForModularHome,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/${route}`);
cleanUp();
});
});
}
});
test('should navigate to a path', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
path: 'foo/bar',
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/foo/bar`);
});
});
test('should apply runtime filters', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: true,
runtimeFilters: [
{
columnName: 'sales',
operator: RuntimeFilterOp.EQ,
values: [1000],
},
],
excludeRuntimeFiltersfromURL: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false&col1=sales&op1=EQ&val1=1000${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should not append runtime filters in URL if excludeRuntimeFiltersfromURL is true', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: true,
runtimeFilters: [
{
columnName: 'sales',
operator: RuntimeFilterOp.EQ,
values: [1000],
},
],
excludeRuntimeFiltersfromURL: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should append runtime filters in URL if excludeRuntimeFiltersfromURL is undefined', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: true,
runtimeFilters: [
{
columnName: 'sales',
operator: RuntimeFilterOp.EQ,
values: [1000],
},
],
});
appEmbed.render();
const runtimeFilter = 'col1=sales&op1=EQ&val1=1000';
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false${defaultParams}${defaultParamsPost}&${runtimeFilter}#/home`);
});
});
test('should disable and hide actions', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: true,
disabledActions: [Action.Save, Action.Update],
disabledActionReason: 'Access denied',
hiddenActions: [Action.Download],
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=false&profileAndHelpInNavBarHidden=false&${defaultParamsWithoutHiddenActions}&disableAction=[%22save%22,%22update%22]&disableHint=Access%20denied&hideAction=[%22${Action.ReportError}%22,%22download%22]${defaultParamsPost}#/home`);
});
});
test('should set enable2ColumnLayout to true in url', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
enable2ColumnLayout: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enable2ColumnLayout=true${defaultParamsPost}#/home`);
});
});
test('should set coverAndFilterOptionInPDF to false in url', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
coverAndFilterOptionInPDF: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&arePdfCoverFilterPageCheckboxesEnabled=false${defaultParamsPost}#/home`);
});
});
test('should set isLiveboardStylingAndGroupingEnabled to true in url', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
isLiveboardStylingAndGroupingEnabled: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&isLiveboardStylingAndGroupingEnabled=true${defaultParamsPost}#/home`);
});
});
test('Should add the tag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showPrimaryNavbar: false,
tag: 'Finance',
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false${defaultParams}&tag=Finance${defaultParamsPost}#/home`);
});
});
test('Should add enableSearchAssist flagto the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
enableSearchAssist: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&enableSearchAssist=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add enableDataPanelV2 flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
dataPanelV2: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&enableDataPanelV2=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add isLiveboardHeaderSticky flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
isLiveboardHeaderSticky: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardHeaderSticky=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add isLiveboardCompactHeaderEnabled flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
isLiveboardCompactHeaderEnabled: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardHeaderV2Enabled=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add showLiveboardReverifyBanner flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showLiveboardReverifyBanner: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&showLiveboardReverifyBanner=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add isUnifiedSearchExperienceEnabled flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
isUnifiedSearchExperienceEnabled: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isUnifiedSearchExperienceEnabled=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add hideIrrelevantFiltersAtTabLevel flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideIrrelevantChipsInLiveboardTabs: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&hideIrrelevantFiltersAtTabLevel=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add showLiveboardVerifiedBadge flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
showLiveboardVerifiedBadge: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&showLiveboardVerifiedBadge=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add default values of flags to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&isLiveboardHeaderSticky=true&hideLiveboardHeader=false&showLiveboardDescription=true&showLiveboardTitle=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add modularHomeExperience flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
modularHomeExperience: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add hideHomepageLeftNav flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideHomepageLeftNav: false,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&hideHomepageLeftNav=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add hideHamburger, hideObjectSearch, hideNotification flags to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideHamburger: true,
hideObjectSearch: true,
hideNotification: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&hideHamburger=true&hideObjectSearch=true&hideNotification=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should not add when hideHamburger, hideObjectSearch, hideNotification values are not true to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
hideHamburger: false,
hideObjectSearch: undefined,
hideNotification: null,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add navigationVersion=v3 when primaryNavbarVersion is Sliding to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
homePage: HomePage.Modular,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true&navigationVersion=v3${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should not add navigationVersion=v3 when primaryNavbarVersion is not added to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
homePage: HomePage.Modular,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add navigationVersion=v3 & modularHomeExperience=false when primaryNavbarVersion is Sliding to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&navigationVersion=v3${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add enableAskSage flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
enableAskSage: true,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&enableAskSage=true${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add listpageVersion=v3 when listPageVersion is ListWithUXChanges to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
listPageVersion: ListPage.ListWithUXChanges,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&listpageVersion=v3${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should not add listpageVersion when listPageVersion is List (v2) to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
listPageVersion: ListPage.List,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add listpageVersion=v3 combined with other discoveryExperience options to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
discoveryExperience: {
primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
homePage: HomePage.Modular,
listPageVersion: ListPage.ListWithUXChanges,
},
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=true&navigationVersion=v3&listpageVersion=v3${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add enablePendoHelp flag to the iframe src conditional on navbar', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?enablePendoHelp=true&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`);
});
const noNavEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
enablePendoHelp: false,
});
noNavEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?enablePendoHelp=false&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add HomePageSearchBarMode flag with object search to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
homePageSearchBarMode: HomePageSearchBarMode.OBJECT_SEARCH,
});
await appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&homePageSearchBarMode=objectSearch${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add HomePageSearchBarMode flag with ai answer to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
homePageSearchBarMode: HomePageSearchBarMode.AI_ANSWER,
});
await appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&homePageSearchBarMode=aiAnswer${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add HomePageSearchBarMode flag with none to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
homePageSearchBarMode: HomePageSearchBarMode.NONE,
});
await appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&homePageSearchBarMode=none${defaultParams}${defaultParamsPost}#/home`);
});
});
test('Should add dataPanelCustomGroupsAccordionInitialState flag to the iframe src', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
});
appEmbed.render();
await executeAfterWait(() => {
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_FIRST${defaultParams}${defaultParamsPost}#/home`);
});
});
test('should register event handlers to adjust iframe height', async () => {
let embedHeightCallback = () => { };
const onSpy = jest.spyOn(AppEmbed.prototype, 'on').mockImplementation((event, callback) => {
if (event === EmbedEvent.RouteChange) {
callback({ data: { currentPath: '/answers' } }, jest.fn());
}
if (event === EmbedEvent.EmbedHeight) {
embedHeightCallback = callback;
}
if (event === EmbedEvent.EmbedIframeCenter) {
callback({}, jest.fn());
}
return null;
});
jest.spyOn(TsEmbed.prototype, 'getIframeCenter').mockReturnValue({});
jest.spyOn(TsEmbed.prototype, 'setIFrameHeight').mockReturnValue({});
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
// Set the iframe before render
appEmbed.iFrame = document.createElement('iframe');
// Wait for render to complete
await appEmbed.render();
embedHeightCallback({ data: '100%' });
// Verify event handlers were registered
await executeAfterWait(() => {
expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedHeight, expect.anything());
expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RouteChange, expect.anything());
expect(onSpy).toHaveBeenCalledWith(EmbedEvent.EmbedIframeCenter, expect.anything());
expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RequestVisibleEmbedCoordinates, expect.anything());
}, 100);
});
describe('Navigate to Page API', () => {
const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
beforeEach(() => {
jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
});
test('when app is AppEmbed after navigateToPage function call, new path should be set to iframe', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
frameParams: {
width: '100%',
height: '100%',
},
});
await appEmbed.render();
appEmbed.navigateToPage(path);
expectUrlMatchesWithParams(getIFrameSrc(), `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}${defaultParamsPost}#/${path}`);
});
test('navigateToPage with noReload should trigger the appropriate event', async () => {
mockMessageChannel();
const appEmbed = new AppEmbed(getRootEl(), {
frameParams: {
width: '100%',
height: '100%',
},
});
await appEmbed.render();
const iframe = getIFrameEl();
iframe.contentWindow.postMessage = jest.fn();
appEmbed.navigateToPage(path, true);
expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(expect.objectContaining({
type: HostEvent.Navigate,
data: path,
}), `http://${thoughtSpotHost}`, expect.anything());
appEmbed.navigateToPage(-1, true);
expect(iframe.contentWindow.postMessage).toHaveBeenCalledWith(expect.objectContaining({
type: HostEvent.Navigate,
data: -1,
}), `http://${thoughtSpotHost}`, expect.anything());
});
test('Do not allow number path without noReload in navigateToPage', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
frameParams: {
width: '100%',
height: '100%',
},
});
await appEmbed.render();
spyOn(logger, 'warn');
appEmbed.navigateToPage(-1);
expect(logger.warn).toHaveBeenCalledWith('Path can only by a string when triggered without noReload');
});
test('navigateToPage function use before render', async () => {
spyOn(logger, 'log');
const appEmbed = new AppEmbed(getRootEl(), {
frameParams: {
width: '100%',
height: '100%',
},
});
appEmbed.navigateToPage(path);
await appEmbed.render();
expect(logger.log).toHaveBeenCalledWith('Please call render before invoking this method');
});
});
describe('LazyLoadingForFullHeight functionality', () => {
let mockIFrame;
beforeEach(() => {
mockIFrame = document.createElement('iframe');
mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
top: 100,
left: 150,
bottom: 600,
right: 800,
width: 650,
height: 500,
});
jest.spyOn(document, 'createElement').mockImplementation((tagName) => {
if (tagName === 'iframe') {
return mockIFrame;
}
return document.createElement(tagName);
});
});
afterEach(() => {
jest.restoreAllMocks();
});
test('should set lazyLoadingMargin parameter when provided', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
lazyLoadingMargin: '100px 0px',
});
await appEmbed.render();
await executeAfterWait(() => {
const iframeSrc = getIFrameSrc();
expect(iframeSrc).toContain('isLazyLoadingForEmbedEnabled=true');
expect(iframeSrc).toContain('isFullHeightPinboard=true');
expect(iframeSrc).toContain('rootMarginForLazyLoad=100px%200px');
}, 100);
});
test('should set isLazyLoadingForEmbedEnabled=true when both fullHeight and lazyLoadingForFullHeight are enabled', async () => {
// Mock the iframe element first
mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
top: 100,
left: 150,
bottom: 600,
right: 800,
width: 650,
height: 500,
});
Object.defineProperty(mockIFrame, 'scrollHeight', { value: 500 });
// Mock the event handlers
const onSpy = jest.spyOn(AppEmbed.prototype, 'on').mockImplementation((event, callback) => {
return null;
});
jest.spyOn(TsEmbed.prototype, 'getIframeCenter').mockReturnValue({});
jest.spyOn(TsEmbed.prototype, 'setIFrameHeight').mockReturnValue({});
// Create the AppEmbed instance
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
// Set the iframe before render
appEmbed.iFrame = mockIFrame;
// Add the iframe to the DOM
const rootEl = getRootEl();
rootEl.appendChild(mockIFrame);
// Wait for render to complete
await appEmbed.render();
// Wait for iframe initialization and URL parameters to be set
await executeAfterWait(() => {
const iframeSrc = appEmbed.getIFrameSrc();
expect(iframeSrc).toContain('isLazyLoadingForEmbedEnabled=true');
expect(iframeSrc).toContain('isFullHeightPinboard=true');
}, 100);
});
test('should not set lazyLoadingForEmbed when lazyLoadingForFullHeight is enabled but fullHeight is false', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: false,
lazyLoadingForFullHeight: true,
});
// Wait for render to complete
await appEmbed.render();
// Wait for iframe initialization and URL parameters to be set
await executeAfterWait(() => {
const iframeSrc = getIFrameSrc();
expect(iframeSrc).not.toContain('isLazyLoadingForEmbedEnabled=true');
expect(iframeSrc).not.toContain('isFullHeightPinboard=true');
}, 100); // 100ms wait time to ensure iframe src is set
});
test('should not set isLazyLoadingForEmbedEnabled when fullHeight is true but lazyLoadingForFullHeight is false', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: false,
});
// Wait for render to complete
await appEmbed.render();
// Wait for iframe initialization and URL parameters to be set
await executeAfterWait(() => {
const iframeSrc = getIFrameSrc();
expect(iframeSrc).not.toContain('isLazyLoadingForEmbedEnabled=true');
expect(iframeSrc).toContain('isFullHeightPinboard=true');
}, 100); // 100ms wait time to ensure iframe src is set
});
test('should register RequestFullHeightLazyLoadData event handler when fullHeight is enabled', async () => {
const onSpy = jest.spyOn(AppEmbed.prototype, 'on');
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
await appEmbed.render();
expect(onSpy).toHaveBeenCalledWith(EmbedEvent.RequestVisibleEmbedCoordinates, expect.any(Function));
onSpy.mockRestore();
});
test('should send correct visible data when RequestFullHeightLazyLoadData is triggered', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
const mockTrigger = jest.spyOn(appEmbed, 'trigger');
await appEmbed.render();
// Trigger the lazy load data calculation
appEmbed.sendFullHeightLazyLoadData();
expect(mockTrigger).toHaveBeenCalledWith(HostEvent.VisibleEmbedCoordinates, {
top: 0,
height: 500,
left: 0,
width: 650,
});
});
test('should calculate correct visible data for partially visible full height element', async () => {
// Mock iframe partially clipped from top and left
mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
top: -50,
left: -30,
bottom: 700,
right: 1024,
width: 1054,
height: 750,
});
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
const mockTrigger = jest.spyOn(appEmbed, 'trigger');
await appEmbed.render();
// Trigger the lazy load data calculation
appEmbed.sendFullHeightLazyLoadData();
expect(mockTrigger).toHaveBeenCalledWith(HostEvent.VisibleEmbedCoordinates, {
top: 50,
height: 700,
left: 30,
width: 1024, // visible width (from 0 to 1024)
});
});
test('should add window event listeners for resize and scroll when fullHeight and lazyLoadingForFullHeight are enabled', async () => {
const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
await appEmbed.render();
// Wait for the post-render events to be registered
await executeAfterWait(() => {
expect(addEventListenerSpy).toHaveBeenCalledWith('resize', expect.any(Function));
expect(addEventListenerSpy).toHaveBeenCalledWith('scroll', expect.any(Function), true);
}, 100);
addEventListenerSpy.mockRestore();
});
test('should remove window event listeners on destroy when fullHeight and lazyLoadingForFullHeight are enabled', async () => {
const removeEventListenerSpy = jest.spyOn(window, 'removeEventListener');
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
await appEmbed.render();
appEmbed.destroy();
expect(removeEventListenerSpy).toHaveBeenCalledWith('resize', expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith('scroll', expect.any(Function));
removeEventListenerSpy.mockRestore();
});
test('should handle RequestVisibleEmbedCoordinates event and respond with correct data', async () => {
// Mock the iframe element
mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
top: 100,
left: 150,
bottom: 600,
right: 800,
width: 650,
height: 500,
});
Object.defineProperty(mockIFrame, 'scrollHeight', { value: 500 });
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
lazyLoadingForFullHeight: true,
});
// Set the iframe before render
appEmbed.iFrame = mockIFrame;
await appEmbed.render();
// Create a mock responder function
const mockResponder = jest.fn();
// Trigger the handler directly
appEmbed.requestVisibleEmbedCoordinatesHandler({}, mockResponder);
// Verify the responder was called with the correct data
expect(mockResponder).toHaveBeenCalledWith({
type: EmbedEvent.RequestVisibleEmbedCoordinates,
data: {
top: 0,
height: 500,
left: 0,
width: 650,
},
});
});
});
describe('IFrame height management', () => {
let mockIFrame;
beforeEach(() => {
mockIFrame = document.createElement('iframe');
mockIFrame.getBoundingClientRect = jest.fn().mockReturnValue({
top: 100,
left: 150,
bottom: 600,
right: 800,
width: 650,
height: 500,
});
Object.defineProperty(mockIFrame, 'scrollHeight', { value: 500 });
});
test('should not call setIFrameHeight if currentPath starts with "/embed/viz/"', () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
const spySetIFrameHeight = jest.spyOn(appEmbed, 'setIFrameHeight');
appEmbed.render();
appEmbed.setIframeHeightForNonEmbedLiveboard({
data: { currentPath: '/embed/viz/' },
type: 'Route',
});
expect(spySetIFrameHeight).not.toHaveBeenCalled();
});
test('should not call setIFrameHeight if currentPath starts with "/embed/insights/viz/"', () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
const spySetIFrameHeight = jest.spyOn(appEmbed, 'setIFrameHeight');
appEmbed.render();
appEmbed.setIframeHeightForNonEmbedLiveboard({
data: { currentPath: '/embed/insights/viz/' },
type: 'Route',
});
expect(spySetIFrameHeight).not.toHaveBeenCalled();
});
test('should call setIFrameHeight if currentPath starts with "/some/other/path/"', () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
const spySetIFrameHeight = jest
.spyOn(appEmbed, 'setIFrameHeight')
.mockImplementation(jest.fn());
appEmbed.render();
appEmbed.setIframeHeightForNonEmbedLiveboard({
data: { currentPath: '/some/other/path/' },
type: 'Route',
});
expect(spySetIFrameHeight).toHaveBeenCalled();
});
test('should update iframe height correctly', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
// Set up the mock iframe
appEmbed.iFrame = mockIFrame;
document.body.appendChild(mockIFrame);
await appEmbed.render();
const mockEvent = {
data: 600,
type: EmbedEvent.EmbedHeight,
};
appEmbed.updateIFrameHeight(mockEvent);
// Check if the iframe style was updated
expect(mockIFrame.style.height).toBe('600px');
});
test('should handle updateIFrameHeight with default height', async () => {
const appEmbed = new AppEmbed(getRootEl(), {
...defaultViewConfig,
fullHeight: true,
});
// Set up the mock iframe
appEmbed.iFrame = mockIFrame;
document.body.appendChild(mockIFrame);
await appEmbed.render();
const mockEvent = {
data: 0,
type: EmbedEvent.EmbedHeight,
};
appEmbed.updateIFrameHeight(mockEvent);
// Should use the scrollHeight
expect(mockIFrame.style.height).toBe('500px');
});
});
});
//# sourceMappingURL=app.spec.js.map