Decouple time widgets by Jan-Schuppik · Pull Request #350 · Icinga/ipl-web

Jan-Schuppik · 2026-01-08T11:46:30Z

This PR removes the direct dependency of the time widgets on Icinga Web (\Icinga\Date\DateFormatter::formatDateTime()) and introduces a native relative-time formatting behavior.

Key differences to the old Icinga Web implementation

Previously the following markup was animated:

<span class="relative-time time-ago" title="2026-04-21 14:44:34">3m4s ago</span>

The new implementation still supports this, but favors the following new markup:

<time class="time-ago" data-relative-time="ago" datetime="2026-04-21T14:44:34" title="2026-04-21 14:44:34">3m4s ago</time>

resolves #341

nilmerg

Didn't look at JS yet.

Also, add tests for Time and its child classes. Test formatting and rendering.

nilmerg

There are still no tests!

nilmerg

I stopped reading the tests once I saw more than one skip due to when the test is performed. Sorry, but this just non-sense. Tests must always succeed.

In addition, they make too heavy usage of contains and regex assertions. They test a HTML widget, so should assert the HTML structure: $obj actual, $html expected. Other tests exactly work like this and there is even a predefined assertion as part of ipl\Tests\Html\TestCase.

So please refactor your tests accordingly.

BastianLedererIcinga

I see my icingadb-web PR is still not entirely compatible with your changes, since I see no proper way to include a data-ago-label in Time widgets, which is required for the switch from absolute to relative. Let's discuss a solution and this time document the agreed approach in this PR.

nilmerg

@BastianLedererIcinga Please take over now, as @Jan-Schuppik is already occupied for the coming weeks and I want to finish this soon.

Don't hesitate to let Claude refactor the tests 😉

nilmerg

Thank you both!

Allow the Time widget to accept a custom IntlDateFormatter instance, enabling locale-aware and customizable time formatting. Falls back to the default formatted datetime string when no formatter is set. Also declare the ext-intl PHP extension as an explicit dependency in composer.json.

PHPStan checks that the values in specified keys have the correct types. source: https://phpstan.org/writing-php-code/phpdoc-types#array-shapes

Remove the separate assemble() override in TimeAgo, TimeSince and TimeUntil. Attribute setup and text formatting are now handled entirely within format(), eliminating the duplicate diff() call and reducing the number of methods subclasses need to override.

@throws

…ocks Replace \Exception with the imported Exception class across Time and its subclasses, and add the missing Exception import and @throws annotation to Time::relative().

Previously, Time::diff() and Time::relative() always used new DateTime() as the reference point, making deterministic unit tests impossible. Introduce an optional $compareTime parameter throughout the widget family so callers can inject an explicit reference time: - Time::diff() accepts ?DateTime $compareTime instead of computing "now" internally; Time::relative() forwards it to TimeAgo/TimeUntil. - TimeAgo, TimeSince, and TimeUntil store the injected time in the new Time::$compareTime property. - Year/day comparisons using date('Y')/date('d') are replaced by the new isSameByFormat() helper, removing the last implicit "now" dependencies. - data-relative-time attributes are moved to $defaultAttributes, removing duplicate code from format() methods. - Fix inverted prefix logic in TimeUntil: only prepend '-' when invert is 0 and the interval is non-zero.

- Move all test classes out of namespace blocks into proper ipl\Tests\Web\Widget namespace - Extend TestCase instead of PHPUnit\Framework\TestCase directly - Initialize StaticTranslator with NoopTranslator in setUp() to avoid translation side effects - Consolidate redundant constructor tests (int/float/DateTime variants) into fewer, clearer cases - Rename test methods to focus on observable behavior rather than input type (e.g. testConstructorAcceptsIntTimestamp → testConstructorAcceptsTimestamp) - Add $compareTime parameter usage to pin time in tests for deterministic results

Add a new test case and fix intentation of heredoc

Scan for new relative time elements on `rendered` and track existing ones. Use `setInterval` instead of the `icinga.timer`.

Since `Translation` is used in the `Time` class already it can be dropped from the subclasses. Tests are adjusted to match the new type of `$compareTime`.

- Make `DYNAMIC_RELATIVE_TIME_THRESHOLD` a class property - Remove underscores from method names - Simplify `getTimeDifferenceInSeconds` - Add missing space after negation

…a attributes

Support `.span.time-ago` etc. aswell as the new data attributes. The condition for the swap from until to ago is made more reliable.

This PR removes the Javascript function that updates relative times. refs: Icinga/ipl-web#341 Depends on: - Icinga/ipl-web#350 (ipl-web handles the time refreshing via javascript now)

cla-bot Bot added the cla/signed label Jan 8, 2026

BastianLedererIcinga mentioned this pull request Jan 19, 2026

Allow switching between relative and absolute timestamps Icinga/icingadb-web#1322

Merged

Jan-Schuppik mentioned this pull request Jan 21, 2026

Move relative time js behavior to ipl-web Icinga/icingaweb2#5461

Merged

Jan-Schuppik requested a review from sukhwinder33445 January 22, 2026 14:34

sukhwinder33445 reviewed Jan 23, 2026

View reviewed changes

Comment thread src/Widget/Time.php Outdated

Comment thread src/Widget/Time.php Outdated

Comment thread src/Widget/Time.php Outdated

