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 2 (\Icinga\Date\DateFormatter::formatDateTime()) and introduces a native relative-time formatting behavior in IPL Web.

Resolve:

Decouple TimeAgo, TimeUntil and TimeSince from Icinga Web #341

Depends on:

Provide Icinga to ipl/web behaviors icingaweb2#5238
(brings the ability to create js-behaviors outside of icingaweb2 )

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.

Create a general Time Widget which is also the base for TimeAgo, TimeSince & TimeUntil

For this change to work the following PR is required: Icinga/icingaweb2#5238

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

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 😉

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`.

nilmerg · 2026-04-17T12:39:43Z

+    public function __construct(int|float|DateTime|null $time = null, ?DateTime $compareTime = null)
+    {
+        if ($compareTime !== null) {
+            $this->compareTime = $this->castToDateTime($compareTime);


It doesn't need to be cast anymore ;)

nilmerg · 2026-04-17T12:40:14Z

+    public function __construct(int|float|DateTime|null $time = null, ?DateTime $compareTime = null)
+    {
+        if ($compareTime !== null) {
+            $this->compareTime = $this->castToDateTime($compareTime);


same here, no cast necessary

nilmerg · 2026-04-17T12:40:36Z

+    public function __construct(int|float|DateTime|null $time = null, ?DateTime $compareTime = null)
+    {
+        if ($compareTime !== null) {
+            $this->compareTime = $this->castToDateTime($compareTime);


and here, you know the deal

nilmerg · 2026-04-17T13:00:08Z

+             * @private
+             */
+            this._relativeTime = new RelativeTime(icinga.config.timezone);
+            this._relativeTime.scan(document);


I believe it shouldn't be necessary to scan upon construction. The render event is triggered upon page load by Icinga Web.

nilmerg · 2026-04-17T13:02:48Z

+        }
+
+        onTimeRendered(event) {
+            event.data.self._relativeTime.scan(event.target);


Please only scan in case event.currentTarget === event.target. Otherwise this will scan containers multiple times while the event bubbles up to the ancestors.

For this to reliably work the listener registration in the constructor needs to use .container as condition.

nilmerg · 2026-04-17T13:08:50Z

+        tick() {
+            this._trackedElements.forEach((ref) => {
+                const el = ref.deref();
+                if (el) {


you only add to _trackedElements, drop dead refs from the set to avoid leaking memory.

nilmerg · 2026-04-17T13:09:42Z

+        }
+
+        updateElement(element) {
+            const DYNAMIC_RELATIVE_TIME_THRESHOLD = 60 * 60;


please make this a class constant/property

nilmerg · 2026-04-17T13:11:08Z

+
+        _getTimeDifferenceInSeconds(element, future = false) {
+
+            const fromDateTimeWithTimezone = (element, future = false) => {


Why is this a separate function?

nilmerg · 2026-04-17T13:15:37Z

+            }
+        }
+
+        _getTimeDifferenceInSeconds(element, future = false) {


please remove underscores from all methods

nilmerg · 2026-04-17T13:16:02Z

+        }
+
+        _getOffset() {
+            if (!this._offsetCache) {


a space after the negation operator please

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

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

Open

Jan-Schuppik mentioned this pull request Jan 21, 2026

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

Open

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

Jan-Schuppik added 15 commits April 15, 2026 15:24

Introduce independ time-widgets

7ea0cb5

Create a general Time Widget which is also the base for TimeAgo, TimeSince & TimeUntil

Add data-relative-time-attribute

5a96c76

Fix linting errors

f25700e

Add relative-time behavior (WIP)

52978a2

Fix missing timezone handling in relative-time behavior

5172ee8

cleanup time widgets

95c97a8

Create a relative-time behavior as expected

b230c76

For this change to work the following PR is required: Icinga/icingaweb2#5238

Fix timezone handling - use available feature

1f67715

Cleanup: relative-time-behavior

052ece9

Split relative-time in core and behavior

0825fb9

Remove notjQuery and simplify RelativeTime parameter

de41434

Add timezone to Time-widget

5c7ca58

Add tryout: timezone refreshing mechanism

4dbad8b

Adjust: get timezone from icinga config in js

fc12e42

Cleanup: code style & variable names

a9c0e31

Jan-Schuppik added 11 commits April 15, 2026 15:25

Use strong types in phpdoc for array shape checking

49a6a7c

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

fabdaa3

Simplify time widgets formatting by using match expression

6903231

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

5b608bb

…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

2d27f69

Use Translation trait in time widgets for NoopTranslator testability

73d5bcc

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

e1365c6

BastianLedererIcinga force-pushed the decouple-time-widgets branch from 7add9f3 to 18b4049 Compare April 15, 2026 13:31

WIP expose data-ago-label

a02cf6e

BastianLedererIcinga force-pushed the decouple-time-widgets branch 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 and others added 5 commits April 17, 2026 08:39

Refactor tests

b1ee24e

Tests: Add missing data-ago-label attr

f0120a3

Add a new test case and fix intentation of heredoc

Improve js

7c753b9

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

Move ext-intl up

3aecafa

Change type of $compareTime and remove Translation trait

95b1178

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`.

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

RelativeTime: Remove obsolete WeakMap

49fdfc3

nilmerg requested changes Apr 17, 2026

View reviewed changes

nilmerg added this to the 0.14.0 milestone Apr 17, 2026

BastianLedererIcinga added 4 commits April 17, 2026 16:04

Remove superfluous calls of castToDateTime

a014439

RelativeTime: Refactoring

c301ee9

- 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

2518fbb

RelativeTime: Drop dead refs from _trackedElements

ef2435b

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


		_getTimeDifferenceInSeconds(element, future = false) {

		const fromDateTimeWithTimezone = (element, future = false) => {

Conversation

Jan-Schuppik commented Jan 8, 2026 • edited 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Jan-Schuppik commented Jan 8, 2026 •

edited

Loading