Skip to content

Update tm builder log messages #3822

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

Merged
merged 4 commits into from
Mar 22, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@
<sqllite.version>1.0.392</sqllite.version>
<blockhound.version>1.0.6.RELEASE</blockhound.version>
<jetty.version>9.4.45.v20220203</jetty.version>
<logcaptor.version>2.8.0</logcaptor.version>

<!-- build plugin dependencies-->
<maven.surefire.version>3.0.0-M5</maven.surefire.version>
Expand Down
11 changes: 11 additions & 0 deletions services-custom/s3-transfer-manager/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,17 @@
<version>${commons-codec.verion}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.github.hakky54</groupId>
<artifactId>logcaptor</artifactId>
<version>${logcaptor.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.6</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Is version needed? Can't it inherit from parent pom?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

logcaptor plugin needs 2.x.x version, while parent uses 1.7.30. Upgrading to 2.x.x causes breaking changes

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, I see, then we can't use it unfortunately, because it will break customers. We could potentially making it a test dependency, but this could be error-prone since we could get confused and just remove the test scope in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

got it, removed plugin and dependencies

</dependency>
</dependencies>

<build>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,15 @@ public DefaultS3TransferManager(DefaultBuilder tmBuilder) {

if (s3AsyncClient instanceof S3CrtAsyncClient) {
s3ClientType = S3ClientType.CRT_BASED;
} else {
} else if (s3AsyncClient.getClass().getName().equals("software.amazon.awssdk.services.s3.DefaultS3AsyncClient")) {
s3ClientType = S3ClientType.JAVA_BASED;
log.warn(() -> "The provided S3AsyncClient is not an instance of S3CrtAsyncClient, and thus multipart"
log.warn(() -> "The provided DefaultS3AsyncClient is not an instance of S3CrtAsyncClient, and thus multipart"
+ " upload/download feature is not enabled and resumable file upload is not supported. To benefit "
+ "from maximum throughput,"
+ " consider using S3AsyncClient.crtBuilder().build() instead.");
+ "from maximum throughput, consider using S3AsyncClient.crtBuilder().build() instead.");
} else {
s3ClientType = S3ClientType.OTHER;
log.debug(() -> "The provided S3AsyncClient is not an instance of S3CrtAsyncClient, and thus multipart"
+ " upload/download feature may not be enabled and resumable file upload may not be supported.");
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,6 @@
@SdkInternalApi
public enum S3ClientType {
CRT_BASED,
JAVA_BASED
JAVA_BASED,
OTHER
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.transfer.s3.internal;

import nl.altindag.log.LogCaptor;
import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import software.amazon.awssdk.services.s3.S3AsyncClient;
import software.amazon.awssdk.transfer.s3.S3TransferManager;

public class TransferManagerLoggingTest {

LogCaptor logCaptor;

@BeforeEach
void initLogCaptor() {
logCaptor = LogCaptor.forClass(S3TransferManager.class);
}

@Test
public void transferManager_withCrtClient_shouldNotLogMessages(){

S3AsyncClient s3Crt = S3AsyncClient.crtCreate();
S3TransferManager tm = S3TransferManager.builder().s3Client(s3Crt).build();

assertThat(logCaptor.getDebugLogs()).isEmpty();
assertThat(logCaptor.getWarnLogs()).isEmpty();
}

@Test
public void transferManager_withJavaClient_shouldLogWarnMessage(){

S3AsyncClient s3Java = S3AsyncClient.create();
S3TransferManager tm = S3TransferManager.builder().s3Client(s3Java).build();

assertThat(logCaptor.getDebugLogs()).isEmpty();
assertThat(logCaptor.getWarnLogs()).containsExactly("The provided DefaultS3AsyncClient is not an instance of "
+ "S3CrtAsyncClient, and thus multipart upload/download feature is "
+ "not enabled and resumable file upload is not supported. To benefit"
+ " from maximum throughput, consider using "
+ "S3AsyncClient.crtBuilder().build() instead.");


}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
import static org.mockito.Mockito.mock;

import java.util.List;
import org.apache.logging.log4j.Level;
import nl.altindag.log.LogCaptor;
import org.apache.logging.log4j.core.LogEvent;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import software.amazon.awssdk.testutils.LogCaptor;
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice, I didn't know we have LogCaptor, can we use it instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep, using LogCaptor from testutils instead


import software.amazon.awssdk.transfer.s3.model.CompletedObjectTransfer;
import software.amazon.awssdk.transfer.s3.model.TransferObjectRequest;
import software.amazon.awssdk.transfer.s3.internal.progress.DefaultTransferProgress;
Expand Down Expand Up @@ -54,52 +54,48 @@ public void setUp() throws Exception {

@Test
public void test_defaultListener_successfulTransfer() {
try (LogCaptor logCaptor = LogCaptor.create()) {
invokeSuccessfulLifecycle();
List<LogEvent> events = logCaptor.loggedEvents();
assertLogged(events, Level.INFO, "Transfer initiated...");
assertLogged(events, Level.INFO, "| | 0.0%");
assertLogged(events, Level.INFO, "|= | 5.0%");
assertLogged(events, Level.INFO, "|== | 10.0%");
assertLogged(events, Level.INFO, "|=== | 15.0%");
assertLogged(events, Level.INFO, "|==== | 20.0%");
assertLogged(events, Level.INFO, "|===== | 25.0%");
assertLogged(events, Level.INFO, "|====== | 30.0%");
assertLogged(events, Level.INFO, "|======= | 35.0%");
assertLogged(events, Level.INFO, "|======== | 40.0%");
assertLogged(events, Level.INFO, "|========= | 45.0%");
assertLogged(events, Level.INFO, "|========== | 50.0%");
assertLogged(events, Level.INFO, "|=========== | 55.0%");
assertLogged(events, Level.INFO, "|============ | 60.0%");
assertLogged(events, Level.INFO, "|============= | 65.0%");
assertLogged(events, Level.INFO, "|============== | 70.0%");
assertLogged(events, Level.INFO, "|=============== | 75.0%");
assertLogged(events, Level.INFO, "|================ | 80.0%");
assertLogged(events, Level.INFO, "|================= | 85.0%");
assertLogged(events, Level.INFO, "|================== | 90.0%");
assertLogged(events, Level.INFO, "|=================== | 95.0%");
assertLogged(events, Level.INFO, "|====================| 100.0%");
assertLogged(events, Level.INFO, "Transfer complete!");
assertThat(events).isEmpty();
}
LogCaptor logCaptor = LogCaptor.forClass(LoggingTransferListener.class);
invokeSuccessfulLifecycle();
List<String> infoLogs = logCaptor.getInfoLogs();
assertThat(infoLogs).contains("Transfer initiated...");
assertThat(infoLogs).contains("| | 0.0%");
assertThat(infoLogs).contains("|= | 5.0%");
assertThat(infoLogs).contains("|== | 10.0%");
assertThat(infoLogs).contains("|=== | 15.0%");
assertThat(infoLogs).contains("|==== | 20.0%");
assertThat(infoLogs).contains("|===== | 25.0%");
assertThat(infoLogs).contains("|====== | 30.0%");
assertThat(infoLogs).contains("|======= | 35.0%");
assertThat(infoLogs).contains("|======== | 40.0%");
assertThat(infoLogs).contains("|========= | 45.0%");
assertThat(infoLogs).contains("|========== | 50.0%");
assertThat(infoLogs).contains("|=========== | 55.0%");
assertThat(infoLogs).contains("|============ | 60.0%");
assertThat(infoLogs).contains("|============= | 65.0%");
assertThat(infoLogs).contains("|============== | 70.0%");
assertThat(infoLogs).contains("|=============== | 75.0%");
assertThat(infoLogs).contains("|================ | 80.0%");
assertThat(infoLogs).contains("|================= | 85.0%");
assertThat(infoLogs).contains("|================== | 90.0%");
assertThat(infoLogs).contains("|=================== | 95.0%");
assertThat(infoLogs).contains("|====================| 100.0%");
assertThat(infoLogs).contains("Transfer complete!");
}

@Test
public void test_customTicksListener_successfulTransfer() {
try (LogCaptor logCaptor = LogCaptor.create()) {
listener = LoggingTransferListener.create(5);
invokeSuccessfulLifecycle();
List<LogEvent> events = logCaptor.loggedEvents();
assertLogged(events, Level.INFO, "Transfer initiated...");
assertLogged(events, Level.INFO, "| | 0.0%");
assertLogged(events, Level.INFO, "|= | 20.0%");
assertLogged(events, Level.INFO, "|== | 40.0%");
assertLogged(events, Level.INFO, "|=== | 60.0%");
assertLogged(events, Level.INFO, "|==== | 80.0%");
assertLogged(events, Level.INFO, "|=====| 100.0%");
assertLogged(events, Level.INFO, "Transfer complete!");
assertThat(events).isEmpty();
}
LogCaptor logCaptor = LogCaptor.forClass(LoggingTransferListener.class);
listener = LoggingTransferListener.create(5);
invokeSuccessfulLifecycle();
List<String> infoLogs = logCaptor.getInfoLogs();
assertThat(infoLogs).contains("Transfer initiated...");
assertThat(infoLogs).contains("| | 0.0%");
assertThat(infoLogs).contains("|= | 20.0%");
assertThat(infoLogs).contains("|== | 40.0%");
assertThat(infoLogs).contains("|=== | 60.0%");
assertThat(infoLogs).contains("|==== | 80.0%");
assertThat(infoLogs).contains("|=====| 100.0%");
assertThat(infoLogs).contains("Transfer complete!");
}

private void invokeSuccessfulLifecycle() {
Expand Down