PromucFlow_constructor/app/client/src/utils/CustomWidgetBuilderService.test.ts
Ilia d6f249b42d
chore: add blank line eslint rule (#36369)
## Description
Added ESLint rule to force blank lines between statements. 


Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]
> 🔴 🔴 🔴 Some tests have failed.
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10924926728>
> Commit: 34f57714a1575ee04e94e03cbcaf95e57a96c86c
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10924926728&attempt=1&selectiontype=test&testsstatus=failed&specsstatus=fail"
target="_blank">Cypress dashboard</a>.
> Tags: @tag.All
> Spec: 
> The following are new failures, please fix them before merging the PR:
<ol>
> <li>cypress/e2e/Regression/ClientSide/Anvil/AnvilModal_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilButtonWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilCheckboxGroupWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilCurrencyInputWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilIconButtonWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilInlineButtonWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilInputWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilParagraphWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilPhoneInputWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilStatsWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilSwitchGroupWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilSwitchWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilTableWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilToolbarButtonWidgetSnapshot_spec.ts
>
<li>cypress/e2e/Regression/ClientSide/Anvil/Widgets/AnvilZoneSectionWidgetSnapshot_spec.ts</ol>
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/identified-flaky-tests-65890b3c81d7400d08fa9ee3?branch=master"
target="_blank">List of identified flaky tests</a>.
> <hr>Wed, 18 Sep 2024 16:33:36 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No

---------

Co-authored-by: Valera Melnikov <valera@appsmith.com>
2024-09-18 19:35:28 +03:00

214 lines
5.2 KiB
TypeScript

import CustomWidgetBuilderService, {
Builder,
} from "./CustomWidgetBuilderService";
const onMessage = jest.fn();
const postMessage = jest.fn();
const isConnected = jest.fn();
const focus = jest.fn();
const close = jest.fn();
const mockBuilder = jest.fn().mockImplementation(() => {
return {
onMessage,
postMessage,
isConnected,
focus,
close,
};
});
describe("CustomWidgetBuilderService - ", () => {
beforeAll(() => {
CustomWidgetBuilderService.setBuilderFactory(mockBuilder);
});
describe("createBuilder", () => {
it("should test that its creating a builder", () => {
const widgetId = "123";
const builder = CustomWidgetBuilderService.createBuilder(widgetId);
expect(builder).toBeDefined();
expect(mockBuilder).toHaveBeenCalled();
});
});
describe("isConnected", () => {
it("should test that its checking if the builder is connected", () => {
const widgetId = "123";
CustomWidgetBuilderService.createBuilder(widgetId);
isConnected.mockReturnValue(false);
expect(CustomWidgetBuilderService.isConnected(widgetId)).toBeFalsy();
isConnected.mockReturnValue(true);
expect(CustomWidgetBuilderService.isConnected(widgetId)).toBeTruthy();
});
});
describe("focus", () => {
it("should test that its focusing the builder", () => {
const widgetId = "123";
CustomWidgetBuilderService.createBuilder(widgetId);
CustomWidgetBuilderService.focus(widgetId);
expect(focus).toHaveBeenCalled();
});
});
describe("closeBuilder", () => {
it("should test that its closing the builder", () => {
const widgetId = "123";
CustomWidgetBuilderService.createBuilder(widgetId);
expect(CustomWidgetBuilderService.getBuilder(widgetId)).toBeDefined();
CustomWidgetBuilderService.closeBuilder(widgetId, true);
expect(close).toHaveBeenCalled();
expect(CustomWidgetBuilderService.getBuilder(widgetId)).not.toBeDefined();
});
});
});
describe("Builder - ", () => {
let builder: Builder;
let closed = false;
const closeWindow = jest.fn().mockImplementation(() => {
if (builder?.builderWindow) {
// TODO: Fix this the next time the file is edited
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(builder.builderWindow as any).closed = true;
}
});
const focus = jest.fn();
const open = jest.fn().mockImplementation(() => {
closed = false;
return { postMessage, close: closeWindow, closed, focus };
});
const addEventListener = jest.fn();
const removeEventListener = jest.fn();
beforeAll(() => {
window.open = open;
window.addEventListener = addEventListener;
window.removeEventListener = removeEventListener;
});
describe("constructor", () => {
it("should test that its creating a builder", () => {
builder = new Builder();
expect(builder).toBeDefined();
expect(open).toHaveBeenCalled();
expect(addEventListener).toHaveBeenCalled();
});
});
describe("onMessage", () => {
it("should test that its adding a message listener", () => {
const type = "READY";
const callback = jest.fn();
const callback2 = jest.fn();
const cancel = builder.onMessage(type, callback);
const listener = builder.onMessageMap.get(type);
expect(listener).toBeDefined();
expect(listener?.length).toBe(1);
expect(listener?.[0]).toEqual(callback);
const cancel2 = builder.onMessage(type, callback2);
expect(listener?.length).toBe(2);
expect(listener?.[1]).toEqual(callback2);
cancel();
expect(listener?.length).toBe(1);
expect(listener?.[0]).toEqual(callback2);
cancel2();
expect(listener?.length).toBe(0);
});
});
describe("postMessage", () => {
it("should test that its posting a message", () => {
const message = "Hello World";
builder.postMessage(message);
expect(postMessage).toHaveBeenCalledWith(message, "*");
});
});
describe("isConnected", () => {
it("should test that its checking if the builder is connected", () => {
expect(builder.isConnected()).toBeTruthy();
builder.close(true);
expect(builder.isConnected()).toBeFalsy();
});
});
describe("focus", () => {
it("should test that its focusing the builder", () => {
builder.focus();
expect(focus).toHaveBeenCalled();
});
});
describe("close", () => {
it("should test that its closing the builder", () => {
let handler;
window.addEventListener = ((type: string, fn: () => void) => {
handler = fn;
}) as typeof window.addEventListener;
const builder = new Builder();
builder.close(true);
expect(closeWindow).toHaveBeenCalled();
expect(removeEventListener).toHaveBeenCalledWith("message", handler);
});
it("should test that its not closing the builder when false is passed to close function", () => {
closeWindow.mockClear();
removeEventListener.mockClear();
const builder = new Builder();
builder.close(false);
expect(closeWindow).not.toHaveBeenCalled();
expect(removeEventListener).toHaveBeenCalled();
});
});
});