PP-13646 update AWS SDK to version 2

The AWS SDK for Java 1.x is in maintenance mode, effective July 31, 2024.
The AWS SDK for Java 1.x will no longer receive updates for new or existing services.
We need to upgrade pay-ledger to use the AWS SDK version 2 for SQS operations. This will involve updating dependencies, refactoring code to accommodate changes in the SDK, and ensuring the new SDK's methods and patterns are followed.

Author: SandorArpa

pom.xml

@@ -37,9 +37,9 @@
                 <scope>import</scope>
             </dependency>
             <dependency>
-                <groupId>com.amazonaws</groupId>
-                <artifactId>aws-java-sdk-bom</artifactId>
-                <version>1.12.782</version>
+                <groupId>software.amazon.awssdk</groupId>
+                <artifactId>bom</artifactId>
+                <version>2.31.33</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
@@ -109,8 +109,12 @@
             <artifactId>jackson-dataformat-csv</artifactId>
         </dependency>
         <dependency>
-            <groupId>com.amazonaws</groupId>
-            <artifactId>aws-java-sdk-sqs</artifactId>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>sqs</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>sns</artifactId>
         </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
@@ -169,14 +173,9 @@
         </dependency>
         <dependency>
             <groupId>uk.gov.service.payments</groupId>
-            <artifactId>queue-dropwizard-4</artifactId>
+            <artifactId>queue-dropwizard-4-aws-sdk-v2</artifactId>
             <version>${pay-java-commons.version}</version>
         </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>sns</artifactId>
-            <version>2.31.30</version>
-        </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>

src/main/java/uk/gov/pay/ledger/app/LedgerModule.java

@@ -1,10 +1,5 @@
 package uk.gov.pay.ledger.app;
 
-import com.amazonaws.auth.AWSStaticCredentialsProvider;
-import com.amazonaws.auth.BasicAWSCredentials;
-import com.amazonaws.client.builder.AwsClientBuilder;
-import com.amazonaws.services.sqs.AmazonSQS;
-import com.amazonaws.services.sqs.AmazonSQSClientBuilder;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provides;
@@ -16,6 +11,8 @@
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.sns.SnsClient;
 import software.amazon.awssdk.services.sns.SnsClientBuilder;
+import software.amazon.awssdk.services.sqs.SqsClient;
+import software.amazon.awssdk.services.sqs.SqsClientBuilder;
 import uk.gov.pay.ledger.agreement.dao.AgreementDao;
 import uk.gov.pay.ledger.agreement.dao.PaymentInstrumentDao;
 import uk.gov.pay.ledger.event.dao.EventDao;
@@ -31,6 +28,7 @@
 import uk.gov.pay.ledger.transactionsummary.dao.TransactionSummaryDao;
 import uk.gov.service.payments.commons.queue.sqs.SqsQueueService;
 
