Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AsyncS3: throw FilesystemOperationFailed exceptions in case upload or listContent fails #1819

Merged
merged 1 commit into from
Sep 27, 2024
Merged

AsyncS3: throw FilesystemOperationFailed exceptions in case upload or listContent fails #1819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 55 additions & 33 deletions src/AsyncAwsS3/AsyncAwsS3Adapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@
use League\Flysystem\UnableToCheckDirectoryExistence;
use League\Flysystem\UnableToCheckFileExistence;
use League\Flysystem\UnableToCopyFile;
use League\Flysystem\UnableToCreateDirectory;
use League\Flysystem\UnableToDeleteDirectory;
use League\Flysystem\UnableToDeleteFile;
use League\Flysystem\UnableToGeneratePublicUrl;
use League\Flysystem\UnableToGenerateTemporaryUrl;
use League\Flysystem\UnableToListContents;
use League\Flysystem\UnableToMoveFile;
use League\Flysystem\UnableToProvideChecksum;
use League\Flysystem\UnableToReadFile;
use League\Flysystem\UnableToRetrieveMetadata;
use League\Flysystem\UnableToSetVisibility;
use League\Flysystem\UnableToWriteFile;
use League\Flysystem\UrlGeneration\PublicUrlGenerator;
use League\Flysystem\UrlGeneration\TemporaryUrlGenerator;
use League\Flysystem\Visibility;
Expand Down Expand Up @@ -177,32 +181,42 @@ public function deleteDirectory(string $path): void

$objects = [];
$params = ['Bucket' => $this->bucket, 'Prefix' => $prefix];
$result = $this->client->listObjectsV2($params);
/** @var AwsObject $item */
foreach ($result->getContents() as $item) {
$key = $item->getKey();
if (null !== $key) {
$objects[] = new ObjectIdentifier(['Key' => $key]);

try {
$result = $this->client->listObjectsV2($params);
/** @var AwsObject $item */
foreach ($result->getContents() as $item) {
$key = $item->getKey();
if (null !== $key) {
$objects[] = new ObjectIdentifier(['Key' => $key]);
}
}
}

if (empty($objects)) {
return;
}
if (empty($objects)) {
return;
}

foreach (array_chunk($objects, 1000) as $chunk) {
$this->client->deleteObjects([
'Bucket' => $this->bucket,
'Delete' => ['Objects' => $chunk],
]);
foreach (array_chunk($objects, 1000) as $chunk) {
$this->client->deleteObjects([
'Bucket' => $this->bucket,
'Delete' => ['Objects' => $chunk],
]);
}
} catch (\Throwable $e) {
throw UnableToDeleteDirectory::atLocation($path, $e->getMessage(), $e);
}
}

public function createDirectory(string $path, Config $config): void
{
$defaultVisibility = $config->get(Config::OPTION_DIRECTORY_VISIBILITY, $this->visibility->defaultForDirectories());
$config = $config->withDefaults([Config::OPTION_VISIBILITY => $defaultVisibility]);
$this->upload(rtrim($path, '/') . '/', '', $config);

try {
$this->upload(rtrim($path, '/') . '/', '', $config);
} catch (Throwable $e) {
throw UnableToCreateDirectory::dueToFailure($path, $e);
}
}

public function setVisibility(string $path, string $visibility): void
Expand Down Expand Up @@ -292,16 +306,20 @@ public function listContents(string $path, bool $deep): iterable
$options['Delimiter'] = '/';
}

$listing = $this->retrievePaginatedListing($options);
try {
$listing = $this->retrievePaginatedListing($options);

foreach ($listing as $item) {
$item = $this->mapS3ObjectMetadata($item);
foreach ($listing as $item) {
$item = $this->mapS3ObjectMetadata($item);

if ($item->path() === $path) {
continue;
}
if ($item->path() === $path) {
continue;
}

yield $item;
yield $item;
}
} catch (\Throwable $e) {
throw UnableToListContents::atLocation($path, $deep, $e);
}
}

Expand Down Expand Up @@ -363,16 +381,20 @@ private function upload(string $path, $body, Config $config): void
$options['ContentType'] = $mimeType;
}

if ($this->client instanceof SimpleS3Client) {
// Supports upload of files larger than 5GB
$this->client->upload($this->bucket, $key, $body, array_merge($options, ['ACL' => $acl]));
} else {
$this->client->putObject(array_merge($options, [
'Bucket' => $this->bucket,
'Key' => $key,
'Body' => $body,
'ACL' => $acl,
]));
try {
if ($this->client instanceof SimpleS3Client) {
// Supports upload of files larger than 5GB
$this->client->upload($this->bucket, $key, $body, array_merge($options, ['ACL' => $acl]));
} else {
$this->client->putObject(array_merge($options, [
'Bucket' => $this->bucket,
'Key' => $key,
'Body' => $body,
'ACL' => $acl,
]));
}
} catch (Throwable $exception) {
throw UnableToWriteFile::atLocation($path, $exception->getMessage(), $exception);
}
}

Expand Down
27 changes: 27 additions & 0 deletions src/AsyncAwsS3/AsyncAwsS3AdapterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@
use League\Flysystem\StorageAttributes;
use League\Flysystem\UnableToCheckFileExistence;
use League\Flysystem\UnableToDeleteFile;
use League\Flysystem\UnableToListContents;
use League\Flysystem\UnableToMoveFile;
use League\Flysystem\UnableToRetrieveMetadata;
use League\Flysystem\UnableToWriteFile;
use League\Flysystem\Visibility;
use function getenv;
use function iterator_to_array;
Expand Down Expand Up @@ -324,6 +326,18 @@ public function write_with_simple_s3_client(): void
$filesystem->write($file, $contents, new Config());
}

/**
* @test
*/
public function failing_to_write_a_file(): void
{
$adapter = $this->adapter();
static::$stubS3Client->throwExceptionWhenExecutingCommand('PutObject');
$this->expectException(UnableToWriteFile::class);

$adapter->write('foo/bar.txt', 'contents', new Config());
}

/**
* @test
*/
Expand Down Expand Up @@ -392,6 +406,19 @@ public function top_level_directory_excluded_from_listing(): void
});
}

/**
* @test
*/
public function failing_to_list_contents(): void
{
$adapter = $this->adapter();
static::$stubS3Client->throwExceptionWhenExecutingCommand('ListObjectsV2');

$this->expectException(UnableToListContents::class);

iterator_to_array($adapter->listContents('/path', false));
}

protected static function createFilesystemAdapter(): FilesystemAdapter
{
static::$stubS3Client = new S3ClientStub(static::s3Client(), self::awsConfig());
Expand Down
Loading