Merge pull request #31 from chrisnharvey/augment-dirs

Fix deep file and directory listing

Author: mzur

src/SwiftAdapter.php

@@ -236,12 +236,23 @@ public function listContents(string $path, bool $deep): iterable
     {
         $location = $this->prefixer->prefixDirectoryPath($path);
 
-        // Fetch objects with preudo-directory support. See:
-        // https://docs.openstack.org/swift/latest/api/pseudo-hierarchical-folders-directories.html
-        $objectList = $this->container->listObjects([
-            'prefix' => $location,
-            'delimiter' => '/',
-        ]);
+        $config = ['prefix' => $location];
+
+        // Fetch objects with preudo-directory support. This limits the returned list of
+        // objects to only those that are direct children of the queried location.
+        // See: https://docs.openstack.org/swift/latest/api/pseudo-hierarchical-folders-directories.html
+        if (!$deep) {
+            $config['delimiter'] = '/';
+        }
+
+        $objectList = $this->container->listObjects($config);
+
+        // Swift only returns directories when the delimiter is used (see above).
+        // But this does not recurse the directory structure. In this case we have
+        // to generate the pseudo directories from the list of objects ourselves.
+        if ($deep) {
+            $objectList = $this->augmentPseudoDirectories($location, $objectList);
+        }
 
         foreach ($objectList as $object) {
             yield $this->normalizeObject($object);
@@ -375,4 +386,43 @@ protected function getStreamFromResource($resource): Stream
     {
         return new Stream($resource);
     }
+
+    /**
+     * Adds pseudo-directories to a list of storage objects.
+     *
+     * @param string $location
+     * @param iterable $objectList
+     *
+     * @return \Generator
+     */
+    protected function augmentPseudoDirectories(string $location, iterable $objectList): \Generator
+    {
+        $processedDirectories = [];
+        $prefixLength = strlen($location);
+
+        foreach ($objectList as $object) {
+            // Strip the prefix from the path. We only want to augment directories from
+            // the prefix down.
+            $path = explode('/', substr($object->name, $prefixLength));
+            $filename = array_pop($path);
+            $fullPath = '';
+            foreach ($path as $part) {
+                $fullPath .= $part.'/';
+                if (!array_key_exists($fullPath, $processedDirectories)) {
+                    $processedDirectories[$fullPath] = null;
+                    $dirObject = clone $object;
+                    // Re-apply the prefix here.
+                    $dirObject->name = $location.$fullPath;
+                    $dirObject->hash = null;
+                    $dirObject->contentType = null;
+                    $dirObject->contentLength = null;
+                    $dirObject->lastModified = null;
+
+                    yield $dirObject;
+                }
+            }
+
+            yield $object;
+        }
+    }
 }

tests/SwiftAdapterTest.php

@@ -191,10 +191,9 @@ public function testListContents()
 
     public function testListContentsPseudoDirectory()
     {
-        $object = Mockery::mock(StorageObject::class);
-        $object->name = 'name/';
-        $generator = function () use ($object) {
-            yield $object;
+        $this->object->name = 'name/';
+        $generator = function () {
+            yield $this->object;
         };
         $objects = $generator();
         $this->container->shouldReceive('listObjects')
@@ -217,6 +216,79 @@ public function testListContentsPseudoDirectory()
         $this->assertEquals($expect, $contents[0]->jsonSerialize());
     }
 
+    public function testListContentsDeep()
+    {
+        $times = mt_rand(1, 10);
+
+        $generator = function () {
+            yield $this->object;
+        };
+
+        $objects = $generator();
+
+        $this->container->shouldReceive('listObjects')
+            ->once()
+            ->with([
+                'prefix' => 'hello/',
+            ])
+            ->andReturn($objects);
+
+        $expect = [
+            'path' => 'name',
+            'type' => 'file',
+            'last_modified' => 1628624822,
+            'mime_type' => 'text/html; charset=UTF-8',
+            'visibility' => null,
+            'file_size' => 0,
+            'extra_metadata' => [],
+        ];
+
+        $contents = $this->adapter->listContents('hello', true);
+
+        foreach ($contents as $file) {
+            $this->assertEquals($expect, $file->jsonSerialize());
+        }
+    }
+
+    public function testListContentsPseudoDirectoryDeep()
+    {
+        $this->object->name = 'pseudo/directory/name';
+        $generator = function () {
+            yield $this->object;
+        };
+        $objects = $generator();
+        $this->container->shouldReceive('listObjects')
+            ->once()
+            ->with([
+                'prefix' => 'pseudo/',
+            ])
+            ->andReturn($objects);
+
+        $expect = [
+            [
+                'path' => 'pseudo/directory',
+                'type' => 'dir',
+                'visibility' => null,
+                'extra_metadata' => [],
+                'last_modified' => null,
+            ],
+            [
+                'path' => 'pseudo/directory/name',
+                'type' => 'file',
+                'last_modified' => 1628624822,
+                'mime_type' => 'text/html; charset=UTF-8',
+                'visibility' => null,
+                'file_size' => 0,
+                'extra_metadata' => [],
+            ],
+        ];
+
+        $contents = $this->adapter->listContents('pseudo', true);
+        foreach ($contents as $index => $value) {
+            $this->assertEquals($expect[$index], $value->jsonSerialize());
+        }
+    }
+
     public function testMove()
     {
         $this->object->shouldReceive('copy')->once()->with([