woocommerce/plugins/woocommerce-admin/client/store/reports/utils.js

174 lines
5.2 KiB
JavaScript

/** @format */
/**
* External dependencies
*/
import { forEach, isNull } from 'lodash';
/**
* Internal dependencies
*/
import { MAX_PER_PAGE } from 'store/constants';
import { appendTimestamp, getCurrentDates, getIntervalForQuery } from 'lib/date';
/**
* Returns true if a report object is empty.
*
* @param {Object} report Report to check
* @return {Boolean} True if report is data is empty.
*/
export function isReportDataEmpty( report ) {
if ( ! report ) {
return true;
}
if ( ! report.data ) {
return true;
}
if ( ! report.data.totals || isNull( report.data.totals ) ) {
return true;
}
if ( ! report.data.intervals || 0 === report.data.intervals.length ) {
return true;
}
return false;
}
/**
* Constructs and returns a query associated with a Report data request.
*
* @param {String} dataType 'primary' or 'secondary'.
* @param {Object} query query parameters in the url.
* @returns {Object} data request query parameters.
*/
function getRequestQuery( dataType, query ) {
const datesFromQuery = getCurrentDates( query );
const interval = getIntervalForQuery( query );
return {
order: 'asc',
interval,
per_page: MAX_PER_PAGE,
after: appendTimestamp( datesFromQuery[ dataType ].after, 'start' ),
before: appendTimestamp( datesFromQuery[ dataType ].before, 'end' ),
};
}
/**
* Returns summary number totals needed to render a report page.
*
* @param {String} endpoint Report API Endpoint
* @param {Object} query query parameters in the url
* @param {object} select Instance of @wordpress/select
* @return {Object} Object containing summary number responses.
*/
export function getSummaryNumbers( endpoint, query, select ) {
const { getReportStats, isReportStatsRequesting, isReportStatsError } = select( 'wc-admin' );
const response = {
isRequesting: false,
isError: false,
totals: {
primary: null,
secondary: null,
},
};
const primaryQuery = getRequestQuery( 'primary', query );
const primary = getReportStats( endpoint, primaryQuery );
if ( isReportStatsRequesting( endpoint, primaryQuery ) ) {
return { ...response, isRequesting: true };
} else if ( isReportStatsError( endpoint, primaryQuery ) ) {
return { ...response, isError: true };
}
const primaryTotals = ( primary && primary.data && primary.data.totals ) || null;
const secondaryQuery = getRequestQuery( 'secondary', query );
const secondary = getReportStats( endpoint, secondaryQuery );
if ( isReportStatsRequesting( endpoint, secondaryQuery ) ) {
return { ...response, isRequesting: true };
} else if ( isReportStatsError( endpoint, secondaryQuery ) ) {
return { ...response, isError: true };
}
const secondaryTotals = ( secondary && secondary.data && secondary.data.totals ) || null;
return { ...response, totals: { primary: primaryTotals, secondary: secondaryTotals } };
}
/**
* Returns all of the data needed to render a chart with summary numbers on a report page.
*
* @param {String} endpoint Report API Endpoint
* @param {String} dataType 'primary' or 'secondary'
* @param {Object} query query parameters in the url
* @param {object} select Instance of @wordpress/select
* @return {Object} Object containing API request information (response, fetching, and error details)
*/
export function getReportChartData( endpoint, dataType, query, select ) {
const { getReportStats, isReportStatsRequesting, isReportStatsError } = select( 'wc-admin' );
const response = {
isEmpty: false,
isError: false,
isRequesting: false,
data: {
totals: null,
intervals: [],
},
};
const requestQuery = getRequestQuery( dataType, query );
const stats = getReportStats( endpoint, requestQuery );
if ( isReportStatsRequesting( endpoint, requestQuery ) ) {
return { ...response, isRequesting: true };
} else if ( isReportStatsError( endpoint, requestQuery ) ) {
return { ...response, isError: true };
} else if ( isReportDataEmpty( stats ) ) {
return { ...response, isEmpty: true };
}
const totals = ( stats && stats.data && stats.data.totals ) || null;
let intervals = ( stats && stats.data && stats.data.intervals ) || [];
// If we have more than 100 results for this time period,
// we need to make additional requests to complete the response.
if ( stats.totalResults > MAX_PER_PAGE ) {
let isFetching = true;
let isError = false;
const pagedData = [];
const totalPages = Math.ceil( stats.totalResults / MAX_PER_PAGE );
for ( let i = 2; i <= totalPages; i++ ) {
const nextQuery = { ...requestQuery, page: i };
const _data = getReportStats( endpoint, nextQuery );
if ( isReportStatsRequesting( endpoint, nextQuery ) ) {
continue;
}
if ( isReportStatsError( endpoint, nextQuery ) ) {
isError = true;
isFetching = false;
break;
}
if ( ! isReportStatsRequesting( endpoint, nextQuery ) ) {
pagedData.push( _data );
if ( i === totalPages ) {
isFetching = false;
break;
}
}
}
if ( isFetching ) {
return { ...response, isRequesting: true };
} else if ( isError ) {
return { ...response, isError: true };
}
forEach( pagedData, function( _data ) {
intervals = intervals.concat( _data.data.intervals );
} );
}
return { ...response, data: { totals, intervals } };
}