Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(MetaBlock): test for MetaBlock added #148

Merged
merged 2 commits into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions .mocks/post.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
"updatedAt": "2022-07-29T11:12:19.605Z"
}
],
"shareOptions": ["Telegram"],
"textTitle": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor",
"htmlTitle": "strong>Lorem ipsum dolor sit amet</strong> <a href=\"https://example.com\">consectetur</a> adipiscing elit"
}
9 changes: 5 additions & 4 deletions src/blocks/Meta/Meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {PostPageContext} from '../../contexts/PostPageContext';
import {MetaProps} from '../../models/blocks';
import {PaddingsDirections} from '../../models/paddings';
import {block} from '../../utils/cn';
import {getBreadcrumbs} from '../../utils/common';
import {getBreadcrumbs, getQaAttributes} from '../../utils/common';

import './Meta.scss';

Expand All @@ -32,9 +32,10 @@ const breadcrumbsGoals = [
];

export const Meta = (props: MetaProps) => {
const {paddingTop = 'l', paddingBottom = 'l', theme = 'light'} = props;
const {paddingTop = 'l', paddingBottom = 'l', theme = 'light', qa} = props;
const {post} = useContext(PostPageContext);
const {locale} = useContext(LocaleContext);
const qaAttributes = getQaAttributes(qa, 'post-info');
NikitaCG marked this conversation as resolved.
Show resolved Hide resolved

const {title, id, date, readingTime, tags} = post;

Expand All @@ -48,7 +49,7 @@ export const Meta = (props: MetaProps) => {
[PaddingsDirections.top]: paddingTop,
[PaddingsDirections.bottom]: paddingBottom,
}}
qa="blog-meta-content"
qa={qaAttributes.wrapper}
>
{breadcrumbs && (
<HeaderBreadcrumbs
Expand All @@ -73,7 +74,7 @@ export const Meta = (props: MetaProps) => {
date={date}
readingTime={readingTime}
metrikaGoals={metrikaGoals}
qa="blog-meta-block"
qa={qaAttributes.postInfo}
/>
)}
</Wrapper>
Expand Down
130 changes: 130 additions & 0 deletions src/blocks/Meta/__tests__/Meta.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
import React from 'react';

import {render, screen} from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import {PADDING_SIZES} from '../../../../test-utils/constants';
import {testPaddingBottom, testPaddingTop} from '../../../../test-utils/shared/common';
import {MetaProps} from '../../../models/blocks';
import {PaddingSize} from '../../../models/paddings';
import {getQaAttributes} from '../../../utils/common';
import {Meta} from '../Meta';
import {LikesRoutineType, PostPageContext} from '../../../contexts/PostPageContext';
import post from '../../../../.mocks/post.json';
import {PostData} from '../../../models/common';
import {LocaleContext} from '../../../contexts/LocaleContext';
import {Lang} from '../../../models/locale';
import {format} from '../../../utils/date';
import {Keyset, i18} from '../../../i18n';

const locale = {
code: 'en-En',
lang: Lang.En,
langName: 'English',
pathPrefix: 'en',
};

const metaProps = {
locale: 'en',
qa: 'meta-block',
};

const qaAttributes = getQaAttributes(metaProps.qa, 'post-info');
const likes: LikesRoutineType = {
handleUserLike: jest.fn(),
likesCount: 1,
hasUserLike: true,
};

const RenderComponent = (props: MetaProps) => {
return (
<LocaleContext.Provider value={{locale}}>
<PostPageContext.Provider
value={{post: post as unknown as PostData, suggestedPosts: [] as PostData[], likes}}
>
<Meta {...props} />
</PostPageContext.Provider>
</LocaleContext.Provider>
);
};

describe('Meta', () => {
test('render meta by default', async () => {
render(<RenderComponent {...metaProps} />);
const meta = screen.getByText(post.title);
expect(meta).toHaveClass('yfm_blog_breadcrumbs');
});

test('render with breadcrumbs', async () => {
render(<RenderComponent {...metaProps} />);
const blogBreadcrumb = screen.getByText('Blog');
const tagBreadcrumb = screen.getByText('Slug');
const titleBreadcrumb = screen.getByText(post.title);

expect(blogBreadcrumb).toHaveClass('pc-header-breadcrumbs__text');
expect(tagBreadcrumb).toHaveClass('pc-header-breadcrumbs__text');
expect(titleBreadcrumb).toHaveClass('yfm_blog_breadcrumbs');
});

test('render with date', async () => {
const qaAttr = getQaAttributes(qaAttributes.postInfo, 'date');

render(<RenderComponent {...metaProps} />);
const blogBreadcrumb = screen.getByTestId(qaAttr.date);

expect(blogBreadcrumb).toHaveTextContent(format(post.date, 'longDate', metaProps.locale));
});

test('render with reading time', async () => {
const qaAttr = getQaAttributes(qaAttributes.postInfo, 'reading-time');

render(<RenderComponent {...metaProps} />);
const blogBreadcrumb = screen.getByTestId(qaAttr.readingTime);

expect(blogBreadcrumb).toHaveTextContent(
i18(Keyset.ContextReadingTime, {count: post.readingTime}),
);
});

test('render with share menu', async () => {
render(<RenderComponent {...metaProps} />);
const user = userEvent.setup();
const shareComponent = screen.getByText('Share');
await user.click(shareComponent);

const shareOption = screen.getByText('Copy link');

expect(shareOption).toBeVisible();
});

test('render with likes', async () => {
const qaAttr = getQaAttributes(qaAttributes.postInfo, 'save');

render(<RenderComponent {...metaProps} />);

const component = screen.getByTestId(qaAttr.save);

expect(component).toHaveTextContent(likes.likesCount.toString());
});

test.each(new Array<PaddingSize>(...PADDING_SIZES))(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we combine last two cases?

'render with given "%s" paddingTop size',
(size: PaddingSize) => {
testPaddingTop<MetaProps>({
component: RenderComponent,
props: {...metaProps, paddingTop: size},
options: {qaId: qaAttributes.wrapper},
});
},
);

test.each(new Array<PaddingSize>(...PADDING_SIZES))(
'render with given "%s" paddingBottom size',
(size: PaddingSize) => {
testPaddingBottom<MetaProps>({
component: RenderComponent,
props: {...metaProps, paddingBottom: size},
options: {qaId: qaAttributes.wrapper},
});
},
);
});
8 changes: 5 additions & 3 deletions src/components/PostInfo/PostInfo.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {Date} from './components/Date';
import {ReadingTime} from './components/ReadingTime';
import {Save} from './components/Save';
import {Sharing} from './components/Sharing';
import {getQaAttributes} from '../../utils/common';

import './PostInfo.scss';

Expand Down Expand Up @@ -50,11 +51,12 @@ export const PostInfo = ({
qa,
}: PostInfoProps) => {
const {likes} = useContext(PostPageContext);
const qaAttributes = getQaAttributes(qa, 'date', 'reading-time', 'save');
NikitaCG marked this conversation as resolved.
Show resolved Hide resolved

return (
<div className={b('container', {theme})}>
{date && <Date date={date} />}
{readingTime && <ReadingTime readingTime={readingTime} />}
{date && <Date date={date} qa={qaAttributes.date} />}
{readingTime && <ReadingTime readingTime={readingTime} qa={qaAttributes.readingTime} />}
<Sharing metrikaGoal={metrikaGoals?.sharing} theme={theme} />
{likes && (
<Save
Expand All @@ -64,7 +66,7 @@ export const PostInfo = ({
handleUserLike={likes.handleUserLike}
metrikaGoal={metrikaGoals?.save}
theme={theme}
qa={qa}
qa={qaAttributes.save}
/>
)}
</div>
Expand Down
8 changes: 4 additions & 4 deletions src/components/PostInfo/components/Date.tsx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
import React, {useContext} from 'react';

import {LocaleContext} from '../../../contexts/LocaleContext';
import {PostCardSize} from '../../../models/common';
import {PostCardSize, QAProps} from '../../../models/common';
import {block} from '../../../utils/cn';
import {format} from '../../../utils/date';

import '../PostInfo.scss';

const b = block('post-info');

type DateProps = {
type DateProps = QAProps & {
date: string | number;
size?: PostCardSize;
id?: string;
};

export const Date = ({date, size = PostCardSize.SMALL, id}: DateProps) => {
export const Date = ({date, size = PostCardSize.SMALL, id, qa}: DateProps) => {
const {locale} = useContext(LocaleContext);

return (
<div className={b('item', {size})} id={id}>
<div className={b('item', {size})} id={id} data-qa={qa}>
{format(date, 'longDate', locale?.code)}
</div>
);
Expand Down
7 changes: 4 additions & 3 deletions src/components/PostInfo/components/ReadingTime.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,21 @@ import {Keyset, i18} from '../../../i18n';
import {Time} from '../../../icons/Time';
import {block} from '../../../utils/cn';

import {QAProps} from '../../../models/common';
import '../PostInfo.scss';

const b = block('post-info');

const ICON_SIZE = 16;

type ReadingTimeProps = {
type ReadingTimeProps = QAProps & {
readingTime: number;
size?: 's' | 'm';
id?: string;
};

export const ReadingTime = ({readingTime, size = 's', id}: ReadingTimeProps) => (
<div className={b('item', {size})} id={id}>
export const ReadingTime = ({readingTime, size = 's', id, qa}: ReadingTimeProps) => (
<div className={b('item', {size})} id={id} data-qa={qa}>
<span className={b('icon')}>
<Icon data={Time} size={ICON_SIZE} className={b('icon-color')} />
</span>
Expand Down
2 changes: 1 addition & 1 deletion src/components/PostInfo/components/Save.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export const Save = ({
metrika.reachGoal(MetrikaCounter.CrossSite, metrikaGoal);
handleAnalytics();
}}
data-qa={`${qa ? qa + '-' : ''}save`}
data-qa={qa}
>
<div className={b('content', {cursor: isLikeable, theme})}>
<span className={b('icon')}>
Expand Down
12 changes: 7 additions & 5 deletions src/contexts/PostPageContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ import {ShareOptions} from '@gravity-ui/components';

import {PostData} from '../models/common';

export type LikesRoutineType = {
handleUserLike: () => void;
hasUserLike: boolean;
likesCount: number;
};

export interface PostPageContextProps {
post: PostData;
suggestedPosts: PostData[];
likes?: {
handleUserLike: () => void;
hasUserLike: boolean;
likesCount: number;
};
likes?: LikesRoutineType;
shareOptions?: ShareOptions[];
}

Expand Down
2 changes: 1 addition & 1 deletion src/models/blocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export type MediaProps = ClassNameProps &
text?: string;
};

export type MetaProps = {
export type MetaProps = QAProps & {
locale: string;
theme?: TextTheme;
} & PaddingsYFMProps;
Expand Down
Loading