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.

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

feat(storage): multi bucket copy #5674

Open
wants to merge 6 commits into
base: multi-bucket
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ import 'package:amplify_core/amplify_core.dart';
/// {@template amplify_core.storage.bucket_info}
/// Presents a storage bucket information.
/// {@endtemplate}
class BucketInfo with AWSEquatable<BucketInfo> {
class BucketInfo
with AWSEquatable<BucketInfo>, AWSSerializable<Map<String, Object?>> {
/// {@macro amplify_core.storage.bucket_info}
const BucketInfo({required this.bucketName, required this.region});
final String bucketName;
Expand All @@ -14,4 +15,10 @@ class BucketInfo with AWSEquatable<BucketInfo> {
bucketName,
region,
];

@override
Map<String, Object?> toJson() => {
'bucketName': bucketName,
'region': region,
};
}
24 changes: 24 additions & 0 deletions packages/amplify_core/lib/src/types/storage/copy_buckets.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import 'package:amplify_core/amplify_core.dart';

/// Presents storage buckets for a copy operation.
class CopyBuckets with AWSSerializable<Map<String, Object?>> {
/// Creates a [CopyBuckets] with [source] and [destination] buckets.
const CopyBuckets({
required this.source,
required this.destination,
});

/// Creates a [CopyBuckets] with the same [bucket] for the [source] and [destination].
CopyBuckets.sameBucket(StorageBucket bucket)
: source = bucket,
destination = bucket;

final StorageBucket source;
final StorageBucket destination;

@override
Map<String, Object?> toJson() => {
'source': source.toJson(),
'destination': destination.toJson(),
};
}
13 changes: 10 additions & 3 deletions packages/amplify_core/lib/src/types/storage/copy_options.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import 'package:aws_common/aws_common.dart';
import 'package:amplify_core/amplify_core.dart';

/// {@template amplify_core.storage.copy_options}
/// Configurable options for `Amplify.Storage.copy`.
Expand All @@ -12,20 +12,27 @@ class StorageCopyOptions
AWSSerializable<Map<String, Object?>>,
AWSDebuggable {
/// {@macro amplify_core.storage.copy_options}
const StorageCopyOptions({this.pluginOptions});
const StorageCopyOptions({
this.pluginOptions,
this.buckets,
});

/// plugin specific options for `Amplify.Storage.copy`.
final StorageCopyPluginOptions? pluginOptions;

/// Optionally specify which buckets to target
final CopyBuckets? buckets;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: Does JS also use CopyBuckets buckets for copy API optinal param?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No they have a different copy signature that is more extensible:

  • source
    • path
    • bucket
  • destination
    • path
    • bucket

I prefer their signature over ours, but it would be a breaking change to wrap our source/destination parameters in an object, so I think we stick with the CopyBuckets approach.


@override
List<Object?> get props => [pluginOptions];
List<Object?> get props => [pluginOptions, buckets];

@override
String get runtimeTypeName => 'StorageCopyOptions';

@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'buckets': buckets?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class StorageDownloadDataOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class StorageDownloadFileOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class StorageGetPropertiesOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class StorageGetUrlOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class StorageListOptions
Map<String, Object?> toJson() => {
'pageSize': pageSize,
'nextToken': nextToken,
'bucket': bucket,
'bucket': bucket?.toJson(),
'pluginOptions': pluginOptions?.toJson(),
};
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class StorageRemoveManyOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class StorageRemoveOptions
@override
Map<String, Object?> toJson() => {
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import 'package:amplify_core/amplify_core.dart';
import 'package:amplify_core/src/config/amplify_outputs/storage/storage_outputs.dart';
import 'package:amplify_core/src/types/storage/bucket_info.dart';
import 'package:amplify_core/src/types/storage/storage_bucket_from_outputs.dart';
import 'package:meta/meta.dart';

/// Presents a storage bucket.
class StorageBucket {
class StorageBucket with AWSSerializable<Map<String, Object?>> {
/// Creates a [StorageBucket] from [BucketInfo].
const StorageBucket.fromBucketInfo(this._info);

Expand All @@ -16,4 +16,9 @@ class StorageBucket {

@internal
BucketInfo resolveBucketInfo(StorageOutputs? storageOutputs) => _info;

@override
Map<String, Object?> toJson() => {
'_info': _info.toJson(),
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,9 @@ class StorageBucketFromOutputs implements StorageBucket {
region: bucket.awsRegion,
);
}

@override
Map<String, Object?> toJson() => {
'_name': _name,
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export '../exception/amplify_exception.dart'
NetworkException,
UnknownException;
export 'bucket_info.dart';
export 'copy_buckets.dart';
export 'copy_operation.dart';
export 'copy_options.dart';
export 'copy_request.dart';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class StorageUploadDataOptions
Map<String, Object?> toJson() => {
'metadata': metadata,
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class StorageUploadFileOptions
Map<String, Object?> toJson() => {
'metadata': metadata,
'pluginOptions': pluginOptions?.toJson(),
'bucket': bucket,
'bucket': bucket?.toJson(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,90 @@ void main() {
expect(result.copiedItem.path, destinationPath);
});
});

group('multi bucket', () {
final data = 'copy data'.codeUnits;
final bucket1 = StorageBucket.fromOutputs(
'Storage Integ Test main bucket',
);
final bucket2 = StorageBucket.fromOutputs(
'Storage Integ Test secondary bucket',
);
final bucket1PathSource = 'public/multi-bucket-get-url-${uuid()}';
final bucket2PathSource = 'public/multi-bucket-get-url-${uuid()}';
final bucket2PathDestination = 'public/multi-bucket-get-url-${uuid()}';
final storageBucket1PathSource =
StoragePath.fromString(bucket1PathSource);
final storageBucket2PathSource =
StoragePath.fromString(bucket2PathSource);
final storageBucket2PathDestination =
StoragePath.fromString(bucket2PathDestination);

setUp(() async {
await configure(amplifyEnvironments['main']!);
addTearDownPath(storageBucket1PathSource);
addTearDownPath(storageBucket2PathSource);
addTearDownPath(storageBucket2PathDestination);
await Amplify.Storage.uploadData(
data: StorageDataPayload.bytes(data),
path: storageBucket1PathSource,
options: StorageUploadDataOptions(
bucket: bucket1,
),
).result;
await Amplify.Storage.uploadData(
data: StorageDataPayload.bytes(data),
path: storageBucket2PathSource,
options: StorageUploadDataOptions(
bucket: bucket2,
),
).result;
});

testWidgets('copy to a different bucket', (_) async {
final result = await Amplify.Storage.copy(
source: storageBucket1PathSource,
destination: storageBucket2PathDestination,
options: StorageCopyOptions(
buckets: CopyBuckets(
source: bucket1,
destination: bucket2,
),
),
).result;
expect(result.copiedItem.path, bucket2PathDestination);

final downloadResult = await Amplify.Storage.downloadData(
path: storageBucket2PathDestination,
options: StorageDownloadDataOptions(bucket: bucket2),
).result;
expect(
downloadResult.bytes,
data,
);
});

testWidgets('copy to the same bucket', (_) async {
final result = await Amplify.Storage.copy(
source: storageBucket2PathSource,
destination: storageBucket2PathDestination,
options: StorageCopyOptions(
buckets: CopyBuckets.sameBucket(
bucket2,
),
),
).result;
expect(result.copiedItem.path, bucket2PathDestination);

final downloadResult = await Amplify.Storage.downloadData(
path: storageBucket2PathDestination,
options: StorageDownloadDataOptions(bucket: bucket2),
).result;
expect(
downloadResult.bytes,
data,
);
});
});
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface

final s3Options = StorageCopyOptions(
pluginOptions: s3PluginOptions,
buckets: options?.buckets,
);

return S3CopyOperation(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -412,21 +412,25 @@ class StorageS3Service {
}) async {
final s3PluginOptions = options.pluginOptions as S3CopyPluginOptions? ??
const S3CopyPluginOptions();
final s3ClientInfoSource =
getS3ClientInfo(storageBucket: options.buckets?.source);
final s3ClientInfoDestination =
getS3ClientInfo(storageBucket: options.buckets?.destination);

final [sourcePath, destinationPath] = await _pathResolver.resolvePaths(
paths: [source, destination],
);

final copyRequest = s3.CopyObjectRequest.build((builder) {
builder
..bucket = _storageOutputs.bucketName
..copySource = '${_storageOutputs.bucketName}/$sourcePath'
..bucket = s3ClientInfoDestination.bucketName
..copySource = '${s3ClientInfoSource.bucketName}/$sourcePath'
..key = destinationPath
..metadataDirective = s3.MetadataDirective.copy;
});
tyllark marked this conversation as resolved.
Show resolved Hide resolved

try {
await _defaultS3Client.copyObject(copyRequest).result;
await s3ClientInfoDestination.client.copyObject(copyRequest).result;
} on smithy.UnknownSmithyHttpException catch (error) {
// S3Client.copyObject may return 403 or 404 error
throw error.toStorageException();
Expand All @@ -438,8 +442,8 @@ class StorageS3Service {
copiedItem: s3PluginOptions.getProperties
? S3Item.fromHeadObjectOutput(
await headObject(
s3client: _defaultS3Client,
bucket: _storageOutputs.bucketName,
s3client: s3ClientInfoDestination.client,
bucket: s3ClientInfoDestination.bucketName,
key: destinationPath,
),
path: destinationPath,
Expand Down
Loading