[OP-19969] Round instead of truncate when formatting a duration from hours - #24776
Open
jtauschl wants to merge 2 commits into
Open
[OP-19969] Round instead of truncate when formatting a duration from hours#24776jtauschl wants to merge 2 commits into
jtauschl wants to merge 2 commits into
Conversation
format_duration_from_hours passed its computed seconds value straight into Duration.new(seconds: ...), whose hash-based constructor (in the ruby-duration gem) truncates via Float#to_i rather than rounding -- e.g. 5.501 hours (19803.6 seconds) silently serialized as "PT5H30M3S" instead of the correctly rounded "PT5H30M4S", losing up to just under a second of precision on any value with a fractional-second remainder. This affects every caller of this shared formatter (work packages, meetings, time entries), not just time entries. Round the seconds value explicitly before constructing the Duration.
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
recheck |
myabc
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a precision bug in the API duration formatter by rounding (instead of truncating) computed seconds when formatting durations from hours, aligning output with expected ISO8601 serialization across affected API representers.
Changes:
- Round
(hours * 3600)to whole seconds before constructingDurationinformat_duration_from_hours. - Update the existing spec to assert the corrected rounding behavior (e.g.,
5.501h -> PT5H30M4S). - Add inline documentation explaining why explicit rounding is required (ruby-duration truncation behavior).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lib/api/v3/utilities/date_time_formatter.rb | Rounds computed seconds for hour-based duration formatting before Duration.new(...).iso8601. |
| spec/lib/api/v3/utilities/date_time_formatter_spec.rb | Updates expectation to validate rounded (not truncated) seconds behavior for hour-based formatting. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+88
to
+92
| # Duration.new truncates its :seconds argument via Float#to_i | ||
| # (ruby-duration gem) rather than rounding -- round explicitly | ||
| # here first so e.g. 3600.9 seconds (1h 0.9s) serializes as | ||
| # PT1H1S, not silently dropped to PT1H. | ||
| Duration.new(seconds: (hours * 3600).round).iso8601 |
…rom_hours The sibling format_duration_from_hours fix in this same PR rounds seconds before constructing Duration.new to avoid its truncation behavior; format_duration_from_days had the identical bug and was left unfixed -- a fractional-day input's seconds still silently lost up to ~1s of precision.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ticket
https://community.openproject.org/wp/OP-19969
Summary
format_duration_from_hourspassed its computed seconds value straight intoDuration.new(seconds: ...), whose hash-based constructor (in theruby-durationgem) truncates viaFloat#to_irather than rounding -- e.g. 5.501 hours (19803.6 seconds) silently serialized as"PT5H30M3S"instead of the correctly rounded"PT5H30M4S", losing up to just under a second of precision on any value with a fractional-second remainder. This affects every caller of this shared formatter (work packages, meetings, time entries), not just time entries.Change
Round the seconds value explicitly before constructing the
Duration.Test plan
format_duration_from_hours(5.501)→"PT5H30M3S"; after the fix →"PT5H30M4S", andPOST /api/v3/time_entrieswithhours: "PT5H30M3.6S"correctly returns"hours":"PT5H30M4S"