Merge pull request #10 from Innmind/more-explicit-errors

Use `Attempt` to better explicit everywhere an action may fail

Author: Baptouuuu

CHANGELOG.md

@@ -14,7 +14,15 @@
 - Requires `innmind/io:~3.2`
 - Requires `innmind/immutable:~5.15`
 - `Innmind\OperatingSystem\Config::withHttpHeartbeat()` period is now expressed with a `Innmind\TimeContinuum\Period`
+- `Innmind\OperatingSystem\CurrentProcess::id()` now returns an `Innmind\Immutable\Attempt`
 - `Innmind\OperatingSystem\CurrentProcess::halt()` now returns `Innmind\Immutable\Attempt<Innmind\Immutable\SideEffect>`
+- `Innmind\OperatingSystem\Filesystem::mount()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Filesystem::temporary()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Ports::open()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Remote::socket()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Sockets::open()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Sockets::takeOver()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\OperatingSystem\Sockets::connectTo()` now returns an `Innmind\Immutable\Attempt`
 
 ### Fixed
 

src/CurrentProcess.php

@@ -14,7 +14,10 @@
 
 interface CurrentProcess
 {
-    public function id(): Pid;
+    /**
+     * @return Attempt<Pid>
+     */
+    public function id(): Attempt;
     public function signals(): Signals;
 
     /**

src/CurrentProcess/Generic.php

@@ -30,13 +30,15 @@ public static function of(Halt $halt): self
     }
 
     #[\Override]
-    public function id(): Pid
+    public function id(): Attempt
     {
-        /**
-         * @psalm-suppress ArgumentTypeCoercion
-         * @psalm-suppress PossiblyFalseArgument
-         */
-        return new Pid(\getmypid());
+        $pid = \getmypid();
+
+        /** @psalm-suppress ArgumentTypeCoercion */
+        return match ($pid) {
+            false => Attempt::error(new \RuntimeException('Failed to retrieve process id')),
+            default => Attempt::result(new Pid($pid)),
+        };
     }
 
     #[\Override]

src/CurrentProcess/Logger.php

@@ -4,7 +4,6 @@
 namespace Innmind\OperatingSystem\CurrentProcess;
 
 use Innmind\OperatingSystem\CurrentProcess;
-use Innmind\Server\Control\Server\Process\Pid;
 use Innmind\Server\Status\Server\Memory\Bytes;
 use Innmind\TimeContinuum\Period;
 use Innmind\Immutable\Attempt;
@@ -28,16 +27,16 @@ public static function psr(CurrentProcess $process, LoggerInterface $logger): se
     }
 
     #[\Override]
-    public function id(): Pid
+    public function id(): Attempt
     {
-        $pid = $this->process->id();
+        return $this->process->id()->map(function($pid) {
+            $this->logger->debug(
+                'Current process id is {pid}',
+                ['pid' => $pid->toInt()],
+            );
 
-        $this->logger->debug(
-            'Current process id is {pid}',
-            ['pid' => $pid->toInt()],
-        );
-
-        return $pid;
+            return $pid;
+        });
     }
 
     #[\Override]

src/Filesystem.php

@@ -10,14 +10,18 @@
 use Innmind\Url\Path;
 use Innmind\FileWatch\Ping;
 use Innmind\Immutable\{
+    Attempt,
     Maybe,
     Str,
     Sequence,
 };
 
 interface Filesystem
 {
-    public function mount(Path $path): Adapter;
+    /**
+     * @return Attempt<Adapter>
+     */
+    public function mount(Path $path): Attempt;
     public function contains(Path $path): bool;
 
     /**
@@ -36,7 +40,7 @@ public function watch(Path $path): Ping;
      *
      * @param Sequence<Maybe<Str>> $chunks
      *
-     * @return Maybe<Content>
+     * @return Attempt<Content>
      */
-    public function temporary(Sequence $chunks): Maybe;
+    public function temporary(Sequence $chunks): Attempt;
 }

src/Filesystem/Generic.php

@@ -48,28 +48,30 @@ public static function of(Processes $processes, Config $config): self
     }
 
     #[\Override]
