Skip to content

Commit

Permalink
feat: Add Include Date option in reporting configuration form
Browse files Browse the repository at this point in the history
  • Loading branch information
@omar-sarfraz
omar-sarfraz committed Feb 6, 2025
1 parent 519feab commit a70b8a3
Show file tree
Hide file tree
Showing 2 changed files with 130 additions and 57 deletions.
136 changes: 79 additions & 57 deletions src/components/ReportingConfig/ReportingConfigForm.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ class ReportingConfigForm extends React.Component {
active: this.props.config ? this.props.config.active : false,
enableCompression: this.props.config ? this.props.config.enableCompression : true,
submitState: SUBMIT_STATES.DEFAULT,
includeDate: this.props.config ? this.props.config.includeDate : true,
};

/**
Expand Down Expand Up @@ -127,6 +128,7 @@ class ReportingConfigForm extends React.Component {
let requiredFields = [];
formData.append('active', this.state.active);
formData.append('enableCompression', this.state.enableCompression);
formData.append('includeDate', this.state.includeDate);
if (formData.get('deliveryMethod') === 'email') {
requiredFields = config ? [...REQUIRED_EMAIL_FIELDS] : [...REQUIRED_NEW_EMAIL_FIELDS];
// transform email field to match what the api is looking for
Expand Down Expand Up @@ -257,6 +259,7 @@ class ReportingConfigForm extends React.Component {
active,
enableCompression,
submitState,
includeDate,
} = this.state;
const selectedCatalogs = (config?.enterpriseCustomerCatalogs || []).map(item => item.uuid);
const dataTypesOptions = reportingConfigTypes.dataType.map((item, index) => ({
Expand Down Expand Up @@ -456,65 +459,83 @@ class ReportingConfigForm extends React.Component {
handleBlur={this.handleBlur}
/>
)}
<div className="col">
<Form.Group
isInvalid={!!APIErrors.enableCompression}
<Form.Group
isInvalid={!!APIErrors.enableCompression}
>
<Form.Label>
<FormattedMessage
id="admin.portal.reporting.config.enable.compression"
defaultMessage="Enable Compression"
description="Label for the Enable Compression field in the reporting configuration form"
/>
</Form.Label>
<Form.Checkbox
data-testid="compressionCheckbox"
className="ml-3"
checked={enableCompression}
onChange={() => this.setState(prevState => ({ enableCompression: !prevState.enableCompression }))}
/>
<Form.Text>
<FormattedMessage
id="admin.portal.reporting.config.enable.compression.help"
defaultMessage="Specifies whether report should be compressed. Without compression files will not be password protected or encrypted."
description="Help text for the Enable Compression field in the reporting configuration form"
/>
</Form.Text>
{!!APIErrors.enableCompression && (
<Form.Control.Feedback type="invalid">

Check warning on line 486 in src/components/ReportingConfig/ReportingConfigForm.jsx

View check run for this annotation

Codecov / codecov/patch

src/components/ReportingConfig/ReportingConfigForm.jsx#L486 

Added line #L486 was not covered by tests
{APIErrors.enableCompression}
</Form.Control.Feedback>
)}
</Form.Group>
<Form.Group>
<Form.Label>
<FormattedMessage
id="admin.portal.reporting.config.include.date"
defaultMessage="Include Date"
description="Label for the Include Date field in the reporting configuration form"
/>
</Form.Label>
<Form.Checkbox
data-testid="includeDateCheckbox"
className="ml-3"
checked={includeDate}
onChange={() => this.setState(prevState => ({ includeDate: !prevState.includeDate }))}
/>
<Form.Text>
<FormattedMessage
id="admin.portal.reporting.config.include.date.option.help"
defaultMessage="Specifies whether the report's filename should include the date."
description="Help text for the Include Date field in the reporting configuration form"
/>
</Form.Text>
</Form.Group>
<Form.Group controlId="enterpriseCustomerCatalogs">
<Form.Label>
<FormattedMessage
id="admin.portal.reporting.config.enterprise.customer.catalogs"
defaultMessage="Enterprise Customer Catalogs"
description="Label for the Enterprise Customer Catalogs field in the reporting configuration form"
/>
</Form.Label>
<Form.Control
as="select"
name="enterpriseCustomerCatalogUuids"
multiple
defaultValue={selectedCatalogs}
>
<Form.Label>
<FormattedMessage
id="admin.portal.reporting.config.enable.compression"
defaultMessage="Enable Compression"
description="Label for the Enable Compression field in the reporting configuration form"
/>
</Form.Label>
<Form.Checkbox
data-testid="compressionCheckbox"
className="ml-3"
checked={enableCompression}
onChange={() => this.setState(prevState => ({ enableCompression: !prevState.enableCompression }))}
{availableCatalogs && (availableCatalogs.map((item) => (
<option key={item.uuid} value={item.uuid}>Catalog {item.title} with UUID {item.uuid}</option>
)))}
</Form.Control>
<Form.Text>
<FormattedMessage
id="admin.portal.reporting.config.enterprise.customer.catalogs.help"
defaultMessage="The catalogs that should be included in the report. No selection means all catalogs will be included."
description="Help text for the Enterprise Customer Catalogs field in the reporting configuration form"
/>
<Form.Text>
<FormattedMessage
id="admin.portal.reporting.config.enable.compression.help"
defaultMessage="Specifies whether report should be compressed. Without compression files will not be password protected or encrypted."
description="Help text for the Enable Compression field in the reporting configuration form"
/>
</Form.Text>
{!!APIErrors.enableCompression && (
<Form.Control.Feedback type="invalid">
{APIErrors.enableCompression}
</Form.Control.Feedback>
)}
</Form.Group>
</div>
<div className="col">
<Form.Group controlId="enterpriseCustomerCatalogs">
<Form.Label>
<FormattedMessage
id="admin.portal.reporting.config.enterprise.customer.catalogs"
defaultMessage="Enterprise Customer Catalogs"
description="Label for the Enterprise Customer Catalogs field in the reporting configuration form"
/>
</Form.Label>
<Form.Control
as="select"
name="enterpriseCustomerCatalogUuids"
multiple
defaultValue={selectedCatalogs}
>
{availableCatalogs && (availableCatalogs.map((item) => (
<option key={item.uuid} value={item.uuid}>Catalog {item.title} with UUID {item.uuid}</option>
)))}
</Form.Control>
<Form.Text>
<FormattedMessage
id="admin.portal.reporting.config.enterprise.customer.catalogs.help"
defaultMessage="The catalogs that should be included in the report. No selection means all catalogs will be included."
description="Help text for the Enterprise Customer Catalogs field in the reporting configuration form"
/>
</Form.Text>
</Form.Group>
</div>
</Form.Text>
</Form.Group>
<div className="row justify-content-between align-items-center form-group">
<Form.Group
className="mb-0"
Expand Down Expand Up @@ -596,6 +617,7 @@ ReportingConfigForm.propTypes = {
config: PropTypes.shape({
active: PropTypes.bool,
enableCompression: PropTypes.bool,
includeDate: PropTypes.bool,
dataType: PropTypes.string,
dayOfMonth: PropTypes.number,
dayOfWeek: PropTypes.number,
Expand Down
51 changes: 51 additions & 0 deletions src/components/ReportingConfig/ReportingConfigForm.test.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import ReportingConfigForm from './ReportingConfigForm';
const defaultConfig = {
enterpriseCustomerId: 'test-customer-uuid',
active: true,
enableCompression: true,
includeDate: false,
deliveryMethod: 'email',
email: ['[email protected]'],
emailRaw: '[email protected]',
Expand Down Expand Up @@ -362,6 +364,7 @@ describe('<ReportingConfigForm />', () => {
const errorResponse = {
data: {
pgp_encryption_key: ['Please enter a valid PGP encryption key.'],
enableCompression: ['Test Compression Error'],
},
};
await act(async () => {
Expand All @@ -377,4 +380,52 @@ describe('<ReportingConfigForm />', () => {
instance.handleAPIErrorResponse(null);
expect(mock).not.toHaveBeenCalled();
});
it("should update the includeDate state when the 'Include Date' checkbox is clicked", async () => {
const wrapper = mount((
<IntlProvider locale="en">
<ReportingConfigForm
config={defaultConfig}
createConfig={createConfig}
updateConfig={updateConfig}
availableCatalogs={availableCatalogs}
reportingConfigTypes={reportingConfigTypes}
enterpriseCustomerUuid={enterpriseCustomerUuid}
/>
</IntlProvider>
));

const instance = wrapper.find('ReportingConfigForm').instance();
expect(instance.state.includeDate).toBeFalsy();

await act(async () => {
wrapper.find('[data-testid="includeDateCheckbox"]').first().prop('onChange')();
});

wrapper.update();
expect(instance.state.includeDate).toBeTruthy();
});
it("should update enableCompression state when the 'Enable Compression' checkbox is clicked", async () => {
const wrapper = mount((
<IntlProvider locale="en">
<ReportingConfigForm
config={defaultConfig}
createConfig={createConfig}
updateConfig={updateConfig}
availableCatalogs={availableCatalogs}
reportingConfigTypes={reportingConfigTypes}
enterpriseCustomerUuid={enterpriseCustomerUuid}
/>
</IntlProvider>
));

const instance = wrapper.find('ReportingConfigForm').instance();
expect(instance.state.enableCompression).toBeTruthy();

await act(async () => {
wrapper.find('[data-testid="compressionCheckbox"]').first().prop('onChange')();
});

wrapper.update();
expect(instance.state.enableCompression).toBeFalsy();
});
});

0 comments on commit a70b8a3

Please sign in to comment.