[#634] Support defining sinceDate, untilDate and period in report config #1501

dcshzj · 2021-03-23T08:34:28Z

Fixes #634.
Part of #1360.

The new report-config.json allows for the configuration of the
report generation. However, only the report title can be
configured at this time.

Let's expand the functionality of the report config file by
allowing sinceDate, untilDate and period to be defined as well.
If the CLI arguments were to contain the same settings as those in
the report config, then the CLI arguments will take precedence.

Summary of changes

The report-config.json file now supports setting sinceDate, untilDate and period. The equivalent CLI arguments are --since, --until and --period respectively. (this PR)
The logic for getting the ReportConfiguration object has been moved to ArgsParser. (in PR [#634] Move logic for getting ReportConfiguration to ArgsParser #1534)
DateTime functionality that previously existed in ArgsParser has now been moved to TimeUtil to reduce code duplication. (in PR [#634] Extract time-based functionalities to TimeUtil #1535)

⚠️ Requires

PR [#634] Move logic for getting ReportConfiguration to ArgsParser #1534 to be merged first
PR [#634] Extract time-based functionalities to TimeUtil #1535 to be merged first

The new report-config.json allows for the configuration of the report generation. However, only the report title can be configured at this time. Let's expand the functionality of the report config file by allowing sinceDate, untilDate and period to be defined as well. If the CLI arguments were to contain the same settings as those in the report config, then the CLI arguments will take precedence.

Tejas2805 · 2021-04-09T19:40:39Z

The logic for getting the ReportConfiguration object has been moved to ArgsParser.
DateTime functionality that previously existed in ArgsParser has now been moved to TimeUtil to reduce code duplication.

@dcshzj can you create smaller PRs for these changes. And then after merging those PRs we can go ahead with merging this one. Always remember, smaller neat PRs are preferred as a single PR should bring about only a single change in the repository. This helps in keeping track and reviewing the PR more efficiently.

dcshzj · 2021-04-10T01:06:21Z

@dcshzj can you create smaller PRs for these changes. And then after merging those PRs we can go ahead with merging this one. Always remember, smaller neat PRs are preferred as a single PR should bring about only a single change in the repository. This helps in keeping track and reviewing the PR more efficiently.

@Tejas2805 I have split them to #1534 and #1535. I left this PR intact and will update if those PRs are merged.

dcshzj · 2021-04-23T11:58:12Z

@Tejas2805 The requisite PRs have been merged.

Tejas2805

Left few comments for implementation and logic. Will review tests once this is sorted.

Tejas2805 · 2021-04-24T19:39:31Z

docs/ug/configFiles.md

+
+<box type="info" seamless>
+
+* `sinceDate`, `untilDate` and `period` cannot be declared together and will be ignored if all 3 configuration settings are present in the report configuration.


What's the reason for ignoring all 3? Why not just take since and until in this case, assuming nothing provided in CLI arguments. Don't do changes as of now, just explain the intuition behind this logic for now.

I followed the logic originally present for CLI arguments, whereby if all 3 arguments are provided we will throw an exception. In this case, because it is in report config, I chose to ignore instead of throwing an exception.

Tejas2805 · 2021-04-24T19:44:26Z

src/main/java/reposense/parser/ArgsParser.java

+            } else if (reportConfig.getUntilDate().isPresent()) {
+                tempUntilDate = reportConfig.getUntilDate();
+            }
+


Find the whole logic above a bit cumbersome. There is a better way to avoid a few of the checks by writing the if conditions in a clever manner. I will leave that to you to figure out.

I thought of the following, not sure if that is what you are looking for?

tempPeriod = Optional.ofNullable(cliPeriod.orElse(reportConfig.getPeriod().orElse(null))); tempSinceDate = Optional.ofNullable(cliSinceDate.orElse(reportConfig.getSinceDate().orElse(null))); tempUntilDate = Optional.ofNullable(cliUntilDate.orElse(reportConfig.getUntilDate().orElse(null)));

I meant for the whole page in general. Not just the last three lines. Cause I can see you see checking if arguments are present or not 2/3 times. So I didn't like that part of the logic. Can try to make sure that you check these only once and make it work.

Sorry @Tejas2805 I still can't figure out how to better write this part of the code. My train of thought for this is:

Check if all 3 arguments are provided (either from report config, from CLI, or from both). If yes, we ignore all of them and take only the CLI arguments.

For each of the 3 arguments, if it is given in both the CLI and in the report config, we give the user a warning.

Afterwards, we take only the CLI arguments.

We then process the actual since and until dates, based on the processed information. If both since and until dates are provided (which only happens in CLI), the period is ignored without warning.

I feel that they are all checking different types of conditions, so I can't wrap my head around how to better craft this section.

Tejas2805 · 2021-04-24T19:49:48Z

docs/ug/configFiles.md

+
+* `sinceDate`, `untilDate` and `period` cannot be declared together and will be ignored if all 3 configuration settings are present in the report configuration.
+* CLI arguments takes precedence over the values provided in this report configuration. If the same configuration is set as a CLI argument as well as in the report configuration, the value in the report configuration is ignored.
+* Likewise, if there is a conflict, such as `sinceDate`, `untilDate` and `period` being declared together even though some of them were declared in the report configuration, only the CLI arguments will be taken and the report configuration will be completely ignored.


What if all 3 are provided in the report config itself and nothing is provided as CLI arguments?

Similar to the first part, all 3 will be ignored, as if the user tried to specify all 3 in the CLI arguments instead of the report config.

dcshzj · 2021-05-21T02:16:15Z

@Tejas2805 Left some comments on your input

dcshzj · 2021-06-02T13:48:43Z

@Tejas2805 Any comments?

dcshzj · 2021-06-13T04:03:36Z

@Tejas2805 Can I please have your comments on this?

Tejas2805

Sorry for the late reply. Left a comment.

Tejas2805 · 2021-06-14T05:02:31Z

src/main/java/reposense/parser/ArgsParser.java

+            } else if (reportConfig.getUntilDate().isPresent()) {
+                tempUntilDate = reportConfig.getUntilDate();
+            }
+


I meant for the whole page in general. Not just the last three lines. Cause I can see you see checking if arguments are present or not 2/3 times. So I didn't like that part of the logic. Can try to make sure that you check these only once and make it work.

dcshzj · 2021-07-28T14:25:42Z

Closing this 4-month old PR.

dcshzj added the s.ToReview label Mar 23, 2021

dcshzj requested a review from a team March 23, 2021 08:34

dcshzj changed the title ~~Support defining sinceDate, untilDate and period in report config~~ [#634] Support defining sinceDate, untilDate and period in report config Mar 23, 2021

dcshzj and others added 3 commits March 23, 2021 16:52

Fix time zone issues

98235f9

Merge branch 'master' into 634-sinceuntildate-config

9098cf3

Merge branch 'master' into 634-sinceuntildate-config

6b1e27c

dcshzj requested review from a team and removed request for a team March 29, 2021 05:09

Merge branch 'master' into 634-sinceuntildate-config

3e937fd

0blivious requested review from fzdy1914 and Tejas2805 April 2, 2021 07:13

fzdy1914 requested review from HCY123902 and removed request for a team and fzdy1914 April 5, 2021 07:25

This was referenced Apr 10, 2021

[#634] Move logic for getting ReportConfiguration to ArgsParser #1534

Merged

[#634] Extract time-based functionalities to TimeUtil #1535

Merged

dcshzj added 2 commits April 20, 2021 23:13

Merge branch 'master' into 634-sinceuntildate-config

3ab5761

Merge branch 'master' into 634-sinceuntildate-config

528de49

Tejas2805 requested changes Apr 24, 2021

View reviewed changes

Tejas2805 reviewed Jun 14, 2021

View reviewed changes

dcshzj mentioned this pull request Jul 15, 2021

Allow sinceDate and untilDate to be configured in config files #634

Closed

Merge branch 'master' into 634-sinceuntildate-config

317b687

dcshzj closed this Jul 28, 2021

yhtMinceraft1010X mentioned this pull request Feb 16, 2022

Remove unused variables in Java files #1673

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#634] Support defining sinceDate, untilDate and period in report config #1501

[#634] Support defining sinceDate, untilDate and period in report config #1501

dcshzj commented Mar 23, 2021 •

edited

Loading

Tejas2805 commented Apr 9, 2021

dcshzj commented Apr 10, 2021

dcshzj commented Apr 23, 2021

Tejas2805 left a comment

Tejas2805 Apr 24, 2021

dcshzj Apr 25, 2021

Tejas2805 Apr 24, 2021

dcshzj Apr 25, 2021

Tejas2805 Jun 14, 2021

dcshzj Jul 11, 2021

Tejas2805 Apr 24, 2021

dcshzj Apr 25, 2021

dcshzj commented May 21, 2021

dcshzj commented Jun 2, 2021

dcshzj commented Jun 13, 2021

Tejas2805 left a comment

Tejas2805 Jun 14, 2021

dcshzj commented Jul 28, 2021


		<box type="info" seamless>

		* `sinceDate`, `untilDate` and `period` cannot be declared together and will be ignored if all 3 configuration settings are present in the report configuration.

[#634] Support defining sinceDate, untilDate and period in report config #1501

[#634] Support defining sinceDate, untilDate and period in report config #1501

Conversation

dcshzj commented Mar 23, 2021 • edited Loading

Summary of changes

⚠️ Requires

Tejas2805 commented Apr 9, 2021

dcshzj commented Apr 10, 2021

dcshzj commented Apr 23, 2021

Tejas2805 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcshzj commented May 21, 2021

dcshzj commented Jun 2, 2021

dcshzj commented Jun 13, 2021

Tejas2805 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcshzj commented Jul 28, 2021

dcshzj commented Mar 23, 2021 •

edited

Loading