Metadata for user orgunits in analytics response [2.41-dhis2-15933] #15451

d-bernat · 2023-10-21T18:03:45Z

please see https://dhis2.atlassian.net/browse/DHIS2-15933

…933]

...ice-analytics/src/main/java/org/hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java

codecov · 2023-10-23T20:20:35Z

Codecov Report

Merging #15451 (6f2031a) into master (ada6f8a) will increase coverage by 0.02%.
Report is 5 commits behind head on master.
The diff coverage is 92.04%.

@@             Coverage Diff              @@
##             master   #15451      +/-   ##
============================================
+ Coverage     66.10%   66.13%   +0.02%     
- Complexity    31115    31138      +23     
============================================
  Files          3484     3486       +2     
  Lines        129448   129525      +77     
  Branches      15095    15104       +9     
============================================
+ Hits          85577    85655      +78     
+ Misses        36792    36788       -4     
- Partials       7079     7082       +3

Flag	Coverage Δ
integration	`49.69% <39.77%> (-0.02%)`	⬇️
integration-h2	`32.47% <34.09%> (+0.02%)`	⬆️
unit	`30.33% <85.22%> (+0.04%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
.../org/hisp/dhis/analytics/AnalyticsMetaDataKey.java	`100.00% <100.00%> (ø)`
...in/java/org/hisp/dhis/common/DataQueryRequest.java	`61.68% <100.00%> (+0.72%)`	⬆️
.../java/org/hisp/dhis/analytics/DataQueryParams.java	`80.75% <100.00%> (+0.10%)`	⬆️
...p/dhis/analytics/data/DefaultDataQueryService.java	`81.33% <100.00%> (+0.12%)`	⬆️
...p/dhis/analytics/data/handler/MetadataHandler.java	`68.08% <100.00%> (+2.96%)`	⬆️
...rg/hisp/dhis/analytics/event/EventQueryParams.java	`78.93% <100.00%> (+0.17%)`	⬆️
.../event/data/DefaultEnrollmentAnalyticsService.java	`75.00% <100.00%> (ø)`
...ytics/event/data/DefaultEventAnalyticsService.java	`32.43% <100.00%> (ø)`
...ytics/event/data/DefaultEventDataQueryService.java	`84.55% <100.00%> (+0.05%)`	⬆️
...va/org/hisp/dhis/common/EventDataQueryRequest.java	`69.69% <66.66%> (-0.06%)`	⬇️
... and 3 more

... and 15 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8ed6fd5...6f2031a. Read the comment docs.

dhis-2/dhis-api/src/test/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtilsTest.java

+import org.hisp.dhis.common.EventsAnalyticsQueryCriteria;
+import org.junit.jupiter.api.Test;
+
+class OrganisationUnitCriteriaUtilsTest {


dhis-2/dhis-api/src/main/java/org/hisp/dhis/analytics/AnalyticsMetaDataKey.java

maikelarabori

Added a few suggestions 👍
Also, this same logic should be applied to the TEI/Cross Program API (I believe). The UI requests are built using the same components and are read on the same page.

dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtils.java

maikelarabori · 2023-10-24T07:50:13Z

dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtils.java

+  }
+
+  /**
+   * Transform criteria in the string


What does it mean ("Transform criteria in the string")?
Would be nice to describe what the method actually does, including an example of a possible output.

maikelarabori · 2023-10-24T08:07:08Z

dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtils.java

+        : StringUtils.EMPTY;
+  }
+
+  private static boolean hasDimensions(Set<String> dimensions) {


You don't need to create this additional method...
You could use CollectionUtils.isNotEmpty(criteria.getDimension())

dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtils.java

maikelarabori · 2023-10-24T09:17:39Z

...ice-analytics/src/main/java/org/hisp/dhis/analytics/event/data/AbstractAnalyticsService.java

+              currentUserService.getCurrentUser(), params.getUserOrganisationUnitsCriteria())
+          .forEach(items::putAll);
+
+      if (params.isComingFromQuery()) {


Could we concentrate all the logic of the if/else related to

params.isComingFromQuery()

on the same block? ie:

if (params.isComingFromQuery()) { items.putAll(getMetadataItems(params, periodKeywords, optionItems, grid)); metadata.put( DIMENSIONS.getKey(), getDimensionItems(params, Optional.of(optionsPresentInGrid))); } else { items.putAll(getMetadataItems(params)); metadata.put(DIMENSIONS.getKey(), getDimensionItems(params, empty())); } metadata.put(ITEMS.getKey(), items);

Or is it going to have a side affect?

The items will change the place with dimensions. I thing this should not be a problem, should I change it?
Do not forget, it will affect most likely our e2e tests and som unit tests as well.

So, it may have a side effect. We never know if someone is relying on this order.
Let's leave it for now.

...ice-analytics/src/main/java/org/hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

…hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java Co-authored-by: Maikel Arabori <[email protected]>

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

sonarqubecloud · 2023-10-24T10:05:49Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

maikelarabori · 2023-10-24T10:25:20Z

...ice-analytics/src/main/java/org/hisp/dhis/analytics/event/data/AbstractAnalyticsService.java

+              currentUserService.getCurrentUser(), params.getUserOrganisationUnitsCriteria())
+          .forEach(items::putAll);
+
+      if (params.isComingFromQuery()) {


So, it may have a side effect. We never know if someone is relying on this order.
Let's leave it for now.

dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationUnitCriteriaUtils.java

+   * Transform request criteria into a comma separated string
+   * (USER_ORG_UNIT,USER_ORGUNIT_CHILDREN,USER_ORGUNIT_GRANDCHILDREN)
+   *
+   * @param dimensions, set of the requested dimensions


d-bernat added 3 commits October 19, 2023 09:05

feat: Metadata for user orgunits in analytics response [2.41-DHIS2-15…

b5a29d1

…933]

org units and uid lists

f7dc449

final refactoring

b39d8ee

github-advanced-security bot found potential problems Oct 21, 2023

View reviewed changes

...ice-analytics/src/main/java/org/hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java Fixed Show fixed Hide fixed

d-bernat added 3 commits October 21, 2023 22:35

Merge branch 'master' into 2.41-DHIS2-15933

74d4a7d

clean coding

29fc290

clean coding

2751f15

github-advanced-security bot found potential problems Oct 22, 2023

View reviewed changes

...ice-analytics/src/main/java/org/hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java Fixed Show fixed Hide fixed

d-bernat added 3 commits October 23, 2023 10:05

unit test fix

0ee22bb

formatting

88cc2a7

QA issues

8fd8cb2

d-bernat added the run-api-analytics-tests Enables analytics e2e tests label Oct 23, 2023

d-bernat added 4 commits October 23, 2023 20:13

unit tests

e1f9d4b

Merge branch 'master' into 2.41-DHIS2-15933

9f5ff49

clean coding

caeeca4

unit tests

992e3a2

unit tests and fix

667edce

github-advanced-security bot found potential problems Oct 23, 2023

View reviewed changes

d-bernat added 6 commits October 24, 2023 07:29

clean coding

df1884f

clean coding, comments

fa687df

e2e test

15668b3

formatting

4c28912

Merge branch 'master' into 2.41-DHIS2-15933

e640a97

Merge branch 'master' into 2.41-DHIS2-15933

60b543c

d-bernat changed the title ~~DRAFT: Metadata for user orgunits in analytics response [2.41-dhis2-15933]~~ Metadata for user orgunits in analytics response [2.41-dhis2-15933] Oct 24, 2023

d-bernat requested review from maikelarabori and gnespolino October 24, 2023 06:52

gnespolino approved these changes Oct 24, 2023

View reviewed changes

dhis-2/dhis-api/src/main/java/org/hisp/dhis/analytics/AnalyticsMetaDataKey.java Show resolved Hide resolved

dhis-2/dhis-api/src/main/java/org/hisp/dhis/analytics/AnalyticsMetaDataKey.java Show resolved Hide resolved

maikelarabori requested changes Oct 24, 2023

View reviewed changes

d-bernat and others added 8 commits October 24, 2023 11:28

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationU…

fb3ff2a

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/…

bd4e9d5

…hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/…

5cc8c4f

…hisp/dhis/analytics/util/AnalyticsOrganisationUnitUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationU…

5b187d0

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationU…

9c00522

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationU…

4e3d1f6

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

Update dhis-2/dhis-api/src/main/java/org/hisp/dhis/util/OrganisationU…

fce8676

…nitCriteriaUtils.java Co-authored-by: Maikel Arabori <[email protected]>

post code review

8bc8533

d-bernat requested a review from maikelarabori October 24, 2023 09:44

d-bernat added 2 commits October 24, 2023 11:55

post code review

a67ce7c

post code review

6f2031a

maikelarabori approved these changes Oct 24, 2023

View reviewed changes

github-advanced-security bot found potential problems Oct 24, 2023

View reviewed changes

d-bernat merged commit 95b7afe into master Oct 24, 2023
18 checks passed

d-bernat deleted the 2.41-DHIS2-15933 branch October 24, 2023 10:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metadata for user orgunits in analytics response [2.41-dhis2-15933] #15451

Metadata for user orgunits in analytics response [2.41-dhis2-15933] #15451

d-bernat commented Oct 21, 2023

codecov bot commented Oct 23, 2023 •

edited

Loading

maikelarabori left a comment

maikelarabori Oct 24, 2023

d-bernat Oct 24, 2023

maikelarabori Oct 24, 2023

d-bernat Oct 24, 2023

maikelarabori Oct 24, 2023

d-bernat Oct 24, 2023 •

edited

Loading

maikelarabori Oct 24, 2023

sonarqubecloud bot commented Oct 24, 2023

maikelarabori Oct 24, 2023

Metadata for user orgunits in analytics response [2.41-dhis2-15933] #15451

Metadata for user orgunits in analytics response [2.41-dhis2-15933] #15451

Conversation

d-bernat commented Oct 21, 2023

codecov bot commented Oct 23, 2023 • edited Loading

Codecov Report

maikelarabori left a comment

Choose a reason for hiding this comment

maikelarabori Oct 24, 2023

Choose a reason for hiding this comment

d-bernat Oct 24, 2023

Choose a reason for hiding this comment

maikelarabori Oct 24, 2023

Choose a reason for hiding this comment

d-bernat Oct 24, 2023

Choose a reason for hiding this comment

maikelarabori Oct 24, 2023

Choose a reason for hiding this comment

d-bernat Oct 24, 2023 • edited Loading

Choose a reason for hiding this comment

maikelarabori Oct 24, 2023

Choose a reason for hiding this comment

sonarqubecloud bot commented Oct 24, 2023

maikelarabori Oct 24, 2023

Choose a reason for hiding this comment

codecov bot commented Oct 23, 2023 •

edited

Loading

d-bernat Oct 24, 2023 •

edited

Loading