nilmerg requested changes Feb 13, 2026

View reviewed changes

nilmerg requested changes Feb 27, 2026

View reviewed changes

Comment thread src/Widget/Time.php

Comment thread src/Widget/Time.php

Comment thread src/Widget/Time.php Outdated

Comment thread src/Widget/TimeAgo.php Outdated

nilmerg requested changes Mar 16, 2026

View reviewed changes

Jan-Schuppik force-pushed the decouple-time-widgets branch 4 times, most recently from 65cf226 to 7add9f3 Compare March 23, 2026 12:48

nilmerg requested a review from BastianLedererIcinga March 31, 2026 12:45

BastianLedererIcinga reviewed Apr 1, 2026

View reviewed changes

Comment thread asset/js/behavior/RelativeTimeBehavior.js Outdated

Comment thread asset/js/widget/RelativeTime.js Outdated

Comment thread asset/js/widget/RelativeTime.js Outdated

Comment thread tests/Widget/TimeAgoTest.php Outdated

BastianLedererIcinga mentioned this pull request Apr 2, 2026

Fix incorrect start times in the timelines of fixed downtimes Icinga/icingadb-web#1355

Merged

BastianLedererIcinga force-pushed the decouple-time-widgets branch 2 times, most recently from 18b4049 to a02cf6e Compare April 15, 2026 13:56

nilmerg requested changes Apr 15, 2026

View reviewed changes

nilmerg assigned BastianLedererIcinga Apr 15, 2026

BastianLedererIcinga requested a review from sukhwinder33445 April 17, 2026 11:37

nilmerg requested changes Apr 17, 2026

View reviewed changes

nilmerg added this to the 0.14.0 milestone Apr 17, 2026

BastianLedererIcinga requested a review from nilmerg April 17, 2026 14:18

nilmerg requested changes Apr 20, 2026

View reviewed changes

Comment thread asset/js/RelativeTime.js Outdated

Comment thread asset/js/behavior/RelativeTimeBehavior.js Outdated

nilmerg reviewed Apr 20, 2026

View reviewed changes

Comment thread asset/js/RelativeTime.js Outdated

BastianLedererIcinga requested a review from nilmerg April 21, 2026 10:00

nilmerg requested changes Apr 21, 2026

View reviewed changes

Comment thread asset/js/RelativeTime.js Outdated

BastianLedererIcinga requested a review from nilmerg April 21, 2026 11:16

nilmerg approved these changes Apr 21, 2026

View reviewed changes

sukhwinder33445 removed their request for review April 21, 2026 13:45

Jan-Schuppik and others added 26 commits April 21, 2026 15:45

Mark helper method Time::castToDateTime() with @internal

66e4f08

Use strong types in phpdoc for array shape checking

a95bbad

PHPStan checks that the values in specified keys have the correct types. source: https://phpstan.org/writing-php-code/phpdoc-types#array-shapes

Simplify Time::diff() by using match expression

7235279

Simplify time widgets formatting by using match expression

0d0386a

Use imported Exception instead of fully qualified \Exception in docbl…

d6d19e6

…ocks Replace \Exception with the imported Exception class across Time and its subclasses, and add the missing Exception import and @throws annotation to Time::relative().

Set datetime attribute in base class instead of subclasses

3a7bb35

Use Translation trait in time widgets for NoopTranslator testability

b331530

Time::relative() current time returns TimeAgo instead of TimeUntil

14667d5

WIP expose data-ago-label

18fecab

Refactor tests

7a6eb98

Tests: Add missing data-ago-label attr

017c338

Add a new test case and fix intentation of heredoc

Improve js

72bbc19

Scan for new relative time elements on `rendered` and track existing ones. Use `setInterval` instead of the `icinga.timer`.

Move ext-intl up

9a9420c

Change type of $compareTime and remove Translation trait

76cbf68

Since `Translation` is used in the `Time` class already it can be dropped from the subclasses. Tests are adjusted to match the new type of `$compareTime`.

RelativeTime: Remove obsolete WeakMap

3995145

Remove superfluous calls of castToDateTime

4dffddd

RelativeTime: Refactoring

c174d6c

- Make `DYNAMIC_RELATIVE_TIME_THRESHOLD` a class property - Remove underscores from method names - Simplify `getTimeDifferenceInSeconds` - Add missing space after negation

RelativeTimeBehavior: Avoid redundant scan calls

3d7f512

RelativeTime: Drop dead refs from _trackedElements

4d39ddd

RelativeTime: Remove _offsetCache and use .dataset to acces dat…

47557b3

…a attributes

Ensure backwards compatibility with Icinga Web < 2.14

0996060

Support `.span.time-ago` etc. aswell as the new data attributes. The condition for the swap from until to ago is made more reliable.

RelativeTime: Adjust selector in scan

9fb079c

nilmerg force-pushed the decouple-time-widgets branch from 720fae3 to 9fb079c Compare April 21, 2026 13:46

nilmerg merged commit dde4c73 into main Apr 21, 2026
14 checks passed

nilmerg deleted the decouple-time-widgets branch April 21, 2026 13:51

Conversation

Jan-Schuppik commented Jan 8, 2026 • edited by nilmerg Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BastianLedererIcinga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Jan-Schuppik commented Jan 8, 2026 •

edited by nilmerg

Loading