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

Report loading #1851

Merged
merged 15 commits into from
Dec 11, 2019
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
[#1507](https://github.com/greenbone/gsa/pull/1507)

### Changed
- Only load full report if the report has less than 25000 results [#1851](https://github.com/greenbone/gsa/pull/1851)
- Only render report information, results and errors if a result has more than 25000 results [#1849](https://github.com/greenbone/gsa/pull/1849)
- Limit the length of result description with a div [#1834](https://github.com/greenbone/gsa/pull/1834)
- New permission dialog: radio button for groups disabled if no groups available [#1836](https://github.com/greenbone/gsa/pull/1836)
Expand Down
1 change: 1 addition & 0 deletions gsa/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ set (GSA_JS_SRC_FILES
${GSA_SRC_DIR}/src/gmp/utils/number.js
${GSA_SRC_DIR}/src/gmp/utils/object.js
${GSA_SRC_DIR}/src/gmp/utils/string.js
${GSA_SRC_DIR}/src/gmp/utils/trace.js
${GSA_SRC_DIR}/src/web/app.js
${GSA_SRC_DIR}/src/web/components/badge/badge.js
${GSA_SRC_DIR}/src/web/components/bar/menubar.js
Expand Down
9 changes: 7 additions & 2 deletions gsa/src/gmp/commands/__tests__/convert.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@ describe('convertBoolean tests', () => {
test('should convert to undefined for other value', () => {
expect(convertBoolean('true')).toBeUndefined();
expect(convertBoolean('false')).toBeUndefined();
expect(convertBoolean(1)).toBeUndefined();
expect(convertBoolean(0)).toBeUndefined();
expect(convertBoolean('1')).toBeUndefined();
expect(convertBoolean('0')).toBeUndefined();
});

test('should convert to legacy 0 and 1 values', () => {
expect(convertBoolean(1)).toEqual(1);
expect(convertBoolean(0)).toEqual(0);
});
});
10 changes: 10 additions & 0 deletions gsa/src/gmp/commands/convert.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*/

import logger from 'gmp/log';

import {trace} from 'gmp/utils/trace';

const log = logger.getLogger('gmp.commands.utils');

/**
* Convert boolean true/false to API 1/0 values
*
Expand All @@ -30,5 +36,9 @@ export const convertBoolean = value => {
if (value === false) {
return 0;
}
if (value === 1 || value === 0) {
log.warn('Passed 1 or 0 instead of a true or false', trace());
return value;
}
return undefined;
};
3 changes: 2 additions & 1 deletion gsa/src/gmp/commands/reports.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {ALL_FILTER} from '../models/filter';
import DefaultTransform from '../http/transform/default';
import FastXmlTransform from '../http/transform/fastxml';

import {convertBoolean} from './convert';
import EntitiesCommand from './entities';
import EntityCommand from './entity';

Expand Down Expand Up @@ -148,7 +149,7 @@ class ReportCommand extends EntityCommand {
{
id,
filter,
details,
details: convertBoolean(details),
ignore_pagination: 1,
},
{...options, transform: FastXmlTransform},
Expand Down
27 changes: 27 additions & 0 deletions gsa/src/gmp/utils/trace.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/* Copyright (C) 2019 Greenbone Networks GmbH
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*/

/** Return the current stack trace a string */
export const trace = () => {
try {
throw Error();
} catch (e) {
return e.stack;
}
};
1 change: 1 addition & 0 deletions gsa/src/web/pages/reports/deltadetailscontent.js
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ const PageContent = ({
<TabPanels>
<TabPanel>
<Summary
filter={filter}
report={report}
onError={onError}
onTagChanged={onTagSuccess}
Expand Down
2 changes: 1 addition & 1 deletion gsa/src/web/pages/reports/deltadetailspage.js
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ class DeltaReportDetails extends React.Component {
{showFilterDialog && (
<FilterDialog
filter={reportFilter}
delta={isDefined(report) && report.isDeltaReport()}
delta={true}
onFilterChanged={this.handleFilterChange}
onCloseClick={this.handleFilterDialogClose}
createFilterType="result"
Expand Down
146 changes: 69 additions & 77 deletions gsa/src/web/pages/reports/detailspage.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,8 @@ import {
} from 'web/store/entities/reportformats';

import {
loadEntity as loadReportEntityWithStore,
loadEntityIfNeeded as loadReportEntityWithStoreIfNeeded,
selector as reportSelector,
loadEntityWithThreshold,
} from 'web/store/entities/reports';

import {
Expand Down Expand Up @@ -213,10 +212,7 @@ class ReportDetails extends React.Component {
}
}

if (
prevProps.reportId !== this.props.reportId ||
prevProps.deltaReportId !== this.props.deltaReportId
) {
if (prevProps.reportId !== this.props.reportId) {
this.load();
}
}
Expand All @@ -228,12 +224,17 @@ class ReportDetails extends React.Component {
const {reportFilter} = this.props;

this.setState({
isUpdating: isDefined(reportFilter) && !reportFilter.equals(filter), // show update indicator if filter has changed
isUpdating: isDefined(reportFilter) || !reportFilter.equals(filter), // show update indicator if filter has changed
});

this.props.reload(filter).then(() => {
this.setState({isUpdating: false});
});
this.props
.reload(filter)
.then(() => {
this.setState({isUpdating: false});
})
.catch(() => {
this.setState({isUpdating: false});
});
}

reload() {
Expand Down Expand Up @@ -321,7 +322,6 @@ class ReportDetails extends React.Component {

handleReportDownload(state) {
const {
deltaReportId,
entity,
gmp,
reportComposerDefaults,
Expand Down Expand Up @@ -365,7 +365,6 @@ class ReportDetails extends React.Component {
return gmp.report
.download(entity, {
reportFormatId,
deltaReportId,
filter: newFilter,
})
.then(response => {
Expand Down Expand Up @@ -547,7 +546,7 @@ class ReportDetails extends React.Component {
{showFilterDialog && (
<FilterDialog
filter={reportFilter}
delta={isDefined(report) && report.isDeltaReport()}
delta={false}
onFilterChanged={this.handleFilterChange}
onCloseClick={this.handleFilterDialogClose}
createFilterType="result"
Expand All @@ -573,17 +572,14 @@ class ReportDetails extends React.Component {

ReportDetails.propTypes = {
defaultFilter: PropTypes.filter.isRequired,
deltaReportId: PropTypes.id,
entity: PropTypes.model,
entityError: PropTypes.object,
filters: PropTypes.array,
gmp: PropTypes.gmp.isRequired,
isLoading: PropTypes.bool.isRequired,
loadFilters: PropTypes.func.isRequired,
loadReport: PropTypes.func.isRequired,
loadReportComposerDefaults: PropTypes.func.isRequired,
loadReportFormats: PropTypes.func.isRequired,
loadReportIfNeeded: PropTypes.func.isRequired,
loadSettings: PropTypes.func.isRequired,
loadTarget: PropTypes.func.isRequired,
location: PropTypes.object.isRequired,
Expand All @@ -605,58 +601,6 @@ ReportDetails.propTypes = {
onInteraction: PropTypes.func.isRequired,
};

const mapDispatchToProps = (dispatch, {gmp}) => {
return {
onInteraction: () => dispatch(renewSessionTimeout(gmp)()),
loadFilters: () => dispatch(loadFilters(gmp)(RESULTS_FILTER_FILTER)),
loadSettings: () => dispatch(loadUserSettingDefaults(gmp)()),
loadTarget: targetId => gmp.target.get({id: targetId}),
loadReportFormats: () =>
dispatch(loadReportFormats(gmp)(REPORT_FORMATS_FILTER)),
loadReport: (id, filter) =>
dispatch(loadReportEntityWithStore(gmp)(id, filter)),
loadReportIfNeeded: (id, filter) =>
dispatch(loadReportEntityWithStoreIfNeeded(gmp)(id, filter)),
loadReportComposerDefaults: () =>
dispatch(loadReportComposerDefaults(gmp)()),
loadUserSettingDefaultFilter: () =>
dispatch(loadUserSettingsDefaultFilter(gmp)('result')),
saveReportComposerDefaults: reportComposerDefaults =>
dispatch(saveReportComposerDefaults(gmp)(reportComposerDefaults)),
};
};

const mapStateToProps = (rootState, {match}) => {
const {id} = match.params;
const filterSel = filterSelector(rootState);
const reportSel = reportSelector(rootState);
const reportFormatsSel = reportFormatsSelector(rootState);
const userDefaultsSelector = getUserSettingsDefaults(rootState);
const userDefaultFilterSel = getUserSettingsDefaultFilter(
rootState,
'result',
);
const username = getUsername(rootState);

const entity = reportSel.getEntity(id);
const entityError = reportSel.getEntityError(id);
return {
entity,
entityError,
filters: filterSel.getAllEntities(RESULTS_FILTER_FILTER),
isLoading: !isDefined(entity),
reportExportFileName: userDefaultsSelector.getValueByName(
'reportexportfilename',
),
reportFilter: getFilter(entity),
reportFormats: reportFormatsSel.getAllEntities(REPORT_FORMATS_FILTER),
reportId: id,
reportComposerDefaults: getReportComposerDefaults(rootState),
resultDefaultFilter: userDefaultFilterSel.getFilter('result'),
username,
};
};

const reloadInterval = report =>
isDefined(report) && isActive(report.report.scan_run_status)
? USE_DEFAULT_RELOAD_INTERVAL_ACTIVE
Expand All @@ -665,8 +609,7 @@ const reloadInterval = report =>
const load = ({
defaultFilter,
reportId,
loadReport,
loadReportIfNeeded,
loadReportWithThreshold,
reportFilter,
}) => filter => {
if (!hasValue(filter)) {
Expand All @@ -684,22 +627,24 @@ const load = ({
filter = DEFAULT_FILTER;
}

return loadReportIfNeeded(reportId, filter).then(() =>
loadReport(reportId, filter),
);
return loadReportWithThreshold(reportId, {filter});
};

const ReportDetailsWrapper = ({filter, reportFilter, ...props}) => (
const ReportDetailsWrapper = ({
filter: defaultFilter,
reportFilter,
...props
}) => (
<Reload
name="report"
load={load({...props, defaultFilter: filter})}
reload={load({...props, defaultFilter: filter, reportFilter})}
load={load({...props, defaultFilter})}
reload={load({...props, defaultFilter, reportFilter})}
reloadInterval={() => reloadInterval(props.entity)}
>
{({reload}) => (
<ReportDetails
{...props}
defaultFilter={filter}
defaultFilter={defaultFilter}
reportFilter={reportFilter}
reload={reload}
/>
Expand All @@ -714,6 +659,53 @@ ReportDetailsWrapper.propTypes = {
reportFilter: PropTypes.filter,
};

const mapDispatchToProps = (dispatch, {gmp}) => ({
onInteraction: () => dispatch(renewSessionTimeout(gmp)()),
loadFilters: () => dispatch(loadFilters(gmp)(RESULTS_FILTER_FILTER)),
loadSettings: () => dispatch(loadUserSettingDefaults(gmp)()),
loadTarget: targetId => gmp.target.get({id: targetId}),
loadReportFormats: () =>
dispatch(loadReportFormats(gmp)(REPORT_FORMATS_FILTER)),
loadReportWithThreshold: (id, options) =>
dispatch(loadEntityWithThreshold(gmp)(id, options)),
loadReportComposerDefaults: () => dispatch(loadReportComposerDefaults(gmp)()),
loadUserSettingDefaultFilter: () =>
dispatch(loadUserSettingsDefaultFilter(gmp)('result')),
saveReportComposerDefaults: reportComposerDefaults =>
dispatch(saveReportComposerDefaults(gmp)(reportComposerDefaults)),
});

const mapStateToProps = (rootState, {match}) => {
const {id} = match.params;
const filterSel = filterSelector(rootState);
const reportSel = reportSelector(rootState);
const reportFormatsSel = reportFormatsSelector(rootState);
const userDefaultsSelector = getUserSettingsDefaults(rootState);
const userDefaultFilterSel = getUserSettingsDefaultFilter(
rootState,
'result',
);
const username = getUsername(rootState);

const entity = reportSel.getEntity(id);
const entityError = reportSel.getEntityError(id);
return {
entity,
entityError,
filters: filterSel.getAllEntities(RESULTS_FILTER_FILTER),
isLoading: !isDefined(entity),
reportExportFileName: userDefaultsSelector.getValueByName(
'reportexportfilename',
),
reportFilter: getFilter(entity),
reportFormats: reportFormatsSel.getAllEntities(REPORT_FORMATS_FILTER),
reportId: id,
reportComposerDefaults: getReportComposerDefaults(rootState),
resultDefaultFilter: userDefaultFilterSel.getFilter('result'),
username,
};
};

export default compose(
withGmp,
withDialogNotification,
Expand Down
Loading