[#57529] Add options for sum totals calculation mode in hierarchies #16649

aaron-contreras · 2024-09-06T12:54:15Z

Ticket

https://community.openproject.org/work_packages/57529

What are you trying to accomplish?

Adding a new setting in order to allow users to determine the way in which they'd like sum totals of percent complete in work package hierarchies to be calculated.

Simple average (default): Work is ignored and the total % Complete will be a simple average of % Complete values of work packages in the hierarchy.
Weighted by work: The total % Complete will be weighted against the Work of each work package in the hierarchy. Work packages without Work will be ignored.

Screenshots

Not yet

What approach did you choose and why?

Extend the UpdateAncestorsService to calculate the total % complete based on the current Setting value.
Add a radio group entry to the progress tracking settings page to be able to toggle between the modes.
Add a job that recalculates all total % complete values that gets triggered when the mode is changed in the settings page.

Merge checklist

Added/updated tests
Added/updated documentation in Lookbook (patterns, previews, etc)
Tested major browsers (Chrome, Firefox, Edge, ...)

* Adds the settings to the definitions file. * Sets the default and allowed values.

* Adds setting into derivation code. * Adds specs for the simple average mode calculation.

Now the settings can be changed from the UI.

* Fixes cuprite flag to enable cuprite in this spec file.

* Missing to add journal entries

Calculation of % Complete hierarchy totals should be the second setting on the form

* Triggers job * Adds journal entries with specs and translations

* Adds temporary depth table - Could be cleaned up down thie line with the `work_package_hierarchies` table.

…e mode

cbliard

Nice work so far 👏

I only looked at code so far. I need to play a bit with it now.

spec/features/admin/progress_tracking_spec.rb

app/services/settings/update_service.rb

spec/services/work_packages/update_ancestors_service_spec.rb

In `WorkPackages::UpdateAncestors::Loader`, the returned elements are not always `WorkPackageLikeStruct` instances: whenever possible the loader reuses knows instances of `WorkPackage` when looking for ancestors or descendants.

app/services/work_packages/update_ancestors_service.rb

In this case, there is no calculated simple average: the ∑ % Complete should be cleared.

I'm not sure why it fails now while it did not before. Maybe it's when switching to cuprite. Anyway this test is not worth enough to bother fixing it.

Just to be extra-sure this case is handled correctly in jobs as well.

Simpler.

Reuse and duplicate a lot of logic from the other job. It needs to be reworked, but it works

…ation-sum-mode

cbliard

Well done. I think it's good to go now.

cbliard · 2024-09-26T05:49:38Z

app/workers/work_packages/progress/sql_commands.rb

@@ -188,7 +188,6 @@ def update_totals
    if Setting.total_percent_complete_mode == "work_weighted_average"
      update_total_percent_complete_in_work_weighted_average_mode
    elsif Setting.total_percent_complete_mode == "simple_average"
-      update_total_percent_complete_in_work_weighted_average_mode


aaron-contreras self-assigned this Sep 6, 2024

aaron-contreras added the feature label Sep 6, 2024

aaron-contreras added this to the 14.6.x milestone Sep 6, 2024

aaron-contreras force-pushed the implementation/57529-options-for-total-calculation-sum-mode branch 5 times, most recently from 329b1ac to a630784 Compare September 12, 2024 17:39

aaron-contreras force-pushed the implementation/57529-options-for-total-calculation-sum-mode branch 5 times, most recently from 677ecbb to dfddcbb Compare September 20, 2024 16:43

cbliard added the pullpreview label Sep 23, 2024

aaron-contreras force-pushed the implementation/57529-options-for-total-calculation-sum-mode branch from 0bd1e6d to bc12c60 Compare September 23, 2024 22:54

aaron-contreras added 8 commits September 24, 2024 11:03

Create setting for Calculation of % Complete hierarchy totals

291b87b

* Adds the settings to the definitions file. * Sets the default and allowed values.

Incorporate simple average mode into total % complete calculations

b92e9d1

* Adds setting into derivation code. * Adds specs for the simple average mode calculation.

Adjust selection of done ratio based on new rules for children

53a3a72

Add radio group to progress tracking form

793d758

Now the settings can be changed from the UI.

Add feature spec for setting toggling

06bd83f

* Fixes cuprite flag to enable cuprite in this spec file.

Add recalculation in job when switching to work weighted mode

503ad15

* Missing to add journal entries

Re-order radio group options according to design document

5e36ce2

Calculation of % Complete hierarchy totals should be the second setting on the form

Trigger the recalculation job when changing to work weighted mode

6cbfdc8

* Triggers job * Adds journal entries with specs and translations

aaron-contreras force-pushed the implementation/57529-options-for-total-calculation-sum-mode branch 2 times, most recently from 36ae30b to 27e5d87 Compare September 24, 2024 18:39

aaron-contreras added 2 commits September 24, 2024 16:35

Add in simple average calculation mode job

2f2561c

* Adds temporary depth table - Could be cleaned up down thie line with the `work_package_hierarchies` table.

Account for status exclusion from total calculations in simple averag…

1f12393

…e mode

aaron-contreras force-pushed the implementation/57529-options-for-total-calculation-sum-mode branch from 27e5d87 to 1f12393 Compare September 24, 2024 21:56

cbliard reviewed Sep 25, 2024

View reviewed changes

spec/features/admin/progress_tracking_spec.rb Outdated Show resolved Hide resolved

app/services/settings/update_service.rb Outdated Show resolved Hide resolved

cbliard reviewed Sep 25, 2024

View reviewed changes

spec/services/work_packages/update_ancestors_service_spec.rb Outdated Show resolved Hide resolved

cbliard reviewed Sep 25, 2024

View reviewed changes

app/services/work_packages/update_ancestors_service.rb Show resolved Hide resolved

cbliard added 5 commits September 25, 2024 12:28

Fix when all work packages of a hierarchy are excluded from totals

f040848

In this case, there is no calculated simple average: the ∑ % Complete should be cleared.

Removed flaky spec

6d9a9c8

I'm not sure why it fails now while it did not before. Maybe it's when switching to cuprite. Anyway this test is not worth enough to bother fixing it.

Fix rubocop warnings Metrics/AbcSize and Metrics/PerceivedComplexity

447a6de

Add a test when all hierarchy is excluded from totals

0f9be1b

Just to be extra-sure this case is handled correctly in jobs as well.

Add failing spec about handling simple average mode in a job

a574b2f

cbliard self-assigned this Sep 25, 2024

cbliard and others added 7 commits September 25, 2024 17:12

Use work_package_hierarchies to create depth table

3f97171

Simpler.

Compute total % complete according to mode in update status job

3250f51

Reuse and duplicate a lot of logic from the other job. It needs to be reworked, but it works

Merge branch 'dev' into implementation/57529-options-for-total-calcul…

946b57d

…ation-sum-mode

Add extra spec specifically accounting for excluded statuses

0edb100

Test for unset total values

5b1dbb4

Remove unnecessary update

95cda6d

Extract common operations to sql_commands

de86221

cbliard approved these changes Sep 26, 2024

View reviewed changes

cbliard marked this pull request as ready for review September 26, 2024 06:10

cbliard merged commit d86dfdc into dev Sep 26, 2024
12 checks passed

cbliard deleted the implementation/57529-options-for-total-calculation-sum-mode branch September 26, 2024 06:10

github-actions bot removed the pullpreview label Sep 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#57529] Add options for sum totals calculation mode in hierarchies #16649

[#57529] Add options for sum totals calculation mode in hierarchies #16649

aaron-contreras commented Sep 6, 2024 •

edited

Loading

cbliard left a comment

cbliard left a comment

cbliard Sep 26, 2024

[#57529] Add options for sum totals calculation mode in hierarchies #16649

[#57529] Add options for sum totals calculation mode in hierarchies #16649

Conversation

aaron-contreras commented Sep 6, 2024 • edited Loading

Ticket

What are you trying to accomplish?

Screenshots

What approach did you choose and why?

Merge checklist

cbliard left a comment

Choose a reason for hiding this comment

cbliard left a comment

Choose a reason for hiding this comment

cbliard Sep 26, 2024

Choose a reason for hiding this comment

aaron-contreras commented Sep 6, 2024 •

edited

Loading