-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1315 from openedx/saleem-latif/ENT-9434
feat: Updated completions and engagements tabs in analytics according to performance enhancement updates on the backend.
- Loading branch information
Showing
6 changed files
with
297 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
src/components/AdvanceAnalyticsV2/data/hooks/useEnterpriseCompletionsData.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import { useQuery } from '@tanstack/react-query'; | ||
| import _ from 'lodash'; | ||
|
|
||
| import { useMemo } from 'react'; | ||
| import { ANALYTICS_TABS, generateKey } from '../constants'; | ||
| import { applyGranularity, applyCalculation } from '../utils'; | ||
| import EnterpriseDataApiService from '../../../../data/services/EnterpriseDataApiService'; | ||
|
|
||
| /** | ||
| Applies data transformations to the response data. | ||
| Apply transformations to the response data based on the granularity and calculation. Data transformation is applied | ||
| only on the items with the allowed enrollment types. | ||
| * @param {object} response - The response data returned from the API. | ||
| * @param {OpUnitType} granularity - Granularity of the data. e.g. `day`, `week`, `month`, `quarter`, `year`. | ||
| * @param {String} calculation - Calculation to apply on the data. e.g. | ||
| * `total`, `running_total`, `moving_average_3_periods`, `moving_average_7_periods`. | ||
| * @param {Array} allowedEnrollTypes - Allowed enrollment types to consider. e.g. [`certificate`, `audit`]. | ||
| */ | ||
| const applyDataTransformations = (response, granularity, calculation, allowedEnrollTypes = ['certificate', 'audit']) => { | ||
| const modifiedResponse = _.cloneDeep(response); | ||
| if (modifiedResponse?.data?.completionsOverTime) { | ||
| let completionsOverTime = []; | ||
| for (let i = 0; i < allowedEnrollTypes.length; i++) { | ||
| const data = applyGranularity( | ||
| modifiedResponse.data.completionsOverTime.filter( | ||
| completion => completion.enrollType === allowedEnrollTypes[i], | ||
| ), | ||
| 'passedDate', | ||
| 'completionCount', | ||
| granularity, | ||
| ); | ||
| completionsOverTime = completionsOverTime.concat( | ||
| applyCalculation(data, 'completionCount', calculation), | ||
| ); | ||
| } | ||
|
|
||
| modifiedResponse.data.completionsOverTime = completionsOverTime; | ||
| } | ||
|
|
||
| return modifiedResponse; | ||
| }; | ||
|
|
||
| /** | ||
| Fetches enterprise completion data. | ||
| * @param {String} enterpriseCustomerUUID - UUID of the enterprise customer. | ||
| * @param {Date} startDate - Start date for the data. | ||
| * @param {Date} endDate - End date for the data. | ||
| * @param {OpUnitType} granularity - Granularity of the data. e.g. `day`, `week`, `month`, `quarter`, `year`. | ||
| * @param {String} calculation - Calculation to apply on the data. e.g. | ||
| * `total`, `running_total`, `moving_average_3_periods`, `moving_average_7_periods`. | ||
| * @param {object} queryOptions - Additional options for the query. | ||
| */ | ||
| const useEnterpriseCompletionsData = ({ | ||
| enterpriseCustomerUUID, | ||
| startDate, | ||
| endDate, | ||
| granularity = undefined, | ||
| calculation = undefined, | ||
| queryOptions = {}, | ||
| }) => { | ||
| const requestOptions = { startDate, endDate }; | ||
| const response = useQuery({ | ||
| queryKey: generateKey('completions', enterpriseCustomerUUID, requestOptions), | ||
| queryFn: () => EnterpriseDataApiService.fetchAdminAnalyticsData( | ||
| enterpriseCustomerUUID, | ||
| ANALYTICS_TABS.COMPLETIONS, | ||
| requestOptions, | ||
| ), | ||
| staleTime: 0.5 * (1000 * 60 * 60), // 30 minutes. The time in milliseconds after data is considered stale. | ||
| cacheTime: 0.75 * (1000 * 60 * 60), // 45 minutes. Cache data will be garbage collected after this duration. | ||
| keepPreviousData: true, | ||
| ...queryOptions, | ||
| }); | ||
|
|
||
| return useMemo(() => applyDataTransformations( | ||
| response, | ||
| granularity, | ||
| calculation, | ||
| ), [response, granularity, calculation]); | ||
| }; | ||
|
|
||
| export default useEnterpriseCompletionsData; |
85 changes: 85 additions & 0 deletions
85
src/components/AdvanceAnalyticsV2/data/hooks/useEnterpriseEngagementData.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import { useQuery } from '@tanstack/react-query'; | ||
| import _ from 'lodash'; | ||
|
|
||
| import { useMemo } from 'react'; | ||
| import { ANALYTICS_TABS, generateKey } from '../constants'; | ||
| import { applyGranularity, applyCalculation } from '../utils'; | ||
| import EnterpriseDataApiService from '../../../../data/services/EnterpriseDataApiService'; | ||
|
|
||
| /** | ||
| Applies data transformations to the response data. | ||
| Apply transformations to the response data based on the granularity and calculation. Data transformation is applied | ||
| only on the items with the allowed enrollment types. | ||
| * @param {object} response - The response data returned from the API. | ||
| * @param {OpUnitType} granularity - Granularity of the data. e.g. `day`, `week`, `month`, `quarter`, `year`. | ||
| * @param {String} calculation - Calculation to apply on the data. e.g. | ||
| * `total`, `running_total`, `moving_average_3_periods`, `moving_average_7_periods`. | ||
| * @param {Array} allowedEnrollTypes - Allowed enrollment types to consider. e.g. [`certificate`, `audit`]. | ||
| */ | ||
| const applyDataTransformations = (response, granularity, calculation, allowedEnrollTypes = ['certificate', 'audit']) => { | ||
| const modifiedResponse = _.cloneDeep(response); | ||
| if (modifiedResponse?.data?.engagementOverTime) { | ||
| let engagementOverTime = []; | ||
| for (let i = 0; i < allowedEnrollTypes.length; i++) { | ||
| const data = applyGranularity( | ||
| modifiedResponse.data.engagementOverTime.filter( | ||
| engagement => engagement.enrollType === allowedEnrollTypes[i], | ||
| ), | ||
| 'activityDate', | ||
| 'learningTimeHours', | ||
| granularity, | ||
| ); | ||
| engagementOverTime = engagementOverTime.concat( | ||
| applyCalculation(data, 'learningTimeHours', calculation), | ||
| ); | ||
| } | ||
|
|
||
| modifiedResponse.data.engagementOverTime = engagementOverTime; | ||
| } | ||
|
|
||
| return modifiedResponse; | ||
| }; | ||
|
|
||
| /** | ||
| Fetches enterprise engagement data. | ||
| * @param {String} enterpriseCustomerUUID - UUID of the enterprise customer. | ||
| * @param {Date} startDate - Start date for the data. | ||
| * @param {Date} endDate - End date for the data. | ||
| * @param {OpUnitType} granularity - Granularity of the data. e.g. `day`, `week`, `month`, `quarter`, `year`. | ||
| * @param {String} calculation - Calculation to apply on the data. e.g. | ||
| * `total`, `running_total`, `moving_average_3_periods`, `moving_average_7_periods`. | ||
| * @param {object} queryOptions - Additional options for the query. | ||
| */ | ||
| const useEnterpriseEngagementData = ({ | ||
| enterpriseCustomerUUID, | ||
| startDate, | ||
| endDate, | ||
| granularity = undefined, | ||
| calculation = undefined, | ||
| queryOptions = {}, | ||
| }) => { | ||
| const requestOptions = { startDate, endDate }; | ||
| const response = useQuery({ | ||
| queryKey: generateKey('engagements', enterpriseCustomerUUID, requestOptions), | ||
| queryFn: () => EnterpriseDataApiService.fetchAdminAnalyticsData( | ||
| enterpriseCustomerUUID, | ||
| ANALYTICS_TABS.ENGAGEMENTS, | ||
| requestOptions, | ||
| ), | ||
| staleTime: 0.5 * (1000 * 60 * 60), // 30 minutes. The time in milliseconds after data is considered stale. | ||
| cacheTime: 0.75 * (1000 * 60 * 60), // 45 minutes. Cache data will be garbage collected after this duration. | ||
| keepPreviousData: true, | ||
| ...queryOptions, | ||
| }); | ||
|
|
||
| return useMemo(() => applyDataTransformations( | ||
| response, | ||
| granularity, | ||
| calculation, | ||
| ), [response, granularity, calculation]); | ||
| }; | ||
|
|
||
| export default useEnterpriseEngagementData; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.