-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DEVPROD-5303: Track sectioning analytics (#328)
- Loading branch information
Showing
13 changed files
with
263 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
apps/parsley/src/components/LogRow/SectionHeader/SubsectionControls.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import * as analytics from "analytics"; | ||
| import { SectionStatus } from "constants/logs"; | ||
| import * as logContext from "context/LogContext"; | ||
| import { logContextWrapper } from "context/LogContext/test_utils"; | ||
| import { RenderFakeToastContext as InitializeFakeToastContext } from "context/toast/__mocks__"; | ||
| import { | ||
| sectionStateAllClosed, | ||
| sectionStateAllOpen, | ||
| sectionStateSomeOpen, | ||
| } from "hooks/useSections/testData"; | ||
| import { renderWithRouterMatch, screen, userEvent, waitFor } from "test_utils"; | ||
| import { SubsectionControls } from "./SubsectionControls"; | ||
|
|
||
| const wrapper = logContextWrapper(); | ||
|
|
||
| describe("SectionControls", () => { | ||
| beforeEach(() => { | ||
| InitializeFakeToastContext(); | ||
| }); | ||
|
|
||
| it("Should not render 'Open subsections' when all subsections belonging to the function are open", () => { | ||
| const mockedLogContext = vi.spyOn(logContext, "useLogContext"); | ||
| mockedLogContext.mockImplementation(() => ({ | ||
| // @ts-expect-error - Only mocking a subset of useLogContext needed for this test | ||
| sectioning: { | ||
| sectionState: sectionStateAllOpen, | ||
| sectioningEnabled: true, | ||
| toggleAllSections: vi.fn(), | ||
| }, | ||
| })); | ||
| renderWithRouterMatch(<SubsectionControls {...props} />, { wrapper }); | ||
| expect(screen.queryByText("Open subsections")).toBeNull(); | ||
| expect(screen.queryByText("Close subsections")).toBeVisible(); | ||
| }); | ||
| it("Should not render 'Close subsections' when all subsections belonging to the function are closed", () => { | ||
| const mockedLogContext = vi.spyOn(logContext, "useLogContext"); | ||
| mockedLogContext.mockImplementation(() => ({ | ||
| // @ts-expect-error - Only mocking a subset of useLogContext needed for this test. | ||
| sectioning: { | ||
| sectionState: sectionStateAllClosed, | ||
| sectioningEnabled: true, | ||
| toggleAllCommandsInFunction: vi.fn(), | ||
| }, | ||
| })); | ||
| renderWithRouterMatch(<SubsectionControls {...props} />, { wrapper }); | ||
| expect(screen.queryByText("Open subsections")).toBeVisible(); | ||
| expect(screen.queryByText("Close subsections")).toBeNull(); | ||
| }); | ||
| it("Should render 'Open subsections' and 'Close subsections' buttons when some sections are open and some are closed", () => { | ||
| const mockedLogContext = vi.spyOn(logContext, "useLogContext"); | ||
| mockedLogContext.mockImplementation(() => ({ | ||
| // @ts-expect-error - Only mocking a subset of useLogContext needed for this test. | ||
| sectioning: { | ||
| sectionState: sectionStateSomeOpen, | ||
| sectioningEnabled: true, | ||
| toggleAllCommandsInFunction: vi.fn(), | ||
| }, | ||
| })); | ||
| renderWithRouterMatch(<SubsectionControls {...props} />, { wrapper }); | ||
| expect(screen.queryByText("Open subsections")).toBeVisible(); | ||
| expect(screen.queryByText("Close subsections")).toBeVisible(); | ||
| }); | ||
|
|
||
| it("Clicking on buttons calls 'toggleAllCommandsInFunction' with correct parameters and sends analytics events", async () => { | ||
| const user = userEvent.setup(); | ||
| const mockedLogContext = vi.spyOn(logContext, "useLogContext"); | ||
| const mockedAnalytics = vi.spyOn(analytics, "useLogWindowAnalytics"); | ||
| const sendEventMock = vi.fn(); | ||
| mockedAnalytics.mockImplementation(() => ({ | ||
| sendEvent: sendEventMock, | ||
| })); | ||
| const toggleAllCommandsInFunctionMock = vi.fn(); | ||
| mockedLogContext.mockImplementation(() => ({ | ||
| // @ts-expect-error - Only mocking a subset of useLogContext needed for this test. | ||
| sectioning: { | ||
| sectionState: sectionStateSomeOpen, | ||
| sectioningEnabled: true, | ||
| toggleAllCommandsInFunction: toggleAllCommandsInFunctionMock, | ||
| }, | ||
| })); | ||
| renderWithRouterMatch(<SubsectionControls {...props} />, { wrapper }); | ||
| expect(screen.getByDataCy("open-subsections-btn")).toBeVisible(); | ||
| await user.click(screen.getByDataCy("open-subsections-btn")); | ||
| expect(sendEventMock).toHaveBeenCalledOnce(); | ||
| expect(sendEventMock).toHaveBeenCalledWith({ | ||
| "function.name": "funcName", | ||
| "function.status": "pass", | ||
| name: "Clicked open subsections button", | ||
| "was.function.closed": false, | ||
| }); | ||
| expect(toggleAllCommandsInFunctionMock).toHaveBeenCalledOnce(); | ||
| expect(toggleAllCommandsInFunctionMock).toHaveBeenCalledWith( | ||
| "function-1", | ||
| true, | ||
| ); | ||
| await user.click(screen.getByDataCy("close-subsections-btn")); | ||
| await waitFor(() => | ||
| expect(toggleAllCommandsInFunctionMock).toHaveBeenCalledWith( | ||
| "function-1", | ||
| false, | ||
| ), | ||
| ); | ||
| expect(sendEventMock).toHaveBeenCalledTimes(2); | ||
| expect(sendEventMock).toHaveBeenCalledWith({ | ||
| "function.name": "funcName", | ||
| "function.status": "pass", | ||
| name: "Clicked close subsections button", | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| const props = { | ||
| functionID: "function-1", | ||
| functionName: "funcName", | ||
| status: SectionStatus.Pass, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.