Forward the child process output type to the logger (#174)

Author: theofidry

src/Logger/Logger.php

@@ -69,14 +69,16 @@ public function logChildProcessFinished(int $index): void;
      * process expects the child to output the progress symbol to communicate its
      * progression. Any other sort of output is considered "unexpected".
      *
-     * @param string         $buffer Child process output.
      * @param positive-int|0 $index  Index of the process amoung the list of running processes.
      * @param int|null       $pid    The child process PID. It can be null if the process is no
      *                               longer running.
+     * @param string         $type The type of output: "out" or "err".
+     * @param string         $buffer Child process output.
      */
     public function logUnexpectedChildProcessOutput(
         int $index,
         ?int $pid,
+        string $type,
         string $buffer,
         string $progressSymbol
     ): void;

src/Logger/NullLogger.php

@@ -58,8 +58,13 @@ public function logChildProcessFinished(int $index): void
         // Do nothing.
     }
 
-    public function logUnexpectedChildProcessOutput(int $index, ?int $pid, string $buffer, string $progressSymbol): void
-    {
+    public function logUnexpectedChildProcessOutput(
+        int $index,
+        ?int $pid,
+        string $type,
+        string $buffer,
+        string $progressSymbol
+    ): void {
         // Do nothing.
     }
 }

src/Logger/StandardLogger.php

@@ -148,8 +148,13 @@ public function logChildProcessFinished(int $index): void
         $this->logger->debug('Command finished');
     }
 
-    public function logUnexpectedChildProcessOutput(int $index, ?int $pid, string $buffer, string $progressSymbol): void
-    {
+    public function logUnexpectedChildProcessOutput(
+        int $index,
+        ?int $pid,
+        string $type,
+        string $buffer,
+        string $progressSymbol
+    ): void {
         $this->output->writeln('');
         $this->output->writeln(sprintf(
             '<comment>%s</comment>',

src/ParallelExecutor.php

@@ -356,6 +356,7 @@ private function createProcessLauncher(
             fn (int $index, ?int $pid, string $type, string $buffer) => $this->processChildOutput(
                 $index,
                 $pid,
+                $type,
                 $buffer,
                 $logger,
             ),
@@ -364,17 +365,18 @@ private function createProcessLauncher(
     }
 
     /**
-     * TODO: pass the type
      * Called whenever data is received in the main process from a child process.
      *
      * @param positive-int|0 $index  Index of the process amoung the list of running processes.
      * @param int|null       $pid    The child process PID. It can be null if the process is no
      *                               longer running.
-     * @param string         $buffer The received data
+     * @param string         $type   The type of output: "out" or "err".
+     * @param string         $buffer The received data.
      */
     private function processChildOutput(
         int $index,
         ?int $pid,
+        string $type,
         string $buffer,
         Logger $logger
     ): void {
@@ -386,6 +388,7 @@ private function processChildOutput(
             $logger->logUnexpectedChildProcessOutput(
                 $index,
                 $pid,
+                $type,
                 $buffer,
                 $progressSymbol,
             );

tests/Logger/DummyLogger.php

@@ -82,8 +82,13 @@ public function logChildProcessFinished(int $index): void
         ];
     }
 
-    public function logUnexpectedChildProcessOutput(int $index, ?int $pid, string $buffer, string $progressSymbol): void
-    {
+    public function logUnexpectedChildProcessOutput(
+        int $index,
+        ?int $pid,
+        string $type,
+        string $buffer,
+        string $progressSymbol
+    ): void {
         $this->records[] = [
             __FUNCTION__,
             func_get_args(),

tests/Logger/FakeLogger.php

@@ -59,8 +59,13 @@ public function logChildProcessFinished(int $index): void
         throw new DomainException('Unexpected call.');
     }
 
-    public function logUnexpectedChildProcessOutput(int $index, ?int $pid, string $buffer, string $progressSymbol): void
-    {
+    public function logUnexpectedChildProcessOutput(
+        int $index,
+        ?int $pid,
+        string $type,
+        string $buffer,
+        string $progressSymbol
+    ): void {
         throw new DomainException('Unexpected call.');
     }
 }

tests/Logger/StandardLoggerTest.php

@@ -434,6 +434,7 @@ public function test_it_can_log_the_unexpected_output_of_a_child_process(): void
         $this->logger->logUnexpectedChildProcessOutput(
             2,
             23123,
+            'out',
             'An error occurred.',
             self::ADVANCEMENT_CHARACTER,
         );
@@ -458,6 +459,7 @@ public function test_it_can_log_the_unexpected_output_of_a_stopped_child_process
         $this->logger->logUnexpectedChildProcessOutput(
             2,
             null,
+            'out',
             'An error occurred.',
             self::ADVANCEMENT_CHARACTER,
         );
@@ -482,6 +484,7 @@ public function test_it_removes_the_progress_character_of_the_unexpected_output_
         $this->logger->logUnexpectedChildProcessOutput(
             23,
             23132,
+            'out',
             'An error'.self::ADVANCEMENT_CHARACTER.' occurred.',
             self::ADVANCEMENT_CHARACTER,
         );

tests/ParallelExecutorTest.php

@@ -735,7 +735,7 @@ public function test_it_processes_the_child_processes_output(): void
             ],
             [
                 'logUnexpectedChildProcessOutput',
-                [10, null, 'FOO', $progressSymbol],
+                [10, null, 'test', 'FOO', $progressSymbol],
             ],
             [
                 'logAdvance',