/** @format */ /** * External dependencies */ import { find, forEach, isNull, get, includes } from 'lodash'; import moment from 'moment'; /** * WooCommerce dependencies */ import { appendTimestamp, getCurrentDates, getIntervalForQuery } from '@woocommerce/date'; import { flattenFilters, getActiveFiltersFromQuery, getUrlKey } from '@woocommerce/navigation'; import { formatCurrency } from '@woocommerce/currency'; /** * Internal dependencies */ import { MAX_PER_PAGE, QUERY_DEFAULTS } from 'wc-api/constants'; import * as categoriesConfig from 'analytics/report/categories/config'; import * as couponsConfig from 'analytics/report/coupons/config'; import * as customersConfig from 'analytics/report/customers/config'; import * as downloadsConfig from 'analytics/report/downloads/config'; import * as ordersConfig from 'analytics/report/orders/config'; import * as productsConfig from 'analytics/report/products/config'; import * as taxesConfig from 'analytics/report/taxes/config'; import * as reportsUtils from './utils'; const reportConfigs = { categories: categoriesConfig, coupons: couponsConfig, customers: customersConfig, downloads: downloadsConfig, orders: ordersConfig, products: productsConfig, taxes: taxesConfig, }; export function getFilterQuery( endpoint, query, limitBy ) { if ( query.search ) { const limitProperties = limitBy || [ endpoint ]; return limitProperties.reduce( ( result, limitProperty ) => { result[ limitProperty ] = query[ limitProperty ]; return result; }, {} ); } if ( reportConfigs[ endpoint ] ) { const { filters = [], advancedFilters = {} } = reportConfigs[ endpoint ]; return filters .map( filter => getQueryFromConfig( filter, advancedFilters, query ) ) .reduce( ( result, configQuery ) => Object.assign( result, configQuery ), {} ); } return {}; } // Some stats endpoints don't have interval data, so they can ignore after/before params and omit that part of the response. const noIntervalEndpoints = [ 'stock', 'customers' ]; /** * Add timestamp to advanced filter parameters involving date. The api * expects a timestamp for these values similar to `before` and `after`. * * @param {object} config - advancedFilters config object. * @param {object} activeFilter - an active filter. * @returns {object} - an active filter with timestamp added to date values. */ export function timeStampFilterDates( config, activeFilter ) { const advancedFilterConfig = config.filters[ activeFilter.key ]; if ( 'Date' !== get( advancedFilterConfig, [ 'input', 'component' ] ) ) { return activeFilter; } const { rule, value } = activeFilter; const timeOfDayMap = { after: 'start', before: 'end', }; // If the value is an array, it signifies "between" values which must have a timestamp // appended to each value. if ( Array.isArray( value ) ) { const [ after, before ] = value; return Object.assign( {}, activeFilter, { value: [ appendTimestamp( moment( after ), timeOfDayMap.after ), appendTimestamp( moment( before ), timeOfDayMap.before ), ], } ); } return Object.assign( {}, activeFilter, { value: appendTimestamp( moment( value ), timeOfDayMap[ rule ] ), } ); } export function getQueryFromConfig( config, advancedFilters, query ) { const queryValue = query[ config.param ]; if ( ! queryValue ) { return {}; } if ( 'advanced' === queryValue ) { const activeFilters = getActiveFiltersFromQuery( query, advancedFilters.filters ); if ( activeFilters.length === 0 ) { return {}; } return activeFilters.map( filter => timeStampFilterDates( advancedFilters, filter ) ).reduce( ( result, activeFilter ) => { const { key, rule, value } = activeFilter; result[ getUrlKey( key, rule ) ] = value; return result; }, { match: query.match || 'all' } ); } const filter = find( flattenFilters( config.filters ), { value: queryValue } ); if ( ! filter ) { return {}; } if ( filter.settings && filter.settings.param ) { const { param } = filter.settings; if ( query[ param ] ) { return { [ param ]: query[ param ], }; } return {}; } return {}; } /** * Returns true if a report object is empty. * * @param {Object} report Report to check * @param {String} endpoint Endpoint slug * @return {Boolean} True if report is data is empty. */ export function isReportDataEmpty( report, endpoint ) { if ( ! report ) { return true; } if ( ! report.data ) { return true; } if ( ! report.data.totals || isNull( report.data.totals ) ) { return true; } const checkIntervals = ! includes( noIntervalEndpoints, endpoint ); if ( checkIntervals && ( ! 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} endpoint Report API Endpoint * @param {String} dataType 'primary' or 'secondary'. * @param {Object} query Query parameters in the url. * @param {Array} [limitBy] Properties used to limit the results. It will be used in the API call to send the IDs. * @returns {Object} data request query parameters. */ function getRequestQuery( endpoint, dataType, query, limitBy ) { const datesFromQuery = getCurrentDates( query ); const interval = getIntervalForQuery( query ); const filterQuery = getFilterQuery( endpoint, query, limitBy ); const end = datesFromQuery[ dataType ].before; const noIntervals = includes( noIntervalEndpoints, endpoint ); return noIntervals ? { ...filterQuery } : { order: 'asc', interval, per_page: MAX_PER_PAGE, after: appendTimestamp( datesFromQuery[ dataType ].after, 'start' ), before: appendTimestamp( end, 'end' ), segmentby: query.segmentby, ...filterQuery, }; } /** * 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 * @param {Array} [limitBy] Properties used to limit the results. It will be used in the API call to send the IDs. * @return {Object} Object containing summary number responses. */ export function getSummaryNumbers( endpoint, query, select, limitBy ) { const { getReportStats, getReportStatsError, isReportStatsRequesting } = select( 'wc-api' ); const response = { isRequesting: false, isError: false, totals: { primary: null, secondary: null, }, }; const mappedEndpoint = 'categories' === endpoint ? 'products' : endpoint; const primaryQuery = getRequestQuery( endpoint, 'primary', query, limitBy ); const primary = getReportStats( mappedEndpoint, primaryQuery ); if ( isReportStatsRequesting( mappedEndpoint, primaryQuery ) ) { return { ...response, isRequesting: true }; } else if ( getReportStatsError( mappedEndpoint, primaryQuery ) ) { return { ...response, isError: true }; } const primaryTotals = ( primary && primary.data && primary.data.totals ) || null; const secondaryQuery = getRequestQuery( mappedEndpoint, 'secondary', query ); const secondary = getReportStats( mappedEndpoint, secondaryQuery ); if ( isReportStatsRequesting( mappedEndpoint, secondaryQuery ) ) { return { ...response, isRequesting: true }; } else if ( getReportStatsError( mappedEndpoint, 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 * @param {Array} [limitBy] Properties used to limit the results. It will be used in the API call to send the IDs. * @return {Object} Object containing API request information (response, fetching, and error details) */ export function getReportChartData( endpoint, dataType, query, select, limitBy ) { const { getReportStats, getReportStatsError, isReportStatsRequesting } = select( 'wc-api' ); const mappedEndpoint = 'categories' === endpoint ? 'products' : endpoint; const response = { isEmpty: false, isError: false, isRequesting: false, data: { totals: {}, intervals: [], }, }; const requestQuery = getRequestQuery( endpoint, dataType, query, limitBy ); const stats = getReportStats( mappedEndpoint, requestQuery ); if ( isReportStatsRequesting( mappedEndpoint, requestQuery ) ) { return { ...response, isRequesting: true }; } else if ( getReportStatsError( mappedEndpoint, requestQuery ) ) { return { ...response, isError: true }; } else if ( isReportDataEmpty( stats, mappedEndpoint ) ) { 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( mappedEndpoint, nextQuery ); if ( isReportStatsRequesting( mappedEndpoint, nextQuery ) ) { continue; } if ( getReportStatsError( mappedEndpoint, nextQuery ) ) { isError = true; isFetching = false; break; } 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 } }; } /** * Returns a formatting function or string to be used by d3-format * * @param {String} type Type of number, 'currency', 'number', 'percent', 'average' * @return {String|Function} returns a number format based on the type or an overriding formatting function */ export function getTooltipValueFormat( type ) { switch ( type ) { case 'currency': return formatCurrency; case 'percent': return '.0%'; case 'number': return ','; case 'average': return ',.2r'; default: return ','; } } export function getReportTableQuery( endpoint, urlQuery, query ) { const filterQuery = getFilterQuery( endpoint, urlQuery ); const datesFromQuery = getCurrentDates( urlQuery ); return { orderby: urlQuery.orderby || 'date', order: urlQuery.order || 'desc', after: appendTimestamp( datesFromQuery.primary.after, 'start' ), before: appendTimestamp( datesFromQuery.primary.before, 'end' ), page: urlQuery.page || 1, per_page: urlQuery.per_page || QUERY_DEFAULTS.pageSize, ...filterQuery, ...query, }; } /** * Returns table data needed to render a report page. * * @param {String} endpoint Report API Endpoint * @param {Object} urlQuery Query parameters in the url * @param {Object} select Instance of @wordpress/select * @param {Object} query Query parameters specific for that endpoint * @return {Object} Object Table data response */ export function getReportTableData( endpoint, urlQuery, select, query = {} ) { const { getReportItems, getReportItemsError, isReportItemsRequesting } = select( 'wc-api' ); const tableQuery = reportsUtils.getReportTableQuery( endpoint, urlQuery, query ); const response = { query: tableQuery, isRequesting: false, isError: false, items: { data: [], totalResults: 0, }, }; const items = getReportItems( endpoint, tableQuery ); if ( isReportItemsRequesting( endpoint, tableQuery ) ) { return { ...response, isRequesting: true }; } else if ( getReportItemsError( endpoint, tableQuery ) ) { return { ...response, isError: true }; } return { ...response, items }; }