Backward compatiblity with older redis versions (#133)

drieschel · LKaemmerling · web-flow · commit 6f306e91258a · 2023-11-06T10:59:08.000+01:00
* Redis(NG) adapter: Added replicate command for backward compatiblity with redis version &lt; 5

Signed-off-by: Immanuel Klinkenberg &lt;drieschel@yahoo.de&gt;

* Fixed blackbox tests

Signed-off-by: Immanuel Klinkenberg &lt;drieschel@yahoo.de&gt;

* Added PHPStan ignore error lines

Signed-off-by: Immanuel Klinkenberg &lt;drieschel@yahoo.de&gt;

* Test on multiple redis versions

---------

Signed-off-by: Immanuel Klinkenberg &lt;drieschel@yahoo.de&gt;
Co-authored-by: Lukas Kämmerling &lt;github@lukas-kaemmerling.de&gt;
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -11,9 +11,9 @@ jobs:
         os: [ ubuntu-latest ]
         php: [ 7.4, 8.0, 8.1, 8.2 ]
         dependency-version: [ prefer-lowest, prefer-stable ]
-        redis-version: [ 6 ]
+        redis-version: [ 5, 6, 7 ]
 
-    name: P${{ matrix.php }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+    name: P${{ matrix.php }} - ${{ matrix.dependency-version }} - ${{ matrix.os }} - ${{ matrix.redis-version }}
 
     env:
       # The hostname used to communicate with the Redis service container
diff --git a/src/Prometheus/CollectorRegistry.php b/src/Prometheus/CollectorRegistry.php
@@ -83,7 +83,7 @@ public function wipeStorage(): void
      */
     public function getMetricFamilySamples(bool $sortMetrics = true): array
     {
-        return $this->storageAdapter->collect($sortMetrics);
+        return $this->storageAdapter->collect($sortMetrics);  /** @phpstan-ignore-line */
     }
 
     /**
diff --git a/src/Prometheus/Storage/Redis.php b/src/Prometheus/Storage/Redis.php
@@ -123,6 +123,7 @@ public function wipeStorage(): void
 
         $this->redis->eval(
             <<<LUA
+redis.replicate_commands()
 local cursor = "0"
 repeat 
     local results = redis.call('SCAN', cursor, 'MATCH', ARGV[1])
diff --git a/src/Prometheus/Storage/RedisNg.php b/src/Prometheus/Storage/RedisNg.php
@@ -123,6 +123,7 @@ public function wipeStorage(): void
 
         $this->redis->eval(
             <<<LUA
+redis.replicate_commands()
 local cursor = "0"
 repeat 
     local results = redis.call('SCAN', cursor, 'MATCH', ARGV[1])
@@ -474,7 +475,7 @@ private function collectHistograms(): array
      *
      * @return string
      */
-    private function removePrefixFromKey(string $key): string
+    private function removePrefixFromKey(string $key): string  /** @phpstan-ignore-line */
     {
         // @phpstan-ignore-next-line false positive, phpstan thinks getOptions returns int
         if ($this->redis->getOption(\Redis::OPT_PREFIX) === null) {
diff --git a/tests/Test/BlackBoxTest.php b/tests/Test/BlackBoxTest.php
@@ -45,7 +45,7 @@ public function gaugesShouldBeOverwritten(): void
 
         ];
 
-        Promise\settle($promises)->wait();
+        Promise\Utils::settle($promises)->wait();
         $end = microtime(true);
         echo "\ntime: " . ($end - $start) . "\n";
 
@@ -84,7 +84,7 @@ public function countersShouldIncrementAtomically($increment): void
             $n += $increment;
         }
 
-        Promise\settle($promises)->wait();
+        Promise\Utils::settle($promises)->wait();
         $end = microtime(true);
         echo "\ntime: " . ($end - $start) . "\n";
 
@@ -124,7 +124,7 @@ public function histogramsShouldIncrementAtomically(): void
             $this->client->getAsync('/examples/some_histogram.php?c=9&adapter=' . $this->adapter),
         ];
 
-        Promise\settle($promises)->wait();
+        Promise\Utils::settle($promises)->wait();
         $end = microtime(true);
         echo "\ntime: " . ($end - $start) . "\n";
 
@@ -168,7 +168,7 @@ public function summariesShouldIncrementAtomically(): void
             $this->client->getAsync('/examples/some_summary.php?c=10&adapter=' . $this->adapter),
         ];
 
-        Promise\settle($promises)->wait();
+        Promise\Utils::settle($promises)->wait();
         $end = microtime(true);
         echo "\ntime: " . ($end - $start) . "\n";
 

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function wipeStorage(): void`
`83`	`83`	`*/`
`84`	`84`	`public function getMetricFamilySamples(bool $sortMetrics = true): array`
`85`	`85`	`{`
`86`		`- return $this->storageAdapter->collect($sortMetrics);`
	`86`	`+ return $this->storageAdapter->collect($sortMetrics); /** @phpstan-ignore-line */`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`/**`