-
Notifications
You must be signed in to change notification settings - Fork 55
feat: project setup and upload file #1712
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
base: s3-tm-main
Are you sure you want to change the base?
Conversation
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice start
...mmon/src/aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetricsUtils.kt
Show resolved
Hide resolved
hll/s3-transfer-manager/jvm/test/aws/sdk/kotlin/hll/s3transfermanager/UploadFileTest.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/utils/UploadFile.kt
Outdated
Show resolved
Hide resolved
...ransfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/BusinessMetricInterceptor.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
...-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/model/UploadFileRequest.kt
Outdated
Show resolved
Hide resolved
...-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/model/UploadFileRequest.kt
Outdated
Show resolved
Hide resolved
...-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/model/UploadFileRequest.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/utils/UploadFile.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/utils/UploadFile.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/TransferInterceptor.kt
Show resolved
Hide resolved
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view. |
|
A new generated diff is ready to view. |
|
A new generated diff is ready to view. |
|
A new generated diff is ready to view. |
...n/kotlin/aws/sdk/kotlin/hll/dynamodbmapper/codegen/operations/rendering/OperationRenderer.kt
Outdated
Show resolved
Hide resolved
...odegen/src/main/kotlin/aws/sdk/kotlin/hll/s3transfermanager/codegen/mappings/MappingTypes.kt
Outdated
Show resolved
Hide resolved
hll/s3-transfer-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/S3TransferManager.kt
Show resolved
Hide resolved
...-manager/common/src/aws/sdk/kotlin/hll/s3transfermanager/operations/uploadfile/UploadFile.kt
Show resolved
Hide resolved
| val targetNumberOfParts = contentLength / targetPartSize | ||
| return if (targetNumberOfParts > MAX_NUMBER_PARTS) { | ||
| ceilDiv(contentLength, MAX_NUMBER_PARTS).also { | ||
| logger.warn { "Target part size is too small to meet the $MAX_NUMBER_PARTS S3 part limit. Increasing part size to $it" } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did we clarify with the spec author what level this should be logged at?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me ask
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's nothing in the spec mentioning logging a message when the configured part size isn't used btw.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The spec author uses DEBUG
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I like INFO level for this. The KDocs already indicate that the value is a target not a guarantee.
That said, I think we should make the message more descriptive. Ideally we'd say something like:
The target part size of
<configured-value>bytes is too small upload<object-name>in<max-num-parts>parts (the maximum allowed by S3). The object will be uploaded in parts of<calculated-part-size>bytes instead.
...mon/src/aws/sdk/kotlin/hll/s3transfermanager/operations/uploadfile/hooks/InitiateTransfer.kt
Outdated
Show resolved
Hide resolved
...ger/common/test/aws/sdk/kotlin/hll/s3transfermanager/operations/uploadfile/UploadFileTest.kt
Show resolved
Hide resolved
|
A new generated diff is ready to view. |
| if ("s3".isBootstrappedService) { | ||
| include(":hll:s3-transfer-manager") | ||
| include(":hll:s3-transfer-manager-codegen") | ||
| } else { | ||
| logger.warn(":services:s3 is not bootstrapped, skipping :hll:s3-transfer-manager and subprojects") | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment: Excellent!
| smithy-kotlin-http-test-jvm = { module = "aws.smithy.kotlin:http-test-jvm", version.ref = "smithy-kotlin-runtime-version" } | ||
| smithy-kotlin-testing-jvm = { module = "aws.smithy.kotlin:testing-jvm", version.ref = "smithy-kotlin-runtime-version" } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: Why are we explicitly depending on JVM target packages? Generally we rely on the common KMP packages (e.g., http-test, testing) because Gradle's Kotlin plugin is supposed to handle target resolution.
|
|
||
| "s3-transfer-manager-codegen", // TODO: Disable publishing ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment: 👍 Yes, this is in the right place. We don't want to publish this since we have no use case for it right now. We can scratch the TODO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't disable publication right? Just API validation and docgen
|
|
||
| java { | ||
| sourceCompatibility = JavaVersion.VERSION_1_8 | ||
| targetCompatibility = JavaVersion.VERSION_1_8 | ||
| } | ||
|
|
||
| tasks.withType<KotlinCompile> { | ||
| compilerOptions { | ||
| jvmTarget.set(JvmTarget.JVM_1_8) | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: Why are these additions necessary?
| val mpuUploadId = initiateTransfer( | ||
| multipartUpload, | ||
| transferContext, | ||
| contentLength, | ||
| uploadFileRequest, | ||
| interceptors, | ||
| client, | ||
| ) | ||
|
|
||
| val uploadedParts = transferBytes( | ||
| multipartUpload, | ||
| contentLength, | ||
| partSizeBytes, | ||
| logger, | ||
| uploadFileRequest, | ||
| transferContext, | ||
| mpuUploadId, | ||
| interceptors, | ||
| client, | ||
| maxInMemoryParts, | ||
| maxConcurrentPartUploads, | ||
| ) | ||
|
|
||
| completeTransfer( | ||
| multipartUpload, | ||
| transferContext, | ||
| uploadFileRequest, | ||
| mpuUploadId, | ||
| uploadedParts, | ||
| interceptors, | ||
| client, | ||
| ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style: The volume of arguments passed into these functions is too great. Can any of these be grouped into objects, derived from other parameters, etc.? This level of data coupling is an indicator that we might be better served modelling a base operation type which can be implemented for each operation type (e.g., UploadFile) or for each subtype (e.g., UploadFileSingle and UploadFileMultipart), which would reduce the amount of if (multipartUpload) calls.
| "tagging", | ||
| "websiteRedirectLocation", | ||
| ), | ||
| additionalLogic = "contentLength = [email protected]?.contentLength", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: ByteStream's contentLength is nullable because it's not always possible to derive the length of a byte stream automatically. That's why S3's PutObjectRequest has a separate contentLength field users can populate with knowledge the SDK doesn't necessarily have. I think we need contentLength to be user-configurable and to prefer that value when it's set (otherwise, falling back to body?.contentLength).
| /** | ||
| * Represents a part in a multipart upload. | ||
| * | ||
| * @param number The part number. | ||
| * @param bytes The bytes of the part. | ||
| */ | ||
| internal data class Part( | ||
| val number: Int, | ||
| val bytes: SdkBuffer, | ||
| ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Could be private.
| ) = produce( | ||
| capacity = maxInMemoryParts, | ||
| ) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correctness: Isn't maxInMemoryParts supposed to limit the parts for the entire S3TM? This looks like it applies to individual objects but we'll be parallelizing multi-object transfers.
| } catch (uploadPartException: Exception) { | ||
| try { | ||
| client.abortMultipartUpload { | ||
| bucket = uploadFileRequest.bucket | ||
| expectedBucketOwner = uploadFileRequest.expectedBucketOwner | ||
| key = uploadFileRequest.key | ||
| requestPayer = uploadFileRequest.requestPayer | ||
| uploadId = mpuUploadId | ||
| } | ||
| throw S3TransferManagerException("Multipart upload failed (ID: $mpuUploadId). One or more parts could not be uploaded", uploadPartException) | ||
| } catch (abortException: Exception) { | ||
| throw S3TransferManagerException("Multipart upload failed (ID: $mpuUploadId). Unable to abort multipart upload.", abortException) | ||
| .also { it.addSuppressed(uploadPartException) } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: This should probably log a WARN before aborting the multipart upload.
|
|
||
| "s3-transfer-manager-codegen", // TODO: Disable publishing ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't disable publication right? Just API validation and docgen
| internal val uploadFileConversions = listOf( | ||
| ConversionMapping( | ||
| source = TypeRef( | ||
| "aws.sdk.kotlin.services.s3.model", | ||
| "PutObjectResponse", | ||
| ), | ||
| destination = TypeRef( | ||
| "aws.sdk.kotlin.hll.s3transfermanager.model", | ||
| "UploadFileResponse", | ||
| ), | ||
| setOf( | ||
| "bucketKeyEnabled", | ||
| "checksumCrc32", | ||
| "checksumCrc32C", | ||
| "checksumCrc64Nvme", | ||
| "checksumSha1", | ||
| "checksumSha256", | ||
| "checksumType", | ||
| "eTag", | ||
| "expiration", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think a data string will make this any more readable / maintainable? The internal spec already has this modeled as a JSON list, we can make changes (which I believe are unlikely) by inspecting the diff of that file
| commonTest { | ||
| dependencies { | ||
| implementation(libs.smithy.kotlin.http.test.jvm) | ||
| implementation(libs.smithy.kotlin.testing.jvm) | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ian already commented on this, but JVM-only dependencies in commonTest won't work
| /** | ||
| * Preferred part size for multipart uploads. | ||
| * If using this size would require more than 10,000 parts (the S3 limit), | ||
| * the smallest possible part size that results in 10,000 parts is used instead. | ||
| * | ||
| * Default to 8,000,000 bytes. | ||
| */ | ||
| public val partSizeBytes: Long = builder.partSizeBytes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is my fault since I left a comment asking to change it to just partSize to simplify the name. We are logging a warning when deviating from the configured part size. It's not a strong opinion so I will let @0marperez make the decision
Issue #
N/A
Description of changes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.