+import java.net.URI;
 import java.time.InstantSource;
 
 public class LedgerModule extends AbstractModule {
@@ -144,26 +142,22 @@ public PaymentInstrumentDao providePaymentInstrumentDao() {
     }
 
     @Provides
-    public AmazonSQS sqsClient(LedgerConfig ledgerConfig) {
-        AmazonSQSClientBuilder clientBuilder = AmazonSQSClientBuilder
-                .standard();
+    public SqsClient sqsClient(LedgerConfig ledgerConfig) {
+        SqsClientBuilder clientBuilder = SqsClient.builder();
 
         if (ledgerConfig.getSqsConfig().isNonStandardServiceEndpoint()) {
 
-            BasicAWSCredentials basicAWSCredentials = new BasicAWSCredentials(
-                    ledgerConfig.getSqsConfig().getAccessKey(),
-                    ledgerConfig.getSqsConfig().getSecretKey());
+            AwsBasicCredentials basicAWSCredentials = AwsBasicCredentials
+                    .create(ledgerConfig.getSqsConfig().getAccessKey(),
+                            ledgerConfig.getSqsConfig().getSecretKey());
 
             clientBuilder
-                    .withCredentials(new AWSStaticCredentialsProvider(basicAWSCredentials))
-                    .withEndpointConfiguration(
-                            new AwsClientBuilder.EndpointConfiguration(
-                                    ledgerConfig.getSqsConfig().getEndpoint(),
-                                    ledgerConfig.getSqsConfig().getRegion())
-                    );
+                    .credentialsProvider(StaticCredentialsProvider.create(basicAWSCredentials))
+                    .endpointOverride(URI.create(ledgerConfig.getSqsConfig().getEndpoint()))
+                    .region(Region.of(ledgerConfig.getSqsConfig().getRegion()));
         } else {
             // uses AWS SDK's DefaultAWSCredentialsProviderChain to obtain credentials
-            clientBuilder.withRegion(ledgerConfig.getSqsConfig().getRegion());
+            clientBuilder.region(Region.of(ledgerConfig.getSqsConfig().getRegion()));
         }
 
         return clientBuilder.build();
@@ -192,7 +186,7 @@ public SnsClient snsClient(LedgerConfig ledgerConfig) {
     }
 
     @Provides
-    public SqsQueueService provideSqsQueueService(AmazonSQS amazonSQS, LedgerConfig ledgerConfig) {
+    public SqsQueueService provideSqsQueueService(SqsClient amazonSQS, LedgerConfig ledgerConfig) {
         return new SqsQueueService(
                 amazonSQS,
                 ledgerConfig.getSqsConfig().getMessageMaximumWaitTimeInSeconds(),

src/main/java/uk/gov/pay/ledger/healthcheck/SQSHealthCheck.java

@@ -1,29 +1,28 @@
 package uk.gov.pay.ledger.healthcheck;
 
-import com.amazonaws.SdkClientException;
-import com.amazonaws.services.sqs.AmazonSQS;
-import com.amazonaws.services.sqs.model.GetQueueAttributesRequest;
 import com.codahale.metrics.health.HealthCheck;
 import com.google.inject.Inject;
 import org.apache.http.NameValuePair;
 import org.apache.http.message.BasicNameValuePair;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.services.sqs.SqsClient;
+import software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 
-
 import java.util.Optional;
 
 import static java.lang.String.format;
 
 public class SQSHealthCheck extends HealthCheck {
 
-    private final AmazonSQS sqsClient;
+    private final SqsClient sqsClient;
     private final Logger logger = LoggerFactory.getLogger(SQSHealthCheck.class);
     private NameValuePair sqsHealthCheckHolder;
 
     @Inject
-    public SQSHealthCheck(AmazonSQS sqsClient, LedgerConfig ledgerConfig) {
+    public SQSHealthCheck(SqsClient sqsClient, LedgerConfig ledgerConfig) {
         this.sqsClient = sqsClient;
         setUpSQSHealthCheckHolder(ledgerConfig);
     }
@@ -43,8 +42,10 @@ protected Result check() {
 
     private Optional<String> checkQueue(NameValuePair nameValuePair) {
         GetQueueAttributesRequest queueAttributesRequest =
-                new GetQueueAttributesRequest(nameValuePair.getValue())
-                        .withAttributeNames("All");
+                GetQueueAttributesRequest.builder()
+                        .queueUrl(nameValuePair.getValue())
+                        .attributeNamesWithStrings("All")
+                        .build();
         try {
             sqsClient.getQueueAttributes(queueAttributesRequest);
         } catch (UnsupportedOperationException | SdkClientException e) {

src/test/java/uk/gov/pay/ledger/extension/AppWithPostgresAndSqsExtension.java

@@ -1,6 +1,5 @@
 package uk.gov.pay.ledger.extension;
 
-import com.amazonaws.services.sqs.AmazonSQS;
 import io.dropwizard.testing.ConfigOverride;
 import io.dropwizard.testing.junit5.DropwizardAppExtension;
 import org.jdbi.v3.core.Jdbi;
@@ -10,6 +9,7 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import software.amazon.awssdk.services.sqs.SqsClient;
 import uk.gov.pay.ledger.app.LedgerApp;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.rule.SqsTestDocker;
@@ -30,7 +30,7 @@ public class AppWithPostgresAndSqsExtension implements BeforeAllCallback, AfterA
 
     private static String CONFIG_PATH = resourceFilePath("config/test-config.yaml");
     private final Jdbi jdbi;
-    private AmazonSQS sqsClient;
+    private SqsClient sqsClient;
     private DropwizardAppExtension<LedgerConfig> dropwizardAppExtension;
 
     public AppWithPostgresAndSqsExtension() {
@@ -40,7 +40,7 @@ public AppWithPostgresAndSqsExtension() {
     public AppWithPostgresAndSqsExtension(ConfigOverride... configOverrides) {
         getOrCreate();
 
-        sqsClient = SqsTestDocker.initialise("event-queue");
+        sqsClient = SqsTestDocker.initialise(List.of("event-queue"));
 
         ConfigOverride[] newConfigOverrides = overrideDatabaseConfig(configOverrides);
         newConfigOverrides = overrideSqsConfig(newConfigOverrides);
@@ -94,7 +94,7 @@ public Jdbi getJdbi() {
         return jdbi;
     }
 
-    public AmazonSQS getSqsClient() {
+    public SqsClient getSqsClient() {
         return sqsClient;
     }
 }

src/test/java/uk/gov/pay/ledger/pact/event/CancelledByUserEventQueueConsumerIT.java

@@ -8,6 +8,7 @@
 import com.google.gson.Gson;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.model.SalientEventType;
 import uk.gov.pay.ledger.rule.AppWithPostgresAndSqsRule;
@@ -67,7 +68,11 @@ public MessagePact createCancelledByUserEventPact(MessagePactBuilder builder) {
     @Test
     @PactVerification({"connector"})
     public void test() {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
 
         TransactionDao transactionDao = new TransactionDao(appRule.getJdbi(), mock(LedgerConfig.class));
 

src/test/java/uk/gov/pay/ledger/pact/event/CaptureConfirmedEventQueueConsumerIT.java

@@ -9,6 +9,7 @@
 import com.google.gson.Gson;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.dao.EventDao;
 import uk.gov.pay.ledger.event.entity.EventEntity;
@@ -71,7 +72,11 @@ public MessagePact createCaptureConfirmedEventPact(MessagePactBuilder builder) {
     @Test
     @PactVerification({"connector"})
     public void test() {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
 
         TransactionDao transactionDao = new TransactionDao(appRule.getJdbi(), mock(LedgerConfig.class));
         EventDao eventDao = appRule.getJdbi().onDemand(EventDao.class);

src/test/java/uk/gov/pay/ledger/pact/event/CaptureSubmittedEventQueueConsumerIT.java

@@ -8,6 +8,7 @@
 import com.google.gson.Gson;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.model.SalientEventType;
 import uk.gov.pay.ledger.rule.AppWithPostgresAndSqsRule;
@@ -67,7 +68,11 @@ public MessagePact createPaymentCreatedEventPact(MessagePactBuilder builder) {
     @Test
     @PactVerification({"connector"})
     public void test() {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
 
         TransactionDao transactionDao = new TransactionDao(appRule.getJdbi(), mock(LedgerConfig.class));
 

src/test/java/uk/gov/pay/ledger/pact/event/DisputeCreatedEventQueueConsumerIT.java

@@ -12,6 +12,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.dao.EventDao;
 import uk.gov.pay.ledger.event.entity.EventEntity;
@@ -96,7 +97,11 @@ public void setUp() {
     @Test
     @PactVerification({"connector"})
     public void test() throws JsonProcessingException {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
         EventDao eventDao = appRule.getJdbi().onDemand(EventDao.class);
         await().atMost(1, TimeUnit.SECONDS).until(
                 () -> !eventDao.findEventsForExternalIds(Set.of(resourceExternalId)).isEmpty()

src/test/java/uk/gov/pay/ledger/pact/event/DisputeEvidenceSubmittedEventQueueConsumerIT.java

@@ -12,6 +12,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.dao.EventDao;
 import uk.gov.pay.ledger.event.entity.EventEntity;
@@ -96,7 +97,11 @@ public void setUp() {
     @Test
     @PactVerification({"connector"})
     public void test() throws JsonProcessingException {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
         EventDao eventDao = appRule.getJdbi().onDemand(EventDao.class);
         await().atMost(1, TimeUnit.SECONDS).until(
                 () -> !eventDao.findEventsForExternalIds(Set.of(resourceExternalId)).isEmpty()

src/test/java/uk/gov/pay/ledger/pact/event/DisputeLostEventQueueConsumerIT.java

@@ -11,6 +11,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
+import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
 import uk.gov.pay.ledger.app.LedgerConfig;
 import uk.gov.pay.ledger.event.dao.EventDao;
 import uk.gov.pay.ledger.event.entity.EventEntity;
@@ -96,7 +97,11 @@ public void setUp() {
     @Test
     @PactVerification({"connector"})
     public void test() throws JsonProcessingException {
-        appRule.getSqsClient().sendMessage(SqsTestDocker.getQueueUrl("event-queue"), new String(currentMessage));
+        SendMessageRequest messageRequest = SendMessageRequest.builder()
+                .queueUrl(SqsTestDocker.getQueueUrl("event-queue"))
+                .messageBody(new String(currentMessage))
+                .build();
+        appRule.getSqsClient().sendMessage(messageRequest);
         EventDao eventDao = appRule.getJdbi().onDemand(EventDao.class);
         await().atMost(1, TimeUnit.SECONDS).until(
                 () -> !eventDao.findEventsForExternalIds(Set.of(resourceExternalId)).isEmpty()