Skip to content

Refactor DateFilter component for improved readability and performance #2145

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
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
136 changes: 70 additions & 66 deletions src/filters/Date.js
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
/* eslint quotes: 0 */
/* eslint max-len: 0 */
import React, { Component } from 'react';
import PropTypes from 'prop-types';
import Const from '../Const';
import React, { Component } from "react";
import PropTypes from "prop-types";
import Const from "../Const";

const legalComparators = [ '=', '>', '>=', '<', '<=', '!=' ];
const legalComparators = ["=", ">", ">=", "<", "<=", "!="];

function dateParser(d) {
return `${d.getFullYear()}-${("0" + (d.getMonth() + 1)).slice(-2)}-${("0" + d.getDate()).slice(-2)}`;
return `${d.getFullYear()}-${("0" + (d.getMonth() + 1)).slice(-2)}-${(
"0" + d.getDate()
).slice(-2)}`;
}

class DateFilter extends Component {
constructor(props) {
super(props);
this.dateComparators = this.props.dateComparators || legalComparators;
this.filter = this.filter.bind(this);
this.onChangeComparator = this.onChangeComparator.bind(this);
}

setDefaultDate() {
let defaultDate = '';
let defaultDate = "";
const { defaultValue } = this.props;
if (defaultValue && defaultValue.date) {
// Set the appropriate format for the input type=date, i.e. "YYYY-MM-DD"
defaultDate = dateParser(new Date(defaultValue.date));
}
return defaultDate;
Expand All @@ -31,78 +28,93 @@ class DateFilter extends Component {
onChangeComparator(event) {
let date = this.inputDate.value;
const comparator = event.target.value;
if (date === '') {
if (date === "") {
return;
}
date = new Date(date);
this.props.filterHandler({ date, comparator }, Const.FILTER_TYPE.DATE);
}

getComparatorOptions() {
const optionTags = [];
optionTags.push(<option key='-1'></option>);
for (let i = 0; i < this.dateComparators.length; i++) {
optionTags.push(
<option key={ i } value={ this.dateComparators[i] }>
{ this.dateComparators[i] }
return [
<option key="-1"></option>,
...this.dateComparators.map((comparator, index) => (
<option key={index} value={comparator}>
{comparator}
</option>
);
}
return optionTags;
)),
];
}

filter(event) {
filter = (event) => {
const comparator = this.dateFilterComparator.value;
const dateValue = event.target.value;
if (dateValue) {
this.props.filterHandler({ date: new Date(dateValue), comparator }, Const.FILTER_TYPE.DATE);
this.props.filterHandler(
{ date: new Date(dateValue), comparator },
Const.FILTER_TYPE.DATE
);
} else {
this.props.filterHandler(null, Const.FILTER_TYPE.DATE);
}
}
};

cleanFiltered() {
cleanFiltered = () => {
const value = this.setDefaultDate();
const comparator = (this.props.defaultValue) ? this.props.defaultValue.comparator : '';
this.setState(() => { return { isPlaceholderSelected: (value === '') }; });
const comparator = this.props.defaultValue
? this.props.defaultValue.comparator
: "";
this.setState(() => ({ isPlaceholderSelected: value === "" }));
this.dateFilterComparator.value = comparator;
this.inputDate.value = value;
this.props.filterHandler({ date: new Date(value), comparator }, Const.FILTER_TYPE.DATE);
}
this.props.filterHandler(
{ date: new Date(value), comparator },
Const.FILTER_TYPE.DATE
);
};

applyFilter(filterDateObj) {
const { date, comparator } = filterDateObj;
this.setState(() => { return { isPlaceholderSelected: (date === '') }; });
this.setState(() => ({ isPlaceholderSelected: date === "" }));
this.dateFilterComparator.value = comparator;
this.inputDate.value = dateParser(date);
this.props.filterHandler({ date, comparator }, Const.FILTER_TYPE.DATE);
}

componentDidMount() {
const comparator = this.dateFilterComparator.value;
const dateValue = this.inputDate.value;
const { dateFilterComparator, inputDate, props } = this;
const comparator = dateFilterComparator.value;
const dateValue = inputDate.value;
if (comparator && dateValue) {
this.props.filterHandler({ date: new Date(dateValue), comparator }, Const.FILTER_TYPE.DATE);
props.filterHandler(
{ date: new Date(dateValue), comparator },
Const.FILTER_TYPE.DATE
);
}
}

render() {
const { defaultValue, style: { date, comparator } } = this.props;
const { defaultValue, style } = this.props;
const { date, comparator } = style;
return (
<div className='filter date-filter'>
<select ref={ n => this.dateFilterComparator = n }
style={ comparator }
className='date-filter-comparator form-control'
onChange={ this.onChangeComparator }
defaultValue={ (defaultValue) ? defaultValue.comparator : '' }>
{ this.getComparatorOptions() }
<div className="filter date-filter">
<select
ref={(n) => (this.dateFilterComparator = n)}
style={comparator}
className="date-filter-comparator form-control"
onChange={this.onChangeComparator}
defaultValue={defaultValue ? defaultValue.comparator : ""}
>
{this.getComparatorOptions()}
</select>
<input ref={ n => this.inputDate = n }
className='filter date-filter-input form-control'
style={ date }
type='date'
onChange={ this.filter }
defaultValue={ this.setDefaultDate() } />
<input
ref={(n) => (this.inputDate = n)}
className="filter date-filter-input form-control"
style={date}
type="date"
onChange={this.filter}
defaultValue={this.setDefaultDate()}
/>
</div>
);
}
Expand All @@ -112,40 +124,32 @@ DateFilter.propTypes = {
filterHandler: PropTypes.func.isRequired,
defaultValue: PropTypes.shape({
date: PropTypes.object,
comparator: PropTypes.oneOf(legalComparators)
comparator: PropTypes.oneOf(legalComparators),
}),
style: PropTypes.shape({
date: PropTypes.oneOfType([ PropTypes.object ]),
comparator: PropTypes.oneOfType([ PropTypes.object ])
date: PropTypes.oneOfType([PropTypes.object]),
comparator: PropTypes.oneOfType([PropTypes.object]),
}),
/* eslint consistent-return: 0 */
dateComparators: function(props, propName) {
dateComparators: function (props, propName) {
if (!props[propName]) {
return;
}
for (let i = 0; i < props[propName].length; i++) {
let comparatorIsValid = false;
for (let j = 0; j < legalComparators.length; j++) {
if (legalComparators[j] === props[propName][i]) {
comparatorIsValid = true;
break;
}
}
if (!comparatorIsValid) {
return new Error(`Date comparator provided is not supported.
Use only ${legalComparators}`);
if (!legalComparators.includes(props[propName][i])) {
return new Error(
`Date comparator provided is not supported. Use only ${legalComparators}`
);
}
}
},
columnName: PropTypes.any
columnName: PropTypes.any,
};

DateFilter.defaultProps = {
style: {
date: null,
comparator: null
}
comparator: null,
},
};


export default DateFilter;