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

feat(storage): update storage API options to include bucket #2896

Merged
merged 9 commits into from
Aug 22, 2024
Merged

feat(storage): update storage API options to include bucket #2896

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2101e91
feat(storage): update AWSS3StoragePlugin to support multiple buckets
phantumcode Aug 14, 2024
1ca99f0
add code comments
phantumcode Aug 14, 2024
5fb6724
update storage options
phantumcode Aug 14, 2024
2f914fa
resolve review comments
phantumcode Aug 14, 2024
97e8d51
undo formatting
phantumcode Aug 14, 2024
c38919b
refactor configure method in AWSS3StoragePlugin
phantumcode Aug 14, 2024
93ab0fd
feat(storage): update storage API options to include bucket
phantumcode Aug 14, 2024
8fcfd7e
merge from feature branch
phantumcode Aug 15, 2024
70b357d
update unit test per code review suggestion
phantumcode Aug 20, 2024
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
97 changes: 73 additions & 24 deletions aws-storage-s3/src/main/java/com/amplifyframework/storage/s3/AWSS3StoragePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,13 +362,8 @@ public StorageGetUrlOperation<?> getUrl(
AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (InvalidStorageBucketException exception) {
onError.accept(
new StorageException(
"Unable to find bucket from name in Amplify Outputs.",
exception,
"Ensure the bucket name used is available in Amplify Outputs.")
);
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StorageGetPresignedUrlOperation operation =
Expand Down Expand Up @@ -409,13 +404,8 @@ public StorageGetUrlOperation<?> getUrl(
AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (InvalidStorageBucketException exception) {
onError.accept(
new StorageException(
"Unable to find bucket from name in Amplify Outputs.",
exception,
"Ensure the bucket name used is available in Amplify Outputs.")
);
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StoragePathGetPresignedUrlOperation operation =
Expand Down Expand Up @@ -505,8 +495,15 @@ public StorageDownloadFileOperation<?> downloadFile(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StorageDownloadFileOperation operation = new AWSS3StorageDownloadFileOperation(
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
request,
Expand Down Expand Up @@ -540,9 +537,16 @@ public StorageDownloadFileOperation<?> downloadFile(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StoragePathDownloadFileOperation operation = new AWSS3StoragePathDownloadFileOperation(
request,
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
onProgress,
Expand Down Expand Up @@ -632,8 +636,15 @@ public StorageUploadFileOperation<?> uploadFile(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StorageUploadFileOperation operation = new AWSS3StorageUploadFileOperation(
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
request,
Expand Down Expand Up @@ -670,9 +681,16 @@ public StorageUploadFileOperation<?> uploadFile(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StoragePathUploadFileOperation operation = new AWSS3StoragePathUploadFileOperation(
request,
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
onProgress,
Expand Down Expand Up @@ -760,8 +778,15 @@ public StorageUploadInputStreamOperation<?> uploadInputStream(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StorageUploadInputStreamOperation operation = new AWSS3StorageUploadInputStreamOperation(
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
awsS3StoragePluginConfiguration,
Expand Down Expand Up @@ -798,10 +823,17 @@ public StorageUploadInputStreamOperation<?> uploadInputStream(
useAccelerateEndpoint
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StoragePathUploadInputStreamOperation operation =
new AWSS3StoragePathUploadInputStreamOperation(
request,
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
onProgress,
Expand Down Expand Up @@ -851,9 +883,16 @@ public StorageRemoveOperation<?> remove(
options.getTargetIdentityId()
);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StorageRemoveOperation operation =
new AWSS3StorageRemoveOperation(
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
request,
Expand All @@ -876,9 +915,16 @@ public StorageRemoveOperation<?> remove(
) {
AWSS3StoragePathRemoveRequest request = new AWSS3StoragePathRemoveRequest(path);

AWSS3StorageService storageService = defaultStorageService;
try {
storageService = getStorageService(options.getBucket());
} catch (StorageException exception) {
onError.accept(exception);
}

AWSS3StoragePathRemoveOperation operation =
new AWSS3StoragePathRemoveOperation(
defaultStorageService,
storageService,
executorService,
authCredentialsProvider,
request,
Expand Down Expand Up @@ -1053,15 +1099,18 @@ public StorageListOperation<?> list(
@SuppressLint("UnsafeOptInUsageError")
@VisibleForTesting
@NonNull
AWSS3StorageService getStorageService(@Nullable StorageBucket bucket) throws InvalidStorageBucketException {
AWSS3StorageService getStorageService(@Nullable StorageBucket bucket) throws StorageException {
if (bucket == null) {
return defaultStorageService;
}

if (bucket instanceof OutputsStorageBucket) {
AWSS3StorageService service = getAWSS3StorageService((OutputsStorageBucket) bucket);
if (service == null) {
throw new InvalidStorageBucketException();
throw new StorageException(
"Unable to find bucket from name in Amplify Outputs.",
new InvalidStorageBucketException(),
"Ensure the bucket name used is available in Amplify Outputs.");
} else {
return service;
}
Expand Down
14 changes: 9 additions & 5 deletions ...rc/main/java/com/amplifyframework/storage/s3/options/AWSS3StorageDownloadFileOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ public static Builder builder() {
@SuppressWarnings("deprecation")
public static Builder from(@NonNull final AWSS3StorageDownloadFileOptions options) {
return builder()
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.setUseAccelerateEndpoint(options.useAccelerateEndpoint());
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.setUseAccelerateEndpoint(options.useAccelerateEndpoint())
.bucket(options.getBucket());
}

/**
Expand Down Expand Up @@ -90,7 +91,8 @@ public boolean equals(Object obj) {
} else {
AWSS3StorageDownloadFileOptions that = (AWSS3StorageDownloadFileOptions) obj;
return ObjectsCompat.equals(getAccessLevel(), that.getAccessLevel()) &&
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId());
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId()) &&
ObjectsCompat.equals(getBucket(), that.getBucket());
}
}

Expand All @@ -99,7 +101,8 @@ public boolean equals(Object obj) {
public int hashCode() {
return ObjectsCompat.hash(
getAccessLevel(),
getTargetIdentityId()
getTargetIdentityId(),
getBucket()
);
}

Expand All @@ -111,6 +114,7 @@ public String toString() {
"accessLevel=" + getAccessLevel() +
", targetIdentityId=" + getTargetIdentityId() +
", useAccelerationMode=" + useAccelerateEndpoint() +
", bucket=" + getBucket() +
'}';
}

Expand Down
12 changes: 8 additions & 4 deletions ...age-s3/src/main/java/com/amplifyframework/storage/s3/options/AWSS3StorageListOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ public static Builder builder() {
@SuppressWarnings("deprecation")
public static Builder from(@NonNull final AWSS3StorageListOptions options) {
return builder()
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId());
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.bucket(options.getBucket());
}

/**
Expand All @@ -78,7 +79,8 @@ public boolean equals(Object obj) {
} else {
AWSS3StorageListOptions that = (AWSS3StorageListOptions) obj;
return ObjectsCompat.equals(getAccessLevel(), that.getAccessLevel()) &&
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId());
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId()) &&
ObjectsCompat.equals(getBucket(), that.getBucket());
}
}

Expand All @@ -87,7 +89,8 @@ public boolean equals(Object obj) {
public int hashCode() {
return ObjectsCompat.hash(
getAccessLevel(),
getTargetIdentityId()
getTargetIdentityId(),
getBucket()
);
}

Expand All @@ -98,6 +101,7 @@ public String toString() {
return "AWSS3StorageListOptions {" +
"accessLevel=" + getAccessLevel() +
", targetIdentityId=" + getTargetIdentityId() +
", bucket=" + getBucket() +
'}';
}

Expand Down
12 changes: 8 additions & 4 deletions ...e-s3/src/main/java/com/amplifyframework/storage/s3/options/AWSS3StorageRemoveOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ public static Builder builder() {
@SuppressWarnings("deprecation")
public static Builder from(@NonNull final AWSS3StorageRemoveOptions options) {
return builder()
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId());
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.bucket(options.getBucket());
}

/**
Expand All @@ -79,7 +80,8 @@ public boolean equals(Object obj) {
} else {
AWSS3StorageRemoveOptions that = (AWSS3StorageRemoveOptions) obj;
return ObjectsCompat.equals(getAccessLevel(), that.getAccessLevel()) &&
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId());
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId()) &&
ObjectsCompat.equals(getBucket(), that.getBucket());
}
}

Expand All @@ -88,7 +90,8 @@ public boolean equals(Object obj) {
public int hashCode() {
return ObjectsCompat.hash(
getAccessLevel(),
getTargetIdentityId()
getTargetIdentityId(),
getBucket()
);
}

Expand All @@ -99,6 +102,7 @@ public String toString() {
return "AWSS3StorageRemoveOptions {" +
"accessLevel=" + getAccessLevel() +
", targetIdentityId=" + getTargetIdentityId() +
", bucket=" + getBucket() +
'}';
}

Expand Down
18 changes: 11 additions & 7 deletions .../src/main/java/com/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,12 @@ public static Builder builder() {
@SuppressWarnings("deprecation")
public static Builder from(@NonNull final AWSS3StorageUploadFileOptions options) {
return builder()
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.contentType(options.getContentType())
.serverSideEncryption(options.getServerSideEncryption())
.metadata(options.getMetadata());
.accessLevel(options.getAccessLevel())
.targetIdentityId(options.getTargetIdentityId())
.contentType(options.getContentType())
.serverSideEncryption(options.getServerSideEncryption())
.metadata(options.getMetadata())
.bucket(options.getBucket());
}

/**
Expand Down Expand Up @@ -109,7 +110,8 @@ public boolean equals(Object obj) {
ObjectsCompat.equals(getTargetIdentityId(), that.getTargetIdentityId()) &&
ObjectsCompat.equals(getContentType(), that.getContentType()) &&
ObjectsCompat.equals(getServerSideEncryption(), that.getServerSideEncryption()) &&
ObjectsCompat.equals(getMetadata(), that.getMetadata());
ObjectsCompat.equals(getMetadata(), that.getMetadata()) &&
ObjectsCompat.equals(getBucket(), that.getBucket());
}
}

Expand All @@ -121,7 +123,8 @@ public int hashCode() {
getTargetIdentityId(),
getContentType(),
getServerSideEncryption(),
getMetadata()
getMetadata(),
getBucket()
);
}

Expand All @@ -135,6 +138,7 @@ public String toString() {
", contentType=" + getContentType() +
", serverSideEncryption=" + getServerSideEncryption().getName() +
", metadata=" + getMetadata() +
", bucket=" + getBucket() +
'}';
}

Expand Down
Loading