-    public function mount(Path $path): Adapter
+    public function mount(Path $path): Attempt
     {
         /**
          * @var Adapter $adapter
          * @var string $mounted
          */
         foreach ($this->mounted as $adapter => $mounted) {
             if ($path->toString() === $mounted) {
-                return $adapter;
+                return Attempt::result($adapter);
             }
         }
 
-        $adapter = Adapter\Filesystem::mount(
-            $path,
-            $this->config->io(),
-        )
-            ->withCaseSensitivity(
-                $this->config->filesystemCaseSensitivity(),
-            );
-        $this->mounted[$adapter] = $path->toString();
-
-        return $adapter;
+        return Attempt::of(function() use ($path) {
+            $adapter = Adapter\Filesystem::mount(
+                $path,
+                $this->config->io(),
+            )
+                ->withCaseSensitivity(
+                    $this->config->filesystemCaseSensitivity(),
+                );
+            $this->mounted[$adapter] = $path->toString();
+
+            return $adapter;
+        });
     }
 
     #[\Override]
@@ -111,7 +113,7 @@ public function watch(Path $path): Ping
     }
 
     #[\Override]
-    public function temporary(Sequence $chunks): Maybe
+    public function temporary(Sequence $chunks): Attempt
     {
         return Attempt::of(
             fn() => $this
@@ -129,6 +131,6 @@ public function temporary(Sequence $chunks): Maybe
                 ->map(static fn($tmp) => $tmp->read())
                 ->map(Content::io(...))
                 ->unwrap(),
-        )->maybe();
+        );
     }
 }

src/Filesystem/Logger.php

@@ -11,6 +11,7 @@
 use Innmind\Url\Path;
 use Innmind\FileWatch\Ping;
 use Innmind\Immutable\{
+    Attempt,
     Maybe,
     Sequence,
 };
@@ -37,11 +38,13 @@ public static function psr(
     }
 
     #[\Override]
-    public function mount(Path $path): Adapter
+    public function mount(Path $path): Attempt
     {
-        return Adapter\Logger::psr(
-            $this->filesystem->mount($path),
-            $this->logger,
+        return $this->filesystem->mount($path)->map(
+            fn($adapter) => Adapter\Logger::psr(
+                $adapter,
+                $this->logger,
+            ),
         );
     }
 
@@ -82,7 +85,7 @@ public function watch(Path $path): Ping
     }
 
     #[\Override]
-    public function temporary(Sequence $chunks): Maybe
+    public function temporary(Sequence $chunks): Attempt
     {
         return $this
             ->filesystem

src/Ports.php

@@ -9,12 +9,12 @@
     Sockets\Internet\Transport,
 };
 use Innmind\IP\IP;
-use Innmind\Immutable\Maybe;
+use Innmind\Immutable\Attempt;
 
 interface Ports
 {
     /**
-     * @return Maybe<Server>
+     * @return Attempt<Server>
      */
-    public function open(Transport $transport, IP $ip, Port $port): Maybe;
+    public function open(Transport $transport, IP $ip, Port $port): Attempt;
 }

src/Ports/Logger.php

@@ -7,7 +7,7 @@
 use Innmind\Url\Authority\Port;
 use Innmind\IO\Sockets\Internet\Transport;
 use Innmind\IP\IP;
-use Innmind\Immutable\Maybe;
+use Innmind\Immutable\Attempt;
 use Psr\Log\LoggerInterface;
 
 final class Logger implements Ports
@@ -27,7 +27,7 @@ public static function psr(Ports $ports, LoggerInterface $logger): self
     }
 
     #[\Override]
-    public function open(Transport $transport, IP $ip, Port $port): Maybe
+    public function open(Transport $transport, IP $ip, Port $port): Attempt
     {
         $this->logger->debug(
             'Opening new port at {address}',

src/Ports/Unix.php

@@ -10,7 +10,7 @@
 use Innmind\Url\Authority\Port;
 use Innmind\IO\Sockets\Internet\Transport;
 use Innmind\IP\IP;
-use Innmind\Immutable\Maybe;
+use Innmind\Immutable\Attempt;
 
 final class Unix implements Ports
 {
@@ -30,14 +30,13 @@ public static function of(Config $config): self
     }
 
     #[\Override]
-    public function open(Transport $transport, IP $ip, Port $port): Maybe
+    public function open(Transport $transport, IP $ip, Port $port): Attempt
     {
         return $this
             ->config
             ->io()
             ->sockets()
             ->servers()
-            ->internet($transport, $ip, $port)
-            ->maybe();
+            ->internet($transport, $ip, $port);
     }
 }