Merge pull request #254 from TravisCarden/feature/non-nullable-timeouts

src/API/Core/BeginnerInterface.php

@@ -39,9 +39,9 @@ interface BeginnerInterface
      *   as when committing.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\PreconditionException
      *   If the preconditions are unfulfilled.
@@ -55,6 +55,6 @@ public function begin(
         PathInterface $stagingDir,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Core/CleanerInterface.php

@@ -24,9 +24,9 @@ interface CleanerInterface
      *   The staging directory.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\PreconditionException
      *   If the preconditions are unfulfilled.
@@ -37,6 +37,6 @@ public function clean(
         PathInterface $activeDir,
         PathInterface $stagingDir,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Core/CommitterInterface.php

@@ -28,9 +28,9 @@ interface CommitterInterface
      *   you should use the same exclusions when committing as when beginning.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\PreconditionException
      *   If the preconditions are unfulfilled.
@@ -44,6 +44,6 @@ public function commit(
         PathInterface $activeDir,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Core/StagerInterface.php

@@ -35,9 +35,9 @@ interface StagerInterface
      *   The staging directory.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\InvalidArgumentException
      *   If the given Composer command is invalid.
@@ -51,6 +51,6 @@ public function stage(
         PathInterface $activeDir,
         PathInterface $stagingDir,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/FileSyncer/Service/FileSyncerInterface.php

@@ -35,9 +35,9 @@ interface FileSyncerInterface
      *   "underneath" or "inside" it.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\IOException
      *   If the destination directory cannot be created.
@@ -49,6 +49,6 @@ public function sync(
         PathInterface $destination,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Filesystem/Service/FilesystemInterface.php

@@ -170,16 +170,16 @@ public function readLink(PathInterface $path): PathInterface;
      *   A path to remove.
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\IOException
      *   If the file cannot be removed.
      */
     public function remove(
         PathInterface $path,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Process/Service/ComposerProcessRunnerInterface.php

@@ -26,9 +26,9 @@ interface ComposerProcessRunnerInterface
      *   ```
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\LogicException
      *   If the command process cannot be created due to host configuration.
@@ -40,6 +40,6 @@ interface ComposerProcessRunnerInterface
     public function run(
         array $command,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/API/Process/Service/ProcessInterface.php

@@ -82,12 +82,12 @@ public function setEnv(array $env): self;
     /**
      * Sets the process timeout (max. runtime) in seconds.
      *
-     * @param float|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\InvalidArgumentException
      *   If the given timeout is negative.
      */
-    public function setTimeout(?float $timeout = self::DEFAULT_TIMEOUT): self;
+    public function setTimeout(int $timeout = self::DEFAULT_TIMEOUT): self;
 }

src/API/Process/Service/RsyncProcessRunnerInterface.php

@@ -26,9 +26,9 @@ interface RsyncProcessRunnerInterface
      *   ```
      * @param \PhpTuf\ComposerStager\API\Process\Service\OutputCallbackInterface|null $callback
      *   An optional PHP callback to run whenever there is process output.
-     * @param int|null $timeout
-     *   An optional process timeout (maximum runtime) in seconds. Set to null
-     *   to disable.
+     * @param int $timeout
+     *   An optional process timeout (maximum runtime) in seconds. If set to
+     *   zero (0), no time limit is imposed.
      *
      * @throws \PhpTuf\ComposerStager\API\Exception\LogicException
      *   If the command process cannot be created due to host configuration.
@@ -40,6 +40,6 @@ interface RsyncProcessRunnerInterface
     public function run(
         array $command,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void;
 }

src/Internal/Core/Beginner.php

@@ -30,7 +30,7 @@ public function begin(
         PathInterface $stagingDir,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $this->preconditions->assertIsFulfilled($activeDir, $stagingDir, $exclusions);
 

src/Internal/Core/Cleaner.php

@@ -28,7 +28,7 @@ public function clean(
         PathInterface $activeDir,
         PathInterface $stagingDir,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $this->preconditions->assertIsFulfilled($activeDir, $stagingDir);
 

src/Internal/Core/Committer.php

@@ -30,7 +30,7 @@ public function commit(
         PathInterface $activeDir,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $this->preconditions->assertIsFulfilled($activeDir, $stagingDir, $exclusions);
 

src/Internal/Core/Stager.php

@@ -36,7 +36,7 @@ public function stage(
         PathInterface $activeDir,
         PathInterface $stagingDir,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $this->preconditions->assertIsFulfilled($activeDir, $stagingDir);
 
@@ -86,7 +86,7 @@ private function runCommand(
         PathInterface $stagingDir,
         array $composerCommand,
         ?OutputCallbackInterface $callback,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $command = array_merge(
             ['--working-dir=' . $stagingDir->absolute()],

src/Internal/FileSyncer/Service/PhpFileSyncer.php

@@ -38,9 +38,9 @@ public function sync(
         PathInterface $destination,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
-        set_time_limit((int) $timeout);
+        set_time_limit($timeout);
 
         $exclusions ??= new PathList();
 

src/Internal/FileSyncer/Service/RsyncFileSyncer.php

@@ -47,14 +47,14 @@ public function sync(
         PathInterface $destination,
         ?PathListInterface $exclusions = null,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         $sourceAbsolute = $source->absolute();
         $destinationAbsolute = $destination->absolute();
 
         $this->assertDirectoriesAreNotTheSame($source, $destination);
         $this->assertSourceExists($source);
-        set_time_limit((int) $timeout);
+        set_time_limit($timeout);
         $this->runCommand($exclusions, $sourceAbsolute, $destinationAbsolute, $destination, $callback);
     }
 

src/Internal/Filesystem/Service/Filesystem.php

@@ -174,12 +174,12 @@ public function readLink(PathInterface $path): PathInterface
     public function remove(
         PathInterface $path,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         try {
             // Symfony Filesystem doesn't have a builtin mechanism for setting a
             // timeout, so we have to enforce it ourselves.
-            set_time_limit((int) $timeout);
+            set_time_limit($timeout);
 
             $this->symfonyFilesystem->remove($path->absolute());
         } catch (SymfonyExceptionInterface $e) {

src/Internal/Process/Service/AbstractProcessRunner.php

@@ -52,7 +52,7 @@ public function __construct(
     public function run(
         array $command,
         ?OutputCallbackInterface $callback = null,
-        ?int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
+        int $timeout = ProcessInterface::DEFAULT_TIMEOUT,
     ): void {
         array_unshift($command, $this->findExecutable());
         $process = $this->processFactory->create($command);

src/Internal/Process/Service/Process.php

@@ -106,7 +106,7 @@ public function setEnv(array $env): ProcessInterface
         return $this;
     }
 
-    public function setTimeout(?float $timeout = self::DEFAULT_TIMEOUT): self
+    public function setTimeout(int $timeout = self::DEFAULT_TIMEOUT): self
     {
         try {
             $this->symfonyProcess->setTimeout($timeout);

tests/Core/BeginnerUnitTest.php

@@ -70,7 +70,7 @@ public function testBeginWithOptionalParams(
         string $stagingDir,
         ?PathListInterface $exclusions,
         ?OutputCallbackInterface $callback,
-        ?int $timeout,
+        int $timeout,
     ): void {
         $activeDir = new TestPath($activeDir);
         $stagingDir = new TestPath($stagingDir);
@@ -93,7 +93,7 @@ public function providerBeginWithOptionalParams(): array
                 'stagingDir' => 'three/four',
                 'givenExclusions' => null,
                 'callback' => null,
-                'timeout' => null,
+                'timeout' => 0,
             ],
             [
                 'activeDir' => 'five/six',

tests/Core/CleanerUnitTest.php

@@ -61,7 +61,7 @@ public function testCleanWithMinimumParams(): void
      *
      * @dataProvider providerCleanWithOptionalParams
      */
-    public function testCleanWithOptionalParams(string $path, ?OutputCallbackInterface $callback, ?int $timeout): void
+    public function testCleanWithOptionalParams(string $path, ?OutputCallbackInterface $callback, int $timeout): void
     {
         $path = new TestPath($path);
         $this->preconditions
@@ -81,7 +81,7 @@ public function providerCleanWithOptionalParams(): array
             [
                 'path' => '/one/two',
                 'callback' => null,
-                'timeout' => null,
+                'timeout' => 0,
             ],
             [
                 'path' => 'three/four',

tests/Core/CommitterUnitTest.php

@@ -70,7 +70,7 @@ public function testCommitWithOptionalParams(
         string $activeDir,
         ?PathListInterface $exclusions,
         ?OutputCallbackInterface $callback,
-        ?int $timeout,
+        int $timeout,
     ): void {
         $activeDir = new TestPath($activeDir);
         $stagingDir = new TestPath($stagingDir);
@@ -93,7 +93,7 @@ public function providerCommitWithOptionalParams(): array
                 'activeDir' => '/three/four',
                 'exclusions' => null,
                 'callback' => null,
-                'timeout' => null,
+                'timeout' => 0,
             ],
             [
                 'stagingDir' => 'five/six',

tests/Core/StagerUnitTest.php

@@ -76,7 +76,7 @@ public function testStageWithOptionalParams(
         array $givenCommand,
         array $expectedCommand,
         ?OutputCallbackInterface $callback,
-        ?int $timeout,
+        int $timeout,
     ): void {
         $activeDirPath = PathHelper::activeDirPath();
         $stagingDirPath = PathHelper::stagingDirPath();
@@ -102,7 +102,7 @@ public function providerStageWithOptionalParams(): array
                     'update',
                 ],
                 'callback' => null,
-                'timeout' => null,
+                'timeout' => 0,
             ],
             [
                 'givenCommand' => [self::INERT_COMMAND],

tests/FileSyncer/Service/FileSyncerFunctionalTestCase.php

@@ -40,7 +40,7 @@ abstract protected function fileSyncerClass(): string;
      *
      * @dataProvider providerSyncTimeout
      */
-    public function testSyncTimeout(?int $givenTimeout, int $expectedTimeout): void
+    public function testSyncTimeout(int $givenTimeout, int $expectedTimeout): void
     {
         $sut = $this->createSut();
 
@@ -53,7 +53,7 @@ public function providerSyncTimeout(): array
     {
         return [
             [
-                'givenTimeout' => null,
+                'givenTimeout' => 0,
                 'expectedTimeout' => 0,
             ],
             [

tests/Filesystem/Service/FilesystemUnitTest.php

@@ -191,7 +191,7 @@ public function providerRemove(): array
             [
                 'path' => '/one/two',
                 'callback' => null,
-                'givenTimeout' => null,
+                'givenTimeout' => 0,
                 'expectedTimeout' => 0,
             ],
             [