Skip to content

Commit 84a7531

Browse files
nsprenklensprenkle
authored
Split SearchControls into separate component (#174)
* Split SearchControls into separate component * Add testing config * Add webpack config * Add snapshot tests for Search Controls * bump version and update package-lock format
1 parent 2729644 commit 84a7531

File tree

10 files changed

+43263
-2467
lines changed

10 files changed

+43263
-2467
lines changed

‎jest.config.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
const { createConfig } = require('@edx/frontend-build');
2+
3+
module.exports = createConfig('jest', {
4+
setupFilesAfterEnv: [
5+
'<rootDir>/src/setupTest.js',
6+
],
7+
modulePaths: ['<rootDir>/src/'],
8+
snapshotSerializers: [
9+
'enzyme-to-json/serializer',
10+
],
11+
});

‎package-lock.json

Lines changed: 42945 additions & 2436 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@edx/frontend-app-gradebook",
3-
"version": "1.4.20",
3+
"version": "1.4.21",
44
"description": "edx editable gradebook-ui to manipulate grade overrides on subsections",
55
"repository": {
66
"type": "git",
@@ -38,6 +38,7 @@
3838
"classnames": "^2.2.6",
3939
"core-js": "3.6.5",
4040
"email-prop-type": "^1.1.7",
41+
"enzyme-to-json": "^3.6.2",
4142
"font-awesome": "4.7.0",
4243
"history": "4.10.1",
4344
"node-sass": "^4.14.1",
@@ -69,6 +70,7 @@
6970
"fetch-mock": "^6.5.2",
7071
"husky": "2.7.0",
7172
"identity-obj-proxy": "^3.0.0",
73+
"jest": "24.9.0",
7274
"react-dev-utils": "^5.0.3",
7375
"react-test-renderer": "^16.10.1",
7476
"redux-mock-store": "^1.5.3",

‎src/components/Gradebook/SearchControls.jsx

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
import React from 'react';
2+
import PropTypes from 'prop-types';
3+
import { connect } from 'react-redux';
4+
5+
import { Button, Icon, SearchField } from '@edx/paragon';
6+
7+
import {
8+
fetchGrades,
9+
fetchMatchingUserGrades,
10+
} from '../../data/actions/grades';
11+
12+
/**
13+
* Controls for filtering the GradebookTable. Contains the "Edit Filters" button for opening the filter drawer
14+
* as well as the search box for searching by username/email.
15+
*/
16+
export class SearchControls extends React.Component {
17+
constructor(props) {
18+
super(props);
19+
this.onSubmit = this.onSubmit.bind(this);
20+
this.onChange = this.onChange.bind(this);
21+
this.onClear = this.onClear.bind(this);
22+
}
23+
24+
/** Submitting searches for user matching the username/email in `value` */
25+
onSubmit(value) {
26+
this.props.searchForUser(
27+
this.props.courseId,
28+
value,
29+
this.props.selectedCohort,
30+
this.props.selectedTrack,
31+
this.props.selectedAssignmentType,
32+
);
33+
}
34+
35+
/** Changing the search value stores the key in Gradebook. Currently unused */
36+
onChange(filterValue) {
37+
this.props.setFilterValue(filterValue);
38+
}
39+
40+
/** Clearing the search box falls back to showing students with already applied filters */
41+
onClear() {
42+
this.props.getUserGrades(
43+
this.props.courseId,
44+
this.props.selectedCohort,
45+
this.props.selectedTrack,
46+
this.props.selectedAssignmentType,
47+
);
48+
}
49+
50+
render() {
51+
return (
52+
<>
53+
<h4>Step 1: Filter the Grade Report</h4>
54+
<div className="d-flex justify-content-between">
55+
<Button
56+
id="edit-filters-btn"
57+
className="btn-primary align-self-start"
58+
onClick={this.props.toggleFilterDrawer}
59+
>
60+
<Icon className="fa fa-filter" /> Edit Filters
61+
</Button>
62+
<div>
63+
<SearchField
64+
onSubmit={this.onSubmit}
65+
inputLabel="Search for a learner"
66+
onChange={this.onChange}
67+
onClear={this.onClear}
68+
value={this.props.filterValue}
69+
/>
70+
<small className="form-text text-muted search-help-text">Search by username, email, or student key</small>
71+
</div>
72+
</div>
73+
</>
74+
);
75+
}
76+
}
77+
78+
SearchControls.defaultProps = {
79+
courseId: '',
80+
filterValue: '',
81+
selectedAssignmentType: '',
82+
selectedCohort: null,
83+
selectedTrack: null,
84+
};
85+
86+
SearchControls.propTypes = {
87+
courseId: PropTypes.string,
88+
filterValue: PropTypes.string,
89+
setFilterValue: PropTypes.func.isRequired,
90+
toggleFilterDrawer: PropTypes.func.isRequired,
91+
// From Redux
92+
getUserGrades: PropTypes.func.isRequired,
93+
searchForUser: PropTypes.func.isRequired,
94+
selectedAssignmentType: PropTypes.string,
95+
selectedCohort: PropTypes.string,
96+
selectedTrack: PropTypes.string,
97+
};
98+
99+
export const mapStateToProps = (state) => ({
100+
selectedAssignmentType: state.filters.assignmentType,
101+
selectedTrack: state.filters.track,
102+
selectedCohort: state.filters.cohort,
103+
});
104+
105+
export const mapDispatchToProps = {
106+
getUserGrades: fetchGrades,
107+
searchForUser: fetchMatchingUserGrades,
108+
};
109+
110+
export default connect(mapStateToProps, mapDispatchToProps)(SearchControls);

‎src/components/Gradebook/SearchControls.test.jsx

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
import React from 'react';
2+
import { shallow } from 'enzyme';
3+
4+
import {
5+
fetchGrades,
6+
fetchMatchingUserGrades,
7+
} from '../../data/actions/grades';
8+
import { mapDispatchToProps, mapStateToProps, SearchControls } from './SearchControls';
9+
10+
jest.mock('@edx/paragon', () => ({
11+
Icon: 'Icon',
12+
Button: 'Button',
13+
SearchField: 'SearchField',
14+
}));
15+
16+
describe('SearchControls', () => {
17+
let props;
18+
19+
beforeEach(() => {
20+
jest.resetAllMocks();
21+
props = {
22+
courseId: 'course-v1:edX+DEV101+T1',
23+
filterValue: 'alice',
24+
selectedAssignmentType: 'homework',
25+
selectedCohort: 'spring term',
26+
selectedTrack: 'masters',
27+
getUserGrades: jest.fn(),
28+
searchForUser: jest.fn(),
29+
setFilterValue: jest.fn(),
30+
toggleFilterDrawer: jest.fn().mockName('toggleFilterDrawer'),
31+
};
32+
});
33+
34+
const searchControls = (overriddenProps) => {
35+
props = { ...props, ...overriddenProps };
36+
return shallow(<SearchControls {...props} />);
37+
};
38+
39+
describe('Component', () => {
40+
describe('onSubmit', () => {
41+
it('calls props.searchForUser with correct data', () => {
42+
const wrapper = searchControls();
43+
wrapper.instance().onSubmit('bob');
44+
45+
expect(props.searchForUser).toHaveBeenCalledWith(
46+
props.courseId,
47+
'bob',
48+
props.selectedCohort,
49+
props.selectedTrack,
50+
props.selectedAssignmentType,
51+
);
52+
});
53+
});
54+
55+
describe('onChange', () => {
56+
it('saves the changed search value to Gradebook state', () => {
57+
const wrapper = searchControls();
58+
wrapper.instance().onChange('bob');
59+
expect(props.setFilterValue).toHaveBeenCalledWith('bob');
60+
});
61+
});
62+
63+
describe('onClear', () => {
64+
it('re-runs search with existing filters', () => {
65+
const wrapper = searchControls();
66+
wrapper.instance().onClear();
67+
expect(props.getUserGrades).toHaveBeenCalledWith(
68+
props.courseId,
69+
props.selectedCohort,
70+
props.selectedTrack,
71+
props.selectedAssignmentType,
72+
);
73+
});
74+
});
75+
76+
describe('mapStateToProps', () => {
77+
const state = {
78+
filters: {
79+
assignmentType: 'labs',
80+
track: 'honor',
81+
cohort: 'fall term',
82+
},
83+
};
84+
85+
it('maps assignment type filter correctly', () => {
86+
expect(mapStateToProps(state).selectedAssignmentType).toEqual(state.filters.assignmentType);
87+
});
88+
89+
it('maps track filter correctly', () => {
90+
expect(mapStateToProps(state).selectedTrack).toEqual(state.filters.track);
91+
});
92+
93+
it('maps cohort filter correctly', () => {
94+
expect(mapStateToProps(state).selectedCohort).toEqual(state.filters.cohort);
95+
});
96+
});
97+
98+
describe('mapDispatchToProps', () => {
99+
test('getUserGrades', () => {
100+
expect(mapDispatchToProps.getUserGrades).toEqual(fetchGrades);
101+
});
102+
103+
test('searchForUser', () => {
104+
expect(mapDispatchToProps.searchForUser).toEqual(fetchMatchingUserGrades);
105+
});
106+
});
107+
108+
describe('Snapshots', () => {
109+
test('basic snapshot', () => {
110+
const wrapper = searchControls();
111+
wrapper.instance().onChange = jest.fn().mockName('onChange');
112+
wrapper.instance().onClear = jest.fn().mockName('onClear');
113+
wrapper.instance().onSubmit = jest.fn().mockName('onSubmit');
114+
expect(wrapper.instance().render()).toMatchSnapshot();
115+
});
116+
});
117+
});
118+
});

‎src/components/Gradebook/__snapshots__/SearchControls.test.jsx.snap

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// Jest Snapshot v1, https://goo.gl/fbAQLP
2+
3+
exports[`SearchControls Component Snapshots basic snapshot 1`] = `
4+
<React.Fragment>
5+
<h4>
6+
Step 1: Filter the Grade Report
7+
</h4>
8+
<div
9+
className="d-flex justify-content-between"
10+
>
11+
<Button
12+
className="btn-primary align-self-start"
13+
id="edit-filters-btn"
14+
onClick={[MockFunction toggleFilterDrawer]}
15+
>
16+
<Icon
17+
className="fa fa-filter"
18+
/>
19+
Edit Filters
20+
</Button>
21+
<div>
22+
<SearchField
23+
inputLabel="Search for a learner"
24+
onChange={[MockFunction onChange]}
25+
onClear={[MockFunction onClear]}
26+
onSubmit={[MockFunction onSubmit]}
27+
value="alice"
28+
/>
29+
<small
30+
className="form-text text-muted search-help-text"
31+
>
32+
Search by username, email, or student key
33+
</small>
34+
</div>
35+
</div>
36+
</React.Fragment>
37+
`;

‎src/components/Gradebook/index.jsx

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ import PropTypes from 'prop-types';
44
import {
55
Button,
66
Collapsible,
7-
Icon,
87
CheckBox,
8+
Icon,
99
InputSelect,
1010
InputText,
11-
SearchField,
1211
StatusAlert,
1312
Tab,
1413
Tabs,
@@ -27,6 +26,7 @@ import BulkManagement from './BulkManagement';
2726
import BulkManagementControls from './BulkManagementControls';
2827
import EditModal from './EditModal';
2928
import GradebookTable from './GradebookTable';
29+
import SearchControls from './SearchControls';
3030

3131
export default class Gradebook extends React.Component {
3232
constructor(props) {
@@ -259,6 +259,7 @@ export default class Gradebook extends React.Component {
259259
'adjustedGradePossible',
260260
'adjustedGradeValue',
261261
'assignmentName',
262+
'filterValue',
262263
'modalOpen',
263264
'reasonForChange',
264265
'todaysDate',
@@ -294,32 +295,17 @@ export default class Gradebook extends React.Component {
294295
)}
295296
<Tabs defaultActiveKey="grades">
296297
<Tab eventKey="grades" title="Grades">
297-
<h4>Step 1: Filter the Grade Report</h4>
298-
<div className="d-flex justify-content-between">
299-
{this.props.showSpinner && <div className="spinner-overlay"><Icon className="fa fa-spinner fa-spin fa-5x color-black" /></div>}
300-
<Button className="btn-primary align-self-start" onClick={toggleFilterDrawer}><FontAwesomeIcon icon={faFilter} /> Edit Filters</Button>
301-
<div>
302-
<SearchField
303-
onSubmit={value => this.props.searchForUser(
304-
this.props.courseId,
305-
value,
306-
this.props.selectedCohort,
307-
this.props.selectedTrack,
308-
this.props.selectedAssignmentType,
309-
)}
310-
inputLabel="Search for a learner"
311-
onChange={filterValue => this.setState({ filterValue })}
312-
onClear={() => this.props.getUserGrades(
313-
this.props.courseId,
314-
this.props.selectedCohort,
315-
this.props.selectedTrack,
316-
this.props.selectedAssignmentType,
317-
)}
318-
value={this.state.filterValue}
319-
/>
320-
<small className="form-text text-muted search-help-text">Search by username, email, or student key</small>
298+
{this.props.showSpinner && (
299+
<div className="spinner-overlay">
300+
<Icon className="fa fa-spinner fa-spin fa-5x color-black" />
321301
</div>
322-
</div>
302+
)}
303+
<SearchControls
304+
courseId={this.props.courseId}
305+
filterValue={this.state.filterValue}
306+
setFilterValue={this.createStateFieldSetter('filterValue')}
307+
toggleFilterDrawer={toggleFilterDrawer}
308+
/>
323309
<ConnectedFilterBadges
324310
handleFilterBadgeClose={this.handleFilterBadgeClose}
325311
/>
@@ -527,7 +513,6 @@ Gradebook.propTypes = {
527513
search: PropTypes.string,
528514
}),
529515
resetFilters: PropTypes.func.isRequired,
530-
searchForUser: PropTypes.func.isRequired,
531516
selectedAssignmentType: PropTypes.string,
532517
selectedCohort: PropTypes.string,
533518
selectedTrack: PropTypes.string,

‎src/containers/GradebookPage/index.jsx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import {
55
closeBanner,
66
fetchGradeOverrideHistory,
77
fetchGrades,
8-
fetchMatchingUserGrades,
98
fetchPrevNextGrades,
109
filterAssignmentType,
1110
submitFileUploadFormData,
@@ -132,7 +131,6 @@ const mapDispatchToProps = {
132131
getUserGrades: fetchGrades,
133132
initializeFilters,
134133
resetFilters,
135-
searchForUser: fetchMatchingUserGrades,
136134
submitFileUploadFormData,
137135
toggleFormat: toggleGradeFormat,
138136
updateAssignmentFilter,

0 commit comments

Comments
 (0)