Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[3523] Support rounding dates when changing dates from gantt #3617

Merged
merged 1 commit into from
Jun 20, 2024
Merged

[3523] Support rounding dates when changing dates from gantt #3617

merged 1 commit into from
Jun 20, 2024

Conversation

lfasani
Copy link
Contributor

@lfasani lfasani commented Jun 12, 2024

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?

@lfasani lfasani added this to the 2024.7.0 milestone Jun 12, 2024
@lfasani lfasani self-assigned this Jun 12, 2024
@lfasani lfasani force-pushed the lfa/enh/dateRounding branch from ae137e9 to 95e897d Compare June 14, 2024 10:14
@sbegaudeau sbegaudeau linked an issue Jun 16, 2024 that may be closed by this pull request
When moving a task in Gantt, have the ability to define how to round start and end dates #3523
Closed
1 task
sbegaudeau
sbegaudeau previously requested changes Jun 16, 2024
View reviewed changes
packages/gantt/frontend/sirius-components-gantt/src/helper/helper.tsx
}
};

export const checkIsHoliday = (date: Date, _, __, dateExtremity: DateExtremity) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is supposed to be the definition of a holiday? We have end users pretty much in every continent and people may not agree on your definition of holiday.

Copy link
Contributor Author

@lfasani lfasani Jun 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, holiday is hard coded for Saturday and Sunday.
I have made some changes in gantt-task-react so that it would work fine if holiday is implemented differently by the client (sirius-web). But, the feature to delegate the holiday definition to the specifier is not done in sirius-web.
I will add a comment in in the code and anyway it will be indicated in the user doc

packages/gantt/frontend/sirius-components-gantt/src/helper/helper.tsx Outdated
action: BarMoveAction,
dateMoveStep: String
): Date => {
const regex = /^(\d+)([DHm])$/;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how asking for any string on the backend and parsing that with a regex on the frontend provides an usable API. Don't use regex!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I needed a simple solution for this time frame.
The string is composed of an integer and a letter (corresponding to the time unit from ISO 8601).
It will be explained in the specifier documentation.
If the string does not follow the expected syntax, it will fall back to 1 day date rounding.
But I agree with you, we should ensure a good syntax on backend (rule at saving?, validation rule?) I did not think about this part.
On the other hand, I preferred a single field to avoid shattering information in the GanttDescription and the ideal solution of having a field (value + dimension) was an enhancement in and of itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the graphQL API two have a type GanttDateRounding composed of an integer value and an enum

@lfasani lfasani force-pushed the lfa/enh/dateRounding branch 4 times, most recently from 90448fd to 9b76439 Compare June 19, 2024 12:35
@lfasani lfasani marked this pull request as ready for review June 19, 2024 12:38
@lfasani lfasani requested a review from pcdavid as a code owner June 19, 2024 12:38
@lfasani lfasani requested a review from frouene June 19, 2024 12:38
@lfasani lfasani force-pushed the lfa/enh/dateRounding branch from 9b76439 to 9fca544 Compare June 19, 2024 12:42
@lfasani @frouene
[3523] Support rounding dates when changing dates from gantt
99b21f5 
Bug: #3523
Signed-off-by: Laurent Fasani <[email protected]>
Signed-off-by: Florian ROUËNÉ <[email protected]>
@frouene frouene force-pushed the lfa/enh/dateRounding branch from 9fca544 to 99b21f5 Compare June 19, 2024 13:38
@frouene frouene dismissed sbegaudeau’s stale review June 20, 2024 07:43

API corrected and cleaned up

@frouene frouene merged commit a0110f2 into master Jun 20, 2024
4 checks passed
@frouene frouene deleted the lfa/enh/dateRounding branch June 20, 2024 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouene frouene frouene approved these changes

@sbegaudeau sbegaudeau sbegaudeau left review comments

@pcdavid pcdavid Awaiting requested review from pcdavid pcdavid is a code owner

Assignees

@lfasani lfasani

Labels
pr: to review soon priority: high
Projects
None yet
Milestone
2024.7.0
Development

Successfully merging this pull request may close these issues.

When moving a task in Gantt, have the ability to define how to round start and end dates
3 participants
@lfasani @sbegaudeau @frouene