This is an automated email from the ASF dual-hosted git repository.
emaynard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new f8ad77a69 Prefer java.util.Base64 over commons-codec (#2463)
f8ad77a69 is described below
commit f8ad77a6915defdcfd4bf778f8f6123042ded31e
Author: Christopher Lambert <xn...@gmx.de>
AuthorDate: Thu Aug 28 22:13:36 2025 +0200
Prefer java.util.Base64 over commons-codec (#2463)
`java.util.Base64` is available since java8 and we are already using it
in a few other spots.
in a follow-up we might be able to get rid of our `commons-codec` dependency
completely.
---
.../service/auth/DefaultOAuth2ApiService.java | 5 ++-
.../task/ManifestFileCleanupTaskHandler.java | 19 ++++-----
.../service/task/TableCleanupTaskHandler.java | 4 +-
.../org/apache/polaris/service/task/TaskUtils.java | 16 +++++++-
.../task/ManifestFileCleanupTaskHandlerTest.java | 18 ++++-----
.../service/task/TableCleanupTaskHandlerTest.java | 47 +++++++++-------------
6 files changed, 52 insertions(+), 57 deletions(-)
diff --git
a/runtime/service/src/main/java/org/apache/polaris/service/auth/DefaultOAuth2ApiService.java
b/runtime/service/src/main/java/org/apache/polaris/service/auth/DefaultOAuth2ApiService.java
index 22aa301a3..66e8d056a 100644
---
a/runtime/service/src/main/java/org/apache/polaris/service/auth/DefaultOAuth2ApiService.java
+++
b/runtime/service/src/main/java/org/apache/polaris/service/auth/DefaultOAuth2ApiService.java
@@ -25,7 +25,7 @@ import jakarta.enterprise.context.RequestScoped;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.SecurityContext;
-import org.apache.commons.codec.binary.Base64;
+import java.util.Base64;
import org.apache.iceberg.rest.responses.OAuthTokenResponse;
import org.apache.polaris.core.context.CallContext;
import org.apache.polaris.core.context.RealmContext;
@@ -83,7 +83,8 @@ public class DefaultOAuth2ApiService implements
IcebergRestOAuth2ApiService {
// has previously attempted to refresh an access token, but refreshing was
not supported by the
// token broker. Accept the client id and secret and treat it as a new
token request
if (authHeader != null && clientSecret == null &&
authHeader.startsWith("Basic ")) {
- String credentials = new
String(Base64.decodeBase64(authHeader.substring(6)), UTF_8);
+ String credentials =
+ new
String(Base64.getDecoder().decode(authHeader.substring(6).getBytes(UTF_8)),
UTF_8);
if (!credentials.contains(":")) {
return
OAuthUtils.getResponseFromError(OAuthTokenErrorResponse.Error.invalid_request);
}
diff --git
a/runtime/service/src/main/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandler.java
b/runtime/service/src/main/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandler.java
index 59e9be8dd..f71adc2bc 100644
---
a/runtime/service/src/main/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandler.java
+++
b/runtime/service/src/main/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandler.java
@@ -18,7 +18,6 @@
*/
package org.apache.polaris.service.task;
-import java.io.IOException;
import java.util.List;
import java.util.Spliterator;
import java.util.Spliterators;
@@ -26,7 +25,6 @@ import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.stream.StreamSupport;
-import org.apache.commons.codec.binary.Base64;
import org.apache.iceberg.DataFile;
import org.apache.iceberg.ManifestFile;
import org.apache.iceberg.ManifestFiles;
@@ -64,7 +62,7 @@ public class ManifestFileCleanupTaskHandler extends
FileCleanupTaskHandler {
ManifestCleanupTask cleanupTask = task.readData(ManifestCleanupTask.class);
TableIdentifier tableId = cleanupTask.tableId();
try (FileIO authorizedFileIO = fileIOSupplier.apply(task, tableId,
callContext)) {
- ManifestFile manifestFile =
decodeManifestData(cleanupTask.manifestFileData());
+ ManifestFile manifestFile =
TaskUtils.decodeManifestFileData(cleanupTask.manifestFileData());
return cleanUpManifestFile(manifestFile, authorizedFileIO, tableId);
}
}
@@ -117,15 +115,12 @@ public class ManifestFileCleanupTaskHandler extends
FileCleanupTaskHandler {
}
}
- private static ManifestFile decodeManifestData(String manifestFileData) {
- try {
- return ManifestFiles.decode(Base64.decodeBase64(manifestFileData));
- } catch (IOException e) {
- throw new RuntimeException("Unable to decode base64 encoded manifest",
e);
+ /** Serialized Task data sent from the {@link TableCleanupTaskHandler} */
+ public record ManifestCleanupTask(TableIdentifier tableId, String
manifestFileData) {
+
+ static ManifestCleanupTask buildFrom(TableIdentifier tableId, ManifestFile
manifestFile) {
+ String encodedManifestFileData =
TaskUtils.encodeManifestFile(manifestFile);
+ return new ManifestCleanupTask(tableId, encodedManifestFileData);
}
}
-
- /** Serialized Task data sent from the {@link TableCleanupTaskHandler} */
- public record ManifestCleanupTask(TableIdentifier tableId, String
manifestFileData) {}
- ;
}
diff --git
a/runtime/service/src/main/java/org/apache/polaris/service/task/TableCleanupTaskHandler.java
b/runtime/service/src/main/java/org/apache/polaris/service/task/TableCleanupTaskHandler.java
index db8b335ba..777d9bc8d 100644
---
a/runtime/service/src/main/java/org/apache/polaris/service/task/TableCleanupTaskHandler.java
+++
b/runtime/service/src/main/java/org/apache/polaris/service/task/TableCleanupTaskHandler.java
@@ -193,8 +193,8 @@ public class TableCleanupTaskHandler implements TaskHandler
{
.setCreateTimestamp(clock.millis())
.withTaskType(AsyncTaskType.MANIFEST_FILE_CLEANUP)
.withData(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableEntity.getTableIdentifier(),
TaskUtils.encodeManifestFile(mf)))
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableEntity.getTableIdentifier(), mf))
.setId(metaStoreManager.generateNewEntityId(polarisCallContext).getId())
// copy the internal properties, which will have storage info
.setInternalProperties(cleanupTask.getInternalPropertiesAsMap())
diff --git
a/runtime/service/src/main/java/org/apache/polaris/service/task/TaskUtils.java
b/runtime/service/src/main/java/org/apache/polaris/service/task/TaskUtils.java
index 3dec2ef2a..a061b85ec 100644
---
a/runtime/service/src/main/java/org/apache/polaris/service/task/TaskUtils.java
+++
b/runtime/service/src/main/java/org/apache/polaris/service/task/TaskUtils.java
@@ -19,7 +19,8 @@
package org.apache.polaris.service.task;
import java.io.IOException;
-import org.apache.commons.codec.binary.Base64;
+import java.nio.charset.StandardCharsets;
+import java.util.Base64;
import org.apache.iceberg.ManifestFile;
import org.apache.iceberg.ManifestFiles;
import org.apache.iceberg.exceptions.NotFoundException;
@@ -46,9 +47,20 @@ public class TaskUtils {
*/
public static String encodeManifestFile(ManifestFile mf) {
try {
- return Base64.encodeBase64String(ManifestFiles.encode(mf));
+ byte[] encodedBytes = ManifestFiles.encode(mf);
+ return new String(Base64.getEncoder().encode(encodedBytes),
StandardCharsets.UTF_8);
} catch (IOException e) {
throw new RuntimeException("Unable to encode binary data in memory", e);
}
}
+
+ public static ManifestFile decodeManifestFileData(String manifestFileData) {
+ try {
+ byte[] decodedBytes =
+
Base64.getDecoder().decode(manifestFileData.getBytes(StandardCharsets.UTF_8));
+ return ManifestFiles.decode(decodedBytes);
+ } catch (IOException e) {
+ throw new RuntimeException("Unable to decode base64 encoded manifest",
e);
+ }
+ }
}
diff --git
a/runtime/service/src/test/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandlerTest.java
b/runtime/service/src/test/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandlerTest.java
index 53afeecfa..828991798 100644
---
a/runtime/service/src/test/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandlerTest.java
+++
b/runtime/service/src/test/java/org/apache/polaris/service/task/ManifestFileCleanupTaskHandlerTest.java
@@ -31,9 +31,7 @@ import java.util.Map;
import java.util.UUID;
import java.util.concurrent.Executors;
import java.util.concurrent.atomic.AtomicInteger;
-import org.apache.commons.codec.binary.Base64;
import org.apache.iceberg.ManifestFile;
-import org.apache.iceberg.ManifestFiles;
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.inmemory.InMemoryFileIO;
@@ -83,8 +81,8 @@ class ManifestFileCleanupTaskHandlerTest {
new TaskEntity.Builder()
.withTaskType(AsyncTaskType.MANIFEST_FILE_CLEANUP)
.withData(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))))
+ ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile))
.setName(UUID.randomUUID().toString())
.build();
task = addTaskLocation(task);
@@ -107,8 +105,8 @@ class ManifestFileCleanupTaskHandlerTest {
new TaskEntity.Builder()
.withTaskType(AsyncTaskType.MANIFEST_FILE_CLEANUP)
.withData(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))))
+ ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile))
.setName(UUID.randomUUID().toString())
.build();
task = addTaskLocation(task);
@@ -146,8 +144,8 @@ class ManifestFileCleanupTaskHandlerTest {
new TaskEntity.Builder()
.withTaskType(AsyncTaskType.MANIFEST_FILE_CLEANUP)
.withData(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))))
+ ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile))
.setName(UUID.randomUUID().toString())
.build();
task = addTaskLocation(task);
@@ -201,8 +199,8 @@ class ManifestFileCleanupTaskHandlerTest {
new TaskEntity.Builder()
.withTaskType(AsyncTaskType.MANIFEST_FILE_CLEANUP)
.withData(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))))
+ ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile))
.setName(UUID.randomUUID().toString())
.build();
task = addTaskLocation(task);
diff --git
a/runtime/service/src/test/java/org/apache/polaris/service/task/TableCleanupTaskHandlerTest.java
b/runtime/service/src/test/java/org/apache/polaris/service/task/TableCleanupTaskHandlerTest.java
index 3663c8a22..daedcb534 100644
---
a/runtime/service/src/test/java/org/apache/polaris/service/task/TableCleanupTaskHandlerTest.java
+++
b/runtime/service/src/test/java/org/apache/polaris/service/task/TableCleanupTaskHandlerTest.java
@@ -28,9 +28,7 @@ import java.io.IOException;
import java.time.Clock;
import java.util.List;
import java.util.UUID;
-import org.apache.commons.codec.binary.Base64;
import org.apache.iceberg.ManifestFile;
-import org.apache.iceberg.ManifestFiles;
import org.apache.iceberg.PartitionStatisticsFile;
import org.apache.iceberg.Snapshot;
import org.apache.iceberg.StatisticsFile;
@@ -136,9 +134,8 @@ class TableCleanupTaskHandlerTest {
.extracting(TaskEntity::of)
.returns(AsyncTaskType.MANIFEST_FILE_CLEANUP,
TaskEntity::getTaskType)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -290,9 +287,8 @@ class TableCleanupTaskHandlerTest {
.extracting(TaskEntity::of)
.returns(AsyncTaskType.MANIFEST_FILE_CLEANUP,
TaskEntity::getTaskType)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -302,9 +298,8 @@ class TableCleanupTaskHandlerTest {
.extracting(TaskEntity::of)
.returns(AsyncTaskType.MANIFEST_FILE_CLEANUP,
TaskEntity::getTaskType)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)));
@@ -421,9 +416,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile1))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile1),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -432,9 +426,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile2))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile2),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -443,9 +436,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile3))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile3),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)));
@@ -592,9 +584,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile1))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile1),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -603,9 +594,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile2))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile2),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)),
@@ -614,9 +604,8 @@ class TableCleanupTaskHandlerTest {
.returns(PolarisEntityType.TASK.getCode(),
PolarisBaseEntity::getTypeCode)
.extracting(TaskEntity::of)
.returns(
- new ManifestFileCleanupTaskHandler.ManifestCleanupTask(
- tableIdentifier,
-
Base64.encodeBase64String(ManifestFiles.encode(manifestFile3))),
+
ManifestFileCleanupTaskHandler.ManifestCleanupTask.buildFrom(
+ tableIdentifier, manifestFile3),
entity ->
entity.readData(
ManifestFileCleanupTaskHandler.ManifestCleanupTask.class)));
