updates, simple functions for base64 un/serializing of return values, only when result

- `triggerSuccess` should handle actual returned values, no last output
- keep `libuv` doc/stubs in sync with [WIP] PR amphp/ext-uv#77

Author: TheTechsTech

Spawn/Container.php

@@ -36,13 +36,13 @@
 
     $output = $task($channel);
 
-    \fwrite(\STDOUT, \base64_encode(\serialize($output)));
+    \fwrite(\STDOUT, \serializer($output));
 
     exit(0);
 } catch (\Throwable $exception) {
     $output = new SerializableException($exception);
 
-    \fwrite(\STDERR, \base64_encode(\serialize($output)));
+    \fwrite(\STDERR, \serializer($output));
 
     exit(1);
 }

Spawn/Core.php

@@ -277,6 +277,32 @@ function is_base64($input): ?bool
         return false;
     }
 
+    /**
+     * Create a encoded base64 valid string from a **serializable** data value.
+     *
+     * @param mixed $input
+     *
+     * @return string
+     *
+     * @codeCoverageIgnore
+     */
+    function serializer($input)
+    {
+        return \base64_encode(\serialize($input));
+    }
+
+    /**
+     * Decodes and creates a `PHP` value from the **serialized** data.
+     *
+     * @param string $input
+     *
+     * @return mixed
+     */
+    function deserializer($input)
+    {
+        return @\unserialize(\base64_decode($input));
+    }
+
     /**
      * Check if base64 valid, if so decodes and creates a `PHP` value from the
      * **serialized** decoded data representation.
@@ -289,7 +315,7 @@ function is_base64($input): ?bool
      */
     function deserialize($input)
     {
-        return \is_base64($input) ? \unserialize(\base64_decode($input)) : $input;
+        return \is_base64($input) ? \deserializer($input) : $input;
     }
 
     /**

Spawn/Launcher.php

@@ -472,7 +472,7 @@ public function clean($output = null)
     protected function decode($output, $errorSet = false)
     {
         if (\is_string($output)) {
-            $realOutput = @\unserialize(\base64_decode($output));
+            $realOutput = \deserializer($output);
             if (!$realOutput) {
                 $realOutput = $output;
                 if ($errorSet) {
@@ -483,7 +483,6 @@ protected function decode($output, $errorSet = false)
             return $realOutput;
         }
 
-
         return $output;
     }
 
@@ -665,28 +664,27 @@ public function triggerSuccess(bool $isYield = false)
     {
         $this->status = true;
 
+        $result = null;
         if ($this->getResult() && !$this->getErrorOutput()) {
-            $output = $this->lastResult;
+            $result = $this->lastResult;
         } elseif ($this->getErrorOutput()) {
             return $this->triggerError($isYield);
-        } else {
-            $output = $this->getOutput();
         }
 
-        if (\is_base64($output) !== false) {
+        if (\is_base64($result) !== false) {
             // @codeCoverageIgnoreStart
-            $this->rawLastResult = $this->clean($output);
-            $output = $this->decoded($this->rawLastResult);
+            $this->rawLastResult = $this->clean($result);
+            $result = $this->decoded($this->rawLastResult);
             // @codeCoverageIgnoreEnd
         }
 
         if ($isYield)
-            return $this->yieldSuccess($output);
+            return $this->yieldSuccess($result);
 
         foreach ($this->successCallbacks as $callback)
-            $callback($output);
+            $callback($result);
 
-        return $output;
+        return $result;
     }
 
     public function triggerError(bool $isYield = false)

Spawn/UVFunctions.php

@@ -667,6 +667,7 @@ function uv_queue_work(UVLoop $loop, callable $callback, callable $after_callbac
 /**
  * Initialize the `UVIdle` handle watcher.
  * Idle watchers get invoked every loop iteration.
+ * This function always succeeds.
  *
  * @param UVLoop $loop uv_loop handle.
  *
@@ -678,6 +679,7 @@ function uv_idle_init(UVLoop $loop = null)
 
 /**
  * Start the Idle handle with the given callback.
+ * This function always succeeds, except when `callback` is `NULL`.
  *
  * The callbacks of idle handles are invoked once per event loop.
  *
@@ -702,6 +704,7 @@ function uv_idle_start(UVIdle $idle, callable $callback)
 
 /**
  * Stop the Idle handle, the callback will no longer be called.
+ * This function always succeeds.
  *
  * @param UVIdle $idle uv_idle handle.
  */
@@ -711,6 +714,7 @@ function uv_idle_stop(UVIdle $idle)
 
 /**
  * Initialize the `UVPrepare` handle watcher.
+ * This function always succeeds.
  * Prepare watchers get invoked before polling for I/O events.
  *
  * Their main purpose is to integrate other event mechanisms into `libuv` and their
@@ -727,6 +731,7 @@ function uv_prepare_init(UVLoop $loop = null)
 
 /**
  * Start the Prepare handle with the given callback.
+ * This function always succeeds, except when `callback` is `NULL`.
  *
  * @param UVPrepare $handle UV handle (prepare)
  * @param callable $callback expects (UVPrepare $prepare, int $status).
@@ -737,6 +742,7 @@ function uv_prepare_start(UVPrepare $handle, callable $callback)
 
 /**
  * Stop the Prepare handle, the callback will no longer be called.
+ * This function always succeeds.
  *
  * @param UVPrepare $handle UV handle (prepare).
  */
@@ -746,6 +752,7 @@ function uv_prepare_stop(UVPrepare $handle)
 
 /**
  * Initialize the `UVCheck` handle watcher.
+ * This function always succeeds.
  * Check watchers get invoked after polling for I/O events.
  *
  * Their main purpose is to integrate other event mechanisms into `libuv` and their
@@ -762,6 +769,7 @@ function uv_check_init(UVLoop $loop = null)
 
 /**
  * Start the Check handle with the given callback.
+ * This function always succeeds, except when `callback` is `NULL`.
  *
  * @param UVCheck $handle UV handle (check).
  * @param callable $callback expects (UVCheck $check, int $status).
@@ -772,6 +780,7 @@ function uv_check_start(UVCheck $handle, callable $callback)
 
 /**
  * Stop the Check handle, the callback will no longer be called.
+ * This function always succeeds.
  *
  * @param UVCheck $handle UV handle (check).
  */