fix: change type from int to float for heartbeat period (#70)

Author: misaert

src/MySQLReplication/Config/Config.php

@@ -42,7 +42,7 @@ public function __construct(
         array $databasesOnly,
         int $tableCacheSize,
         array $custom,
-        int $heartbeatPeriod
+        float $heartbeatPeriod
     ) {
         self::$user = $user;
         self::$host = $host;
@@ -103,8 +103,8 @@ public static function validate(): void
                 ConfigException::TABLE_CACHE_SIZE_ERROR_MESSAGE, ConfigException::TABLE_CACHE_SIZE_ERROR_CODE
             );
         }
-        if (0 !== self::$heartbeatPeriod && false === filter_var(
-                self::$heartbeatPeriod, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1, 'max_range' => 4294967]]
+        if (0.0 !== self::$heartbeatPeriod && false === (
+                self::$heartbeatPeriod >= 0.001 && self::$heartbeatPeriod <= 4294967.0
             )) {
             throw new ConfigException(
                 ConfigException::HEARTBEAT_PERIOD_ERROR_MESSAGE, ConfigException::HEARTBEAT_PERIOD_ERROR_CODE
@@ -215,7 +215,7 @@ public static function getEventsIgnore(): array
         return self::$eventsIgnore;
     }
 
-    public static function getHeartbeatPeriod(): int
+    public static function getHeartbeatPeriod(): float
     {
         return self::$heartbeatPeriod;
     }

src/MySQLReplication/Config/ConfigBuilder.php

@@ -21,7 +21,7 @@ class ConfigBuilder
     private $mariaDbGtid = '';
     private $tableCacheSize = 128;
     private $custom = [];
-    private $heartbeatPeriod = 0;
+    private $heartbeatPeriod = 0.0;
 
     public function withUser(string $user): self
     {
@@ -140,7 +140,7 @@ public function withCustom(array $custom): self
     /**
      * @see https://dev.mysql.com/doc/refman/5.6/en/change-master-to.html
      */
-    public function withHeartbeatPeriod(int $heartbeatPeriod): self
+    public function withHeartbeatPeriod(float $heartbeatPeriod): self
     {
         $this->heartbeatPeriod = $heartbeatPeriod;
 

tests/Unit/Config/ConfigTest.php

@@ -125,6 +125,29 @@ public function shouldCheckEvent(): void
         self::assertFalse(Config::checkEvent(4));
     }
 
+    public function shouldCheckHeartbeatPeriodProvider(): array
+    {
+        return [
+            [0],
+            [0.0],
+            [0.001],
+            [4294967],
+            [2],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider shouldCheckHeartbeatPeriodProvider
+     */
+    public function shouldCheckHeartbeatPeriod($heartbeatPeriod): void
+    {
+        $config = (new ConfigBuilder())->withHeartbeatPeriod($heartbeatPeriod)->build();
+        $config::validate();
+
+        self::assertSame((float) $heartbeatPeriod, $config::getHeartbeatPeriod());
+    }
+
     public function shouldValidateProvider(): array
     {
         return [