Fix #44: Use PSR-20 ClockInterface instead of TimerInterface #47

samdark · 2023-07-25T14:13:30Z

Q	A
Is bugfix?	❌
New feature?	❌
Breaks BC?	✔️
Fixed issues	#44

what-the-diff · 2023-07-25T14:14:12Z

PR Summary:

Clock Interface Integration and Timer Interface Replacement
Instead of having the system measure time intervals based on a self-created TimerInterface, this PR integrates a standardized ClockInterface (PSR-20) from the PHP Fig group, making it more reliable for time-related functionalities.
Addition of APCu as Counters Storage
Additional support for APCu, a common caching system, was integrated into the software package with this PR, providing another storage method to keep track of counters.
Concurrent Requests Handling
The software package now has improved capabilities to handle concurrent requests. Previously, it used a single save() method for data storage, but it's now split into saveIfNotExists() and saveCompareAndSwap() methods for better performance and reliability during concurrent requests.
General file modifications, additions and deletions
- A new file, SystemClock.php, which uses ClockInterface, is added and the MicrotimeTimer.php and TimerInterface.php which were previous timing system components are removed.
- A few test files (ApcuCounterTest.php, BaseCounterTest.php, CounterTest.php, MiddlewareTest.php, ApcuStorageTest.php) were updated to replace TimeTimer components with ClockInterface components, thus reflecting aforementioned system changes.
- FrozenTimeTimer.php and FrozenClock.php were removed as they became obsolete with the integration of a more reliable time measurement tool, ClockInterface.
Minor Corrections and Updates
The PR comes with minor amendments like a typo fix in README.md and an update (PSR-20 ClockInterface) in the dependencies listed in composer.json.

codecov · 2023-07-25T14:14:43Z

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b852afa) 100.00% compared to head (3d9c254) 100.00%.

Additional details and impacted files

@@             Coverage Diff             @@
##              master       #47   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        51        51           
===========================================
  Files              9         9           
  Lines            135       135           
===========================================
  Hits             135       135

Files Changed	Coverage Δ
src/Counter.php	`100.00% <100.00%> (ø)`
src/Time/SystemClock.php	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

vjik · 2023-07-25T14:38:05Z

src/Counter.php

