Files
frontend-app-discussions/src/discussions/posts/PostsView.test.jsx
Kshitij Sobti d802e5331f fix: filtering by post type wasn't working [BD-38] [TNL-9609] (#82)
Fixes an issue where filtering by post type wasn't working, since the filter wasn't being passed to the API.
It also simplifies the code a bit and adds tests.
2022-03-14 05:36:28 +00:00

254 lines
7.5 KiB
JavaScript

import React from 'react';
import { fireEvent, render, screen } from '@testing-library/react';
import MockAdapter from 'axios-mock-adapter';
import { act } from 'react-dom/test-utils';
import { IntlProvider } from 'react-intl';
import {
generatePath, MemoryRouter, Route, Switch,
} from 'react-router';
import { Factory } from 'rosie';
import { initializeMockApp } from '@edx/frontend-platform';
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
import { AppProvider } from '@edx/frontend-platform/react';
import { Routes, ThreadType } from '../../data/constants';
import { initializeStore } from '../../store';
import { DiscussionContext } from '../common/context';
import { threadsApiUrl } from './data/api';
import { PostsView } from './index';
import './data/__factories__';
const courseId = 'course-v1:edX+TestX+Test_Course';
let store;
let axiosMock;
async function renderComponent({
postId, topicId, category, myPosts,
} = { myPosts: false }) {
let path = generatePath(Routes.POSTS.ALL_POSTS, { courseId });
let showOwnPosts = false;
if (postId) {
path = generatePath(Routes.POSTS.ALL_POSTS, { courseId, postId });
} else if (topicId) {
path = generatePath(Routes.POSTS.PATH, { courseId, topicId });
} else if (category) {
path = generatePath(Routes.TOPICS.CATEGORY, { courseId, category });
} else if (myPosts) {
path = generatePath(Routes.POSTS.MY_POSTS, { courseId });
showOwnPosts = myPosts;
}
await render(
<IntlProvider locale="en">
<AppProvider store={store}>
<MemoryRouter initialEntries={[path]}>
<DiscussionContext.Provider value={{
courseId,
postId,
topicId,
category,
}}
>
<Switch>
<Route path={Routes.POSTS.MY_POSTS}>
<PostsView showOwnPosts={showOwnPosts} />
</Route>
<Route
path={[Routes.POSTS.PATH, Routes.POSTS.ALL_POSTS, Routes.TOPICS.CATEGORY]}
component={PostsView}
/>
</Switch>
</DiscussionContext.Provider>
</MemoryRouter>
</AppProvider>
</IntlProvider>,
);
}
describe('PostsView', () => {
const threadCount = 6;
beforeEach(async () => {
initializeMockApp({
authenticatedUser: {
userId: 3,
username: 'abc123',
administrator: true,
roles: [],
},
});
store = initializeStore({
blocks: { blocks: { 'test-usage-key': { topics: ['some-topic-2', 'some-topic-0'] } } },
});
Factory.resetAll();
axiosMock = new MockAdapter(getAuthenticatedHttpClient());
axiosMock.onGet(threadsApiUrl)
.reply((args) => {
const threadAttrs = {};
if (args.params.author) {
threadAttrs.author = args.params.author;
}
return [200, Factory.build('threadsResult', {}, {
topicId: undefined,
count: threadCount,
threadAttrs,
pageSize: 6,
})];
});
});
describe('Basic', () => {
test('displays a list of all posts', async () => {
await act(async () => {
await renderComponent();
});
expect(screen.getAllByText(/this is thread-\d+/i)).toHaveLength(threadCount);
});
test('displays a list of user posts', async () => {
await act(async () => {
await renderComponent({ myPosts: true });
});
expect(screen.getAllByText('abc123')).toHaveLength(threadCount);
});
test('displays a list of posts in a topic', async () => {
await act(async () => {
await renderComponent({ topicId: 'some-topic-1' });
});
expect(screen.getAllByText(/this is thread-\d+ in topic some-topic-1/i)).toHaveLength(Math.ceil(threadCount / 3));
});
test('displays a list of posts in a category', async () => {
await act(async () => {
await renderComponent({ category: 'test-usage-key' });
});
expect(screen.queryAllByText(/this is thread-\d+ in topic some-topic-1}/i)).toHaveLength(0);
expect(screen.queryAllByText(/this is thread-\d+ in topic some-topic-2/i)).toHaveLength(Math.ceil(threadCount / 3));
expect(screen.queryAllByText(/this is thread-\d+ in topic some-topic-0/i)).toHaveLength(Math.ceil(threadCount / 3));
});
});
describe('Filtering', () => {
let dropDownButton;
function lastQueryParams() {
const { params } = axiosMock.history.get[axiosMock.history.get.length - 1];
return params;
}
beforeEach(async () => {
await act(async () => {
await renderComponent();
});
dropDownButton = screen.getByRole('button', {
name: /all posts by recent activity/i,
});
await act(async () => {
fireEvent.click(dropDownButton);
});
});
test('test that the filter bar works', async () => {
// 3 type filters: all, discussion, question
// 5 status filters: any, unread, following, reported, unanswered
// 3 sort: activity, comments, votes
expect(screen.queryAllByRole('radio')).toHaveLength(11);
});
describe.each([
{
label: 'Discussions',
queryParam: { thread_type: ThreadType.DISCUSSION },
},
{
label: 'Questions',
queryParam: { thread_type: ThreadType.QUESTION },
},
{
label: 'Unread',
queryParam: { view: 'unread' },
},
{
label: 'Unanswered',
queryParam: { view: 'unanswered' },
},
{
label: 'Following',
queryParam: { following: true },
},
{
label: 'Reported',
queryParam: { flagged: true },
},
{
label: 'Most activity',
queryParam: { order_by: 'comment_count' },
},
{
label: 'Most votes',
queryParam: { order_by: 'vote_count' },
},
])(
'one at a time',
({
label,
queryParam,
}) => {
test(`select "${label}"`, async () => {
await act(async () => {
fireEvent.click(screen.getByLabelText(label));
});
// Assert that changing the filters results in the correct query
expect(lastQueryParams()).toMatchObject(queryParam);
});
},
);
describe.each([
{
firstClick: 'Discussions',
secondClick: 'Unanswered',
selected: ['Questions', 'Unanswered'],
},
{
firstClick: 'Unanswered',
secondClick: 'Discussions',
selected: ['Discussions', 'Any'],
},
{
firstClick: 'Questions',
secondClick: 'Unread',
selected: ['Discussions', 'Unread'],
},
{
firstClick: 'Unread',
secondClick: 'Questions',
selected: ['Questions', 'Any'],
},
])(
'incompatible combinations',
({
firstClick,
secondClick,
selected,
}) => {
test(`select "${firstClick}" then "${secondClick}"`, async () => {
await act(async () => {
fireEvent.click(screen.getByLabelText(firstClick));
});
await act(async () => {
fireEvent.click(dropDownButton);
});
await act(async () => {
fireEvent.click(screen.getByLabelText(secondClick));
});
await act(async () => {
fireEvent.click(dropDownButton);
});
expect(screen.getAllByTestId('selected')[0]).toHaveTextContent(selected[0]);
expect(screen.getAllByTestId('selected')[1]).toHaveTextContent(selected[1]);
});
},
);
});
});