refactor: cover azure filesystem bridge with mago

norberttech · norberttech · commit 4cb662c67d63 · 2026-05-27T10:25:41.000+02:00
diff --git a/Justfile b/Justfile
@@ -76,7 +76,8 @@ analyze-mago *args:
         src/bridge/psr3/telemetry \
         src/bridge/symfony/http-foundation-telemetry \
         src/bridge/telemetry/otlp \
-        src/bridge/filesystem/async-aws
+        src/bridge/filesystem/async-aws \
+        src/bridge/filesystem/azure
 
 # Auto-fix code style (Mago format + lint --fix) and GitHub Actions findings (zizmor --fix).
 fix:
diff --git a/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobDestinationStream.php b/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobDestinationStream.php
@@ -44,10 +44,6 @@ public static function openAppend(
         BlockFactory $blockFactory = new NativeLocalFileBlocksFactory(),
         int $blockSize = 1024 * 1024 * 4,
     ): self {
-        if ($blockSize < 1) {
-            throw new InvalidArgumentException('Block size must be greater than 0');
-        }
-
         $blocks = new Blocks(
             $blockSize,
             $blockFactory,
@@ -74,10 +70,6 @@ public static function openBlank(
         BlockFactory $blockFactory = new NativeLocalFileBlocksFactory(),
         int $blockSize = 1024 * 1024 * 4,
     ): self {
-        if ($blockSize < 1) {
-            throw new InvalidArgumentException('Block size must be greater than 0');
-        }
-
         return new self(
             $blobService,
             $path,
@@ -118,9 +110,7 @@ public function close(): void
 
             $this->blobService->putBlockBlob($this->path->path(), $handle, $this->blocks->block()->size());
 
-            if (is_resource($handle)) {
-                fclose($handle);
-            }
+            fclose($handle);
 
             unlink($this->blocks->block()->path()->path());
         }
diff --git a/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobDestinationStream/AzureBlobBlockLifecycle.php b/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobDestinationStream/AzureBlobBlockLifecycle.php
@@ -16,7 +16,6 @@
 use function count;
 use function fclose;
 use function fopen;
-use function is_resource;
 use function unlink;
 
 final class AzureBlobBlockLifecycle implements BlockLifecycle
@@ -48,9 +47,7 @@ public function filled(Block $block): void
 
         $this->blobService->putBlockBlobBlock($this->path->path(), $block->id(), $handle, $block->size());
 
-        if (is_resource($handle)) {
-            fclose($handle);
-        }
+        fclose($handle);
 
         unlink($block->path()->path());
 
diff --git a/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobFilesystem.php b/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobFilesystem.php
@@ -52,6 +52,9 @@ public function getSystemTmpDir(): Path
         return $this->options->tmpDir();
     }
 
+    /**
+     * @return \Generator<FileStatus>
+     */
     public function list(Path $path, Filter $pathFilter = new KeepAll()): Generator
     {
         $this->mount->supports($path) || throw new InvalidSchemeException($path->protocol(), $this->mount->protocol);
diff --git a/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobSourceStream.php b/src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/AzureBlobSourceStream.php
@@ -47,8 +47,9 @@ public function isOpen(): bool
     public function iterate(int $length = 1): Generator
     {
         $offset = 0;
+        $size = $this->size() ?? 0;
 
-        while ($offset < $this->size()) {
+        while ($offset < $size) {
             yield $this->read($length, $offset);
             $offset += $length;
         }
@@ -61,7 +62,7 @@ public function path(): Path
 
     public function read(int $length, int $offset): string
     {
-        $offset = $offset < 0 ? $this->size() + $offset : $offset;
+        $offset = $offset < 0 ? ($this->size() ?? 0) + $offset : $offset;
 
         return $this->blobService
             ->getBlob($this->path->path(), (new GetBlobOptions())->withRange(new Range($offset, $offset + $length - 1)))
@@ -72,8 +73,9 @@ public function readLines(string $separator = "\n", ?int $length = null): Genera
     {
         $offset = 0;
         $content = '';
+        $size = $this->size() ?? 0;
 
-        while ($offset < $this->size()) {
+        while ($offset < $size) {
             // Read a chunk of the file
             $chunk = $this->read($length ?? (1024 * 1024 * 9), $offset);
             $offset += strlen($chunk);
@@ -96,12 +98,12 @@ public function readLines(string $separator = "\n", ?int $length = null): Genera
 
                 $content = $lines[$lastIndex];
             } elseif (substr_count($content, $separator) === 1) {
-                // Split the content by the separator
-                /**
-                 * @phpstan-ignore-next-line
-                 */
-                yield substr($content, 0, strpos($content, $separator));
-                $content = substr($content, strpos($content, $separator) + 1);
+                $pos = strpos($content, $separator);
+
+                if ($pos !== false) {
+                    yield substr($content, 0, $pos);
+                    $content = substr($content, $pos + 1);
+                }
             }
         }
 
diff --git a/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Integration/AzureBlobDestinationStreamTest.php b/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Integration/AzureBlobDestinationStreamTest.php
@@ -31,8 +31,10 @@ public function test_writing_content_bigger_than_block_size_to_azure(): void
         $stream->append($content = str_repeat('a', 200));
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame($content, $fs->readFrom(path('azure-blob://file.txt'))->content());
 
         $fs->rm(path('azure-blob://file.txt'));
@@ -48,8 +50,10 @@ public function test_writing_content_from_resource(): void
         $stream->fromResource($resource);
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://orders.csv'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://orders.csv'))->isDirectory());
+        $status = $fs->status(path('azure-blob://orders.csv'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame(
             file_get_contents(__DIR__ . '/Fixtures/orders.csv'),
             $fs->readFrom(path('azure-blob://orders.csv'))->content(),
@@ -66,8 +70,10 @@ public function test_writing_content_smaller_than_block_size_to_azure(): void
         $stream->append('Hello, World!');
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame('Hello, World!', $fs->readFrom(path('azure-blob://file.txt'))->content());
 
         $fs->rm(path('azure-blob://file.txt'));
diff --git a/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Integration/AzureBlobFilesystemTest.php b/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Integration/AzureBlobFilesystemTest.php
@@ -27,8 +27,10 @@ public function test_appending_to_existing_blob(): void
         $stream->append("This is second line\n");
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame(<<<'TXT'
             This is first line
             This is second line
@@ -59,8 +61,10 @@ public function test_appending_to_existing_block_blob_new_blocks(): void
         }
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame($output, $fs->readFrom(path('azure-blob://file.txt'))->content());
 
         $fs->rm(path('azure-blob://file.txt'));
@@ -83,8 +87,10 @@ public function test_appending_to_existing_non_block_blob_new_blocks(): void
         }
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame($output, $fs->readFrom(path('azure-blob://file.txt'))->content());
 
         $fs->rm(path('azure-blob://file.txt'));
@@ -153,11 +159,10 @@ public function test_file_status_on_pattern(): void
         static::assertIsResource($resource);
         $fs->writeTo(path('azure-blob://some_path_to/file.txt'))->fromResource($resource)->close();
 
-        static::assertTrue($fs->status(path('azure-blob://some_path_to/*.txt'))?->isFile());
-        static::assertSame(
-            'azure-blob://some_path_to/file.txt',
-            $fs->status(path('azure-blob://some_path_to/*.txt'))->path->uri(),
-        );
+        $status = $fs->status(path('azure-blob://some_path_to/*.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertSame('azure-blob://some_path_to/file.txt', $status->path->uri());
     }
 
     public function test_file_status_on_root_folder(): void
@@ -316,8 +321,10 @@ public function test_writing_to_azure_blob_storage(): void
         $stream->append('Hello, World!');
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://file.txt'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://file.txt'))->isDirectory());
+        $status = $fs->status(path('azure-blob://file.txt'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame('Hello, World!', $fs->readFrom(path('azure-blob://file.txt'))->content());
 
         $fs->rm(path('azure-blob://file.txt'));
@@ -333,8 +340,10 @@ public function test_writing_to_to_azure_from_resources(): void
         $stream->fromResource($resource);
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://orders.csv'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://orders.csv'))->isDirectory());
+        $status = $fs->status(path('azure-blob://orders.csv'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
         static::assertSame(
             file_get_contents(__DIR__ . '/Fixtures/orders.csv'),
             $fs->readFrom(path('azure-blob://orders.csv'))->content(),
@@ -355,8 +364,10 @@ public function test_writing_to_to_azure_using_blocks(): void
 
         $stream->close();
 
-        static::assertTrue($fs->status(path('azure-blob://block_blob.csv'))?->isFile());
-        static::assertFalse($fs->status(path('azure-blob://block_blob.csv'))->isDirectory());
+        $status = $fs->status(path('azure-blob://block_blob.csv'));
+        static::assertNotNull($status);
+        static::assertTrue($status->isFile());
+        static::assertFalse($status->isDirectory());
 
         $fs->rm(path('azure-blob://block_blob.csv'));
     }
diff --git a/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Unit/AzureBlobDestinationStreamTest.php b/src/bridge/filesystem/azure/tests/Flow/Filesystem/Bridge/Azure/Tests/Unit/AzureBlobDestinationStreamTest.php
@@ -53,9 +53,9 @@ public function test_using_put_blob_with_content_when_data_is_larger_than_block_
             ->method('putBlockBlobBlock')
             ->with(
                 '/file.txt',
-                static::isType('string'),
-                static::isType('resource'),
-                static::isType('int'),
+                static::isString(),
+                static::isResource(),
+                static::isInt(),
                 static::isInstanceOf(PutBlockBlobBlockOptions::class),
             );
 
@@ -98,7 +98,7 @@ public function test_using_put_blob_with_content_when_data_is_smaller_than_block
             ->method('putBlockBlob')
             ->with(
                 '/file.txt',
-                static::isType('resource'),
+                static::isResource(),
                 strlen('Hello, World!'),
                 static::isInstanceOf(PutBlockBlobOptions::class),
             );
diff --git a/src/lib/azure-sdk/src/Flow/Azure/SDK/BlobService.php b/src/lib/azure-sdk/src/Flow/Azure/SDK/BlobService.php
@@ -367,7 +367,7 @@ public function getContainerProperties(GetContainerPropertiesOptions $options =
     /**
      * @throws AzureException
      *
-     * @return \Generator<Blob>
+     * @return \Generator<int, Blob>
      */
     public function listBlobs(ListBlobOptions $options = new ListBlobOptions()): Generator
     {
diff --git a/src/lib/azure-sdk/src/Flow/Azure/SDK/BlobServiceInterface.php b/src/lib/azure-sdk/src/Flow/Azure/SDK/BlobServiceInterface.php
@@ -47,7 +47,7 @@ public function getBlockBlobBlockList(
     public function getContainerProperties(GetContainerPropertiesOptions $options = new GetContainerPropertiesOptions()): ?ContainerProperties;
 
     /**
-     * @return \Generator<Blob>
+     * @return \Generator<int, Blob>
      */
     public function listBlobs(ListBlobOptions $options = new ListBlobOptions()): Generator;
 
diff --git a/src/lib/azure-sdk/src/Flow/Azure/SDK/HttpFactory.php b/src/lib/azure-sdk/src/Flow/Azure/SDK/HttpFactory.php
@@ -12,6 +12,7 @@
 
 use function is_resource;
 use function is_string;
+use function stream_get_contents;
 
 final readonly class HttpFactory
 {
@@ -53,6 +54,12 @@ public function stream($content): StreamInterface
             return $this->streamFactory->createStream($content);
         }
 
-        return $this->streamFactory->createStreamFromResource($content);
+        $string = stream_get_contents($content);
+
+        if ($string === false) {
+            throw new InvalidArgumentException('Failed to read content from resource');
+        }
+
+        return $this->streamFactory->createStream($string);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,9 @@ public function getSystemTmpDir(): Path`
`52`	`52`	`return $this->options->tmpDir();`
`53`	`53`	`}`
`54`	`54`
	`55`	`+ /**`
	`56`	`+ * @return \Generator<FileStatus>`
	`57`	`+ */`
`55`	`58`	`public function list(Path $path, Filter $pathFilter = new KeepAll()): Generator`
`56`	`59`	`{`
`57`	`60`	`$this->mount->supports($path) \|\| throw new InvalidSchemeException($path->protocol(), $this->mount->protocol);`
Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ public function getContainerProperties(GetContainerPropertiesOptions $options =`
`367`	`367`	`/**`
`368`	`368`	`* @throws AzureException`
`369`	`369`	`*`
`370`		`- * @return \Generator<Blob>`
	`370`	`+ * @return \Generator<int, Blob>`
`371`	`371`	`*/`
`372`	`372`	`public function listBlobs(ListBlobOptions $options = new ListBlobOptions()): Generator`
`373`	`373`	`{`