[ui-Quick Start-Analytics] Updating the analytics Frontend code by integrating with new public API and using predefined hooks #4126

ananya-agarwal · 2025-04-23T09:15:07Z

What changes were proposed in this pull request?

Updating the analytics Frontend code by integrating with new public API sent by backend which was updated in the PR:
https://github.com/cloudera/hue/pull/4117/files
and #4171

How was this patch tested?

The Analytics unit test has also been modified, manual testing

Updated:

Screen.Recording.2025-07-14.at.2.52.55.PM.mov

Please review Hue Contributing Guide before opening a pull request.

github-actions · 2025-04-23T09:15:25Z

✅ Test files were modified. Ensure that the tests cover all relevant changes. ✅

ramprasadagarwal

Nice work.

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx

github-actions · 2025-04-23T09:53:36Z

Python Coverage Report •

File	Stmts	Miss	Cover	Missing
TOTAL	54185	27078	50%

report-only-changed-files is enabled. No files were changed during this commit :)

Pytest Report

Tests	Skipped	Failures	Errors	Time
1186	106 💤	0 ❌	0 🔥	6m 1s ⏱️

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx

github-actions · 2025-06-06T09:36:05Z

UI Code Coverage Report

Lines	Statements	Branches	Functions
	39.45% (30813/78089)	31.19% (14353/46009)	24.74% (2215/8953)

github-actions · 2025-06-06T09:47:15Z

Backend Code Coverage Report •

File	Stmts	Miss	Cover	Missing
TOTAL	54738	27398	49%

report-only-changed-files is enabled. No files were changed during this commit :)

bjornalm

LGTM

desktop/core/src/desktop/js/apps/admin/Components/utils.ts

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx

Copilot

Pull Request Overview

This pull request updates the analytics frontend code to integrate with a new public API for usage analytics settings. The changes replace the old preferences API endpoint with a new usage analytics API and implement modern React patterns using predefined hooks for data management.

Key changes:

Replaces API endpoint from /about/update_preferences to /api/v1/usage_analytics
Migrates from local state management to useLoadData and useSaveData hooks
Adds comprehensive error handling and loading states with LoadingErrorWrapper

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
Analytics.tsx	Complete refactor to use new API endpoint and modern React hooks for data fetching/saving
utils.ts	Updates API URL constant to point to new usage analytics endpoint
api.py	Adds POST method support for the new analytics API (temporary workaround)
OverviewTab.test.tsx	Extensive test suite updates with new mock configurations and comprehensive test coverage

Comments suppressed due to low confidence (1)

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx:67

[nitpick] The function name 'handleAnalyticsCheckboxChange' is redundant since it's already in the Analytics component context. Consider renaming to 'handleCheckboxChange' for brevity and consistency with the previous implementation.

  const handleAnalyticsCheckboxChange = (event: React.ChangeEvent<HTMLInputElement>) => {

apps/about/src/about/api.py

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

ramprasadagarwal · 2025-07-28T14:05:37Z

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

+  publish: jest.fn()
+}));
+
+jest.mock(


Do we really need to mock this?

ramprasadagarwal · 2025-07-28T14:07:42Z

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

      (post as jest.Mock).mockImplementation(() =>
        Promise.resolve({ status: 0, message: 'Success' })
      );
    });

