Skip to content

Commit

Permalink
chore: adds automation for request templates component (#37140)
Browse files Browse the repository at this point in the history
## Description
This was done manually by QA team. This unit test ensures that a valid
URL is present for requesting template and is opens correctly.


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.Templates"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11592781616>
> Commit: 9a48f05
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11592781616&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Templates`
> Spec:
> <hr>Wed, 30 Oct 2024 12:27:43 UTC
<!-- end of auto-generated comment: Cypress test results  -->


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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a new test suite for the `RequestTemplate` component to
validate its behavior and user interactions.
- `REQUEST_TEMPLATE_URL` and `RequestTemplateProps` are now exported for
use in other modules.

- **Bug Fixes**
- Enhanced testing to ensure correct message display and button
functionality within the `RequestTemplate`.

- **Documentation**
	- Updated import statements for better organization and clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
rahulbarwal authored Nov 1, 2024
1 parent 72670ae commit f2c3125
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 7 deletions.
63 changes: 63 additions & 0 deletions app/client/src/pages/Templates/Template/RequestTemplate.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { createMessage } from "@appsmith/ads-old";
import "@testing-library/jest-dom";
import { fireEvent, render } from "@testing-library/react";
import {
REQUEST_BUILDING_BLOCK,
REQUEST_TEMPLATE,
} from "ee/constants/messages";
import AnalyticsUtil from "ee/utils/AnalyticsUtil";
import { unitTestBaseMockStore } from "layoutSystems/common/dropTarget/unitTestUtils";
import React from "react";
import { Provider } from "react-redux";
import configureStore from "redux-mock-store";
import { lightTheme } from "selectors/themeSelectors";
import { ThemeProvider } from "styled-components";
import RequestTemplate, {
REQUEST_TEMPLATE_URL,
type RequestTemplateProps,
} from "./RequestTemplate";
const mockStore = configureStore([]);

const BaseComponentRender = (
props: RequestTemplateProps,
storeToUse = unitTestBaseMockStore,
) => (
<Provider store={mockStore(storeToUse)}>
<ThemeProvider theme={lightTheme}>
<RequestTemplate {...props} />
</ThemeProvider>
</Provider>
);

describe("RequestTemplate", () => {
it("should display correct message based on isBuildingBlock prop", () => {
const { getByText } = render(
BaseComponentRender({ isBuildingBlock: true }),
);

expect(
getByText(createMessage(REQUEST_BUILDING_BLOCK)),
).toBeInTheDocument();
});
it("should open REQUEST_TEMPLATE_URL in a new window when button is clicked", () => {
const openSpy = jest.spyOn(window, "open");
const { getByText } = render(
BaseComponentRender({ isBuildingBlock: false }),
);
const button = getByText(createMessage(REQUEST_TEMPLATE));

fireEvent.click(button);
expect(openSpy).toHaveBeenCalledWith(REQUEST_TEMPLATE_URL);
});

it('should trigger AnalyticsUtil logEvent with "REQUEST_NEW_TEMPLATE" when button is clicked', () => {
const logEventSpy = jest.spyOn(AnalyticsUtil, "logEvent");
const { getByText } = render(
BaseComponentRender({ isBuildingBlock: false }),
);
const button = getByText(createMessage(REQUEST_TEMPLATE));

fireEvent.click(button);
expect(logEventSpy).toHaveBeenCalledWith("REQUEST_NEW_TEMPLATE");
});
});
14 changes: 7 additions & 7 deletions app/client/src/pages/Templates/Template/RequestTemplate.tsx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import React from "react";
import styled from "styled-components";
import { Text, TextType } from "@appsmith/ads-old";
import { Button } from "@appsmith/ads";
import { Text, TextType } from "@appsmith/ads-old";
import RequestTemplateSvg from "assets/images/request-template.svg";
import {
COULDNT_FIND_TEMPLATE,
createMessage,
COULDNT_FIND_TEMPLATE_DESCRIPTION,
REQUEST_TEMPLATE,
createMessage,
REQUEST_BUILDING_BLOCK,
REQUEST_TEMPLATE,
} from "ee/constants/messages";
import AnalyticsUtil from "ee/utils/AnalyticsUtil";
import React from "react";
import styled from "styled-components";

const Wrapper = styled.div`
border: 1px solid var(--ads-v2-color-border);
Expand Down Expand Up @@ -48,10 +48,10 @@ const StyledImage = styled.img`
border-radius: var(--ads-v2-border-radius);
`;

const REQUEST_TEMPLATE_URL =
export const REQUEST_TEMPLATE_URL =
"https://app.appsmith.com/app/request-templates/request-list-6241c12fc99df2369931a714";

interface RequestTemplateProps {
export interface RequestTemplateProps {
isBuildingBlock?: boolean;
}

Expand Down

0 comments on commit f2c3125

Please sign in to comment.