@@ -75,7 +75,7 @@ public function hit(string $id): CounterState
        do {
            // Last increment time.
            // In GCRA it's known as arrival time.
-            $lastIncrementTimeInMilliseconds = $this->timer->nowInMilliseconds();
+            $lastIncrementTimeInMilliseconds = round((float)$this->timer->now()->format('U.u') * 1000);


Suggested change

$lastIncrementTimeInMilliseconds = round((float)$this->timer->now()->format('U.u') * 1000);

$lastIncrementTimeInMilliseconds = round($this->timer->now()->format('U.u') * 1000);

That would make static analysis complain.

vjik · 2023-07-25T14:42:21Z

tests/MiddlewareTest.php

@@ -227,7 +227,7 @@ public function testWithLimitingFunction(): void
     */
    public function testWithExceedingMaxAttempts(): void
    {
-        $timer = new FrozenTimeTimer();
+        $timer = new FrozenClock();


Here we can don't use specific timer and replace it to null.

vjik · 2023-07-25T14:42:26Z

tests/MiddlewareTest.php

@@ -259,7 +259,7 @@ public function testWithExceedingMaxAttempts(): void

    public function testFailStoreUpdatedDataMiddleware(): void
    {
-        $timer = new FrozenTimeTimer();
+        $timer = new FrozenClock();


Here we can don't use specific timer and replace it to null.

vjik · 2023-07-25T14:43:21Z

tests/Storage/StorageTest.php

@@ -34,20 +34,20 @@ public function testGetKeyWithExistsKey(): void
    {
        $storage = $this->getStorage();

-        $want = (new FrozenTimeTimer())->nowInMilliseconds();
+        $want = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$want = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$want = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:43:48Z

tests/Storage/StorageTest.php

    }

    public function testSaveIfNotExistsWithNewKey(): void
    {
        $storage = $this->getStorage();

-        $value = (new FrozenTimeTimer())->nowInMilliseconds();
+        $value = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$value = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$value = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:43:57Z

tests/Storage/StorageTest.php

@@ -58,7 +58,7 @@ public function testSaveCompareAndSwapWithExistsKeyAndOldValueSame(): void
    {
        $storage = $this->getStorage();

-        $oldValue = (new FrozenTimeTimer())->nowInMilliseconds();
+        $oldValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$oldValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$oldValue = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:44:25Z

tests/Storage/ApcuStorageTest.php

    {
        $storage = $this->getStorage();

-        $oldValue = (new FrozenTimeTimer())->nowInMilliseconds();
+        $oldValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$oldValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$oldValue = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:44:41Z

tests/Storage/ApcuStorageTest.php

@@ -47,7 +47,7 @@ public function testSaveCompareAndSwapWithNewKey(): void
    {
        $storage = $this->getStorage();

-        $newValue = (new FrozenTimeTimer())->nowInMilliseconds();
+        $newValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$newValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$newValue = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:44:51Z

tests/Storage/ApcuStorageTest.php

@@ -35,7 +35,7 @@ public function testSaveIfNotExistsWithExistsKey(): void
    {
        $storage = $this->getStorage();

-        $value = (new FrozenTimeTimer())->nowInMilliseconds();
+        $value = round((float)(new DateTimeImmutable())->format('U.u') * 1000);


Suggested change

$value = round((float)(new DateTimeImmutable())->format('U.u') * 1000);

$value = round((new DateTimeImmutable())->format('U.u') * 1000);

vjik · 2023-07-25T14:45:48Z

tests/CounterTest.php

     */
    public function testConcurrentHitsWithDirtyReading(): void
    {
-        $timer = new FrozenTimeTimer();
+        $timer = new FrozenClock();


Here we can don't use specific timer and replace it to null.

samdark and others added 2 commits July 25, 2023 22:12

Fix #44: Use PSR-20 ClockInterface instead of TimerInterface

f7cef39

Apply fixes from StyleCI

34d4814

samdark requested review from vjik and xepozz July 25, 2023 14:13

samdark and others added 5 commits July 25, 2023 22:18

Fix

841734b

Fix

9aaddfd

Apply fixes from StyleCI

d2de4b2

Fix

01a643c

Fix

3d9c254

vjik reviewed Jul 25, 2023

View reviewed changes

samdark closed this Jul 26, 2023

samdark deleted the 44-use-psr-20 branch July 26, 2023 08:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #44: Use PSR-20 ClockInterface instead of TimerInterface #47

Fix #44: Use PSR-20 ClockInterface instead of TimerInterface #47

samdark commented Jul 25, 2023

what-the-diff bot commented Jul 25, 2023

codecov bot commented Jul 25, 2023 •

edited

Loading

vjik Jul 25, 2023

samdark Jul 26, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

vjik Jul 25, 2023

	$lastIncrementTimeInMilliseconds = round((float)$this->timer->now()->format('U.u') * 1000);
	$lastIncrementTimeInMilliseconds = round($this->timer->now()->format('U.u') * 1000);

	$want = round((float)(new DateTimeImmutable())->format('U.u') * 1000);
	$want = round((new DateTimeImmutable())->format('U.u') * 1000);

	$value = round((float)(new DateTimeImmutable())->format('U.u') * 1000);
	$value = round((new DateTimeImmutable())->format('U.u') * 1000);

	$oldValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);
	$oldValue = round((new DateTimeImmutable())->format('U.u') * 1000);

	$newValue = round((float)(new DateTimeImmutable())->format('U.u') * 1000);
	$newValue = round((new DateTimeImmutable())->format('U.u') * 1000);

Fix #44: Use PSR-20 ClockInterface instead of TimerInterface #47

Fix #44: Use PSR-20 ClockInterface instead of TimerInterface #47

Conversation

samdark commented Jul 25, 2023

what-the-diff bot commented Jul 25, 2023

PR Summary:

codecov bot commented Jul 25, 2023 • edited Loading

Codecov Report

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 25, 2023 •

edited

Loading