+    test('fetch and display available apps', async () => {


We follow it('should pattern for starting the test case description.
Although test(' is also correct but for consistency lets stick to it('should

ramprasadagarwal · 2025-07-28T14:16:07Z

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

+      expect(post).toHaveBeenCalledWith(USAGE_ANALYTICS_API_URL, data, expectedPostOptions);
+    };
+
+    const expectSuccessMessage = (message: string) => {


There is no point in creating a function for a single expect.
To maintain consistency in the codebase, write the expected directly in the test.

Same for other expect functions

ramprasadagarwal · 2025-07-28T14:16:59Z

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

+      qsEncodeData: false
+    };
+
+    const waitForInitialDataLoad = async () => {


this function is used only once, why not write the expect of this function directly into renderAnalyticsAndWaitForLoad

ramprasadagarwal · 2025-07-28T14:19:07Z

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx

+      await userEvent.click(checkbox);
+
+      await waitFor(() => {
+        expect(get).toHaveBeenCalledWith(USAGE_ANALYTICS_API_URL, undefined, expectedFetchOptions);


This get would have been called when the component was loading, too.
Maybe check if the get has been called twice.
One for initial load and one for refetching the data.

ananya-agarwal requested review from tabraiz12, JohanAhlen, bjornalm, ramprasadagarwal and Harshg999 April 23, 2025 09:15

ramprasadagarwal reviewed Apr 23, 2025

View reviewed changes

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx Outdated Show resolved Hide resolved

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx Outdated Show resolved Hide resolved

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx Outdated Show resolved Hide resolved

bjornalm reviewed May 5, 2025

View reviewed changes

ananya-agarwal changed the title ~~[ui-Quick Start-Analytics] Updating the analytics Frontend code by integrating with new public API~~ [ui-Quick Start-Analytics] Updating the analytics Frontend code by integrating with new public API and using predefined hooks May 13, 2025

ananya-agarwal force-pushed the aticks branch from 3772112 to 865dda6 Compare May 13, 2025 09:50

ananya-agarwal requested review from bjornalm and ramprasadagarwal May 15, 2025 13:12

ananya-agarwal force-pushed the aticks branch from 8281626 to d43b0af Compare May 15, 2025 13:58

ramprasadagarwal requested changes May 16, 2025

View reviewed changes

ananya-agarwal force-pushed the aticks branch 2 times, most recently from 5a620d6 to 8d1d537 Compare May 24, 2025 09:27

bjornalm requested a review from Copilot May 30, 2025 08:05

This comment was marked as outdated.

Sign in to view

ananya-agarwal force-pushed the aticks branch 4 times, most recently from 0a58cba to 915f373 Compare June 6, 2025 09:31

ananya-agarwal force-pushed the aticks branch 2 times, most recently from 88e988b to 82e7194 Compare June 10, 2025 07:22

bjornalm approved these changes Jun 12, 2025

View reviewed changes

desktop/core/src/desktop/js/apps/admin/Components/utils.ts Outdated Show resolved Hide resolved

bjornalm reviewed Jun 12, 2025

View reviewed changes

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx Outdated Show resolved Hide resolved

bjornalm reviewed Jun 12, 2025

View reviewed changes

desktop/core/src/desktop/js/apps/admin/Overview/Analytics.tsx Outdated Show resolved Hide resolved

ananya-agarwal added 2 commits July 8, 2025 15:48

Optimized unit tests

19c2b82

changing to json content type

dca8475

ananya-agarwal force-pushed the aticks branch from a7c869f to dca8475 Compare July 8, 2025 10:19

ananya-agarwal requested review from bjornalm, Harshg999 and Copilot July 8, 2025 10:51

This comment was marked as outdated.

Sign in to view

ananya-agarwal added 4 commits July 8, 2025 17:07

Not fully correct after the new api

ec0a87d

Merge branch 'master' into aticks

4846297

Fixed new api changes

37d29bb

Added unit tests for the updated analytics tab

bd85e7b

ananya-agarwal requested a review from Copilot July 14, 2025 09:50

This comment was marked as outdated.

Sign in to view

Fixing the checks on gitHub

98c272c

ananya-agarwal requested a review from Copilot July 14, 2025 10:10

This comment was marked as outdated.

Sign in to view

Optimizing unit tests

47ca7d3

ananya-agarwal requested a review from Copilot July 14, 2025 10:18

This comment was marked as outdated.

Sign in to view

Merge branch 'master' into aticks

4988416

ananya-agarwal force-pushed the aticks branch from 8105ecf to 4988416 Compare July 16, 2025 08:58

ananya-agarwal requested a review from Copilot July 16, 2025 11:14

This comment was marked as outdated.

Sign in to view

ananya-agarwal requested a review from Copilot July 16, 2025 11:15

This comment was marked as outdated.

Sign in to view

ananya-agarwal requested a review from Copilot July 22, 2025 10:38

Copilot AI reviewed Jul 22, 2025

View reviewed changes

apps/about/src/about/api.py Show resolved Hide resolved

desktop/core/src/desktop/js/apps/admin/Overview/OverviewTab.test.tsx Show resolved Hide resolved

ananya-agarwal added 2 commits July 28, 2025 15:51

Merge branch 'master' into aticks

6ba2cdc

Fixing backend tests

064caa6

ramprasadagarwal requested changes Jul 28, 2025

View reviewed changes

[ui-Quick Start-Analytics] Updating the analytics Frontend code by integrating with new public API and using predefined hooks #4126

Are you sure you want to change the base?

[ui-Quick Start-Analytics] Updating the analytics Frontend code by integrating with new public API and using predefined hooks #4126

Uh oh!

Conversation

ananya-agarwal commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

How was this patch tested?

Uh oh!

github-actions bot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ramprasadagarwal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pytest Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

github-actions bot commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

UI Code Coverage Report

Uh oh!

github-actions bot commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bjornalm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

ramprasadagarwal Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ramprasadagarwal Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ramprasadagarwal Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

ananya-agarwal commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Jun 6, 2025 •

edited

Loading

github-actions bot commented Jun 6, 2025 •

edited

Loading