Skip to content

Core: Add storage credentials to FetchPlanningResultResponse #14994

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

Merged
nastra merged 1 commit into from
Jan 9, 2026
Merged

Core: Add storage credentials to FetchPlanningResultResponse #14994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions core/src/main/java/org/apache/iceberg/rest/responses/FetchPlanningResultResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,36 @@
import org.apache.iceberg.FileScanTask;
import org.apache.iceberg.PartitionSpec;
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList;
import org.apache.iceberg.relocated.com.google.common.collect.Lists;
import org.apache.iceberg.rest.PlanStatus;
import org.apache.iceberg.rest.credentials.Credential;

public class FetchPlanningResultResponse extends BaseScanTaskResponse {
private final PlanStatus planStatus;
private final List<Credential> credentials;

private FetchPlanningResultResponse(
PlanStatus planStatus,
List<String> planTasks,
List<FileScanTask> fileScanTasks,
List<DeleteFile> deleteFiles,
Map<Integer, PartitionSpec> specsById) {
Map<Integer, PartitionSpec> specsById,
List<Credential> credentials) {
super(planTasks, fileScanTasks, deleteFiles, specsById);
this.planStatus = planStatus;
this.credentials = credentials;
validate();
}

public PlanStatus planStatus() {
return planStatus;
}

public List<Credential> credentials() {
return credentials != null ? credentials : ImmutableList.of();
}

public static Builder builder() {
return new Builder();
}
Expand All @@ -66,16 +76,22 @@ public static class Builder
private Builder() {}

private PlanStatus planStatus;
private final List<Credential> credentials = Lists.newArrayList();

public Builder withPlanStatus(PlanStatus status) {
this.planStatus = status;
return this;
}

public Builder withCredentials(List<Credential> credentialsToAdd) {
credentials.addAll(credentialsToAdd);

@huaxingao huaxingao Jan 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: should we guard credentialsToAdd against null (or require non-null) to avoid an NPE on addAll?

@nastra nastra Jan 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll follow up in a separate PR on this, since we have a few places that we would want to adjust in that case

return this;
}

@Override
public FetchPlanningResultResponse build() {
return new FetchPlanningResultResponse(
planStatus, planTasks(), fileScanTasks(), deleteFiles(), specsById());
planStatus, planTasks(), fileScanTasks(), deleteFiles(), specsById(), credentials);
}
}
}
31 changes: 25 additions & 6 deletions core/src/main/java/org/apache/iceberg/rest/responses/FetchPlanningResultResponseParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.rest.PlanStatus;
import org.apache.iceberg.rest.TableScanResponseParser;
import org.apache.iceberg.rest.credentials.Credential;
import org.apache.iceberg.rest.credentials.CredentialParser;
import org.apache.iceberg.util.JsonUtil;

public class FetchPlanningResultResponseParser {
private static final String STATUS = "status";
private static final String PLAN_TASKS = "plan-tasks";
private static final String STORAGE_CREDENTIALS = "storage-credentials";

private FetchPlanningResultResponseParser() {}

Expand All @@ -59,6 +62,15 @@ public static void toJson(FetchPlanningResultResponse response, JsonGenerator ge
JsonUtil.writeStringArray(PLAN_TASKS, response.planTasks(), gen);
}

if (!response.credentials().isEmpty()) {
gen.writeArrayFieldStart(STORAGE_CREDENTIALS);
for (Credential credential : response.credentials()) {
CredentialParser.toJson(credential, gen);
}

gen.writeEndArray();
}

TableScanResponseParser.serializeScanTasks(
response.fileScanTasks(), response.deleteFiles(), response.specsById(), gen);
gen.writeEndObject();
Expand All @@ -82,11 +94,18 @@ public static FetchPlanningResultResponse fromJson(
List<DeleteFile> deleteFiles = TableScanResponseParser.parseDeleteFiles(json, specsById);
List<FileScanTask> fileScanTasks =
TableScanResponseParser.parseFileScanTasks(json, deleteFiles, specsById, caseSensitive);
return FetchPlanningResultResponse.builder()
.withPlanStatus(planStatus)
.withPlanTasks(planTasks)
.withFileScanTasks(fileScanTasks)
.withSpecsById(specsById)
.build();

FetchPlanningResultResponse.Builder builder =
FetchPlanningResultResponse.builder()
.withPlanStatus(planStatus)
.withPlanTasks(planTasks)
.withFileScanTasks(fileScanTasks)
.withSpecsById(specsById);

if (json.hasNonNull(STORAGE_CREDENTIALS)) {
builder.withCredentials(LoadCredentialsResponseParser.fromJson(json).credentials());
}

return builder.build();
}
}
107 changes: 106 additions & 1 deletion ...rc/test/java/org/apache/iceberg/rest/responses/TestFetchPlanningResultResponseParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,12 @@
import org.apache.iceberg.SchemaParser;
import org.apache.iceberg.expressions.Expressions;
import org.apache.iceberg.expressions.ResidualEvaluator;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.rest.PlanStatus;
import org.apache.iceberg.rest.RESTSerializers;
import org.apache.iceberg.rest.credentials.Credential;
import org.apache.iceberg.rest.credentials.ImmutableCredential;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

Expand Down Expand Up @@ -140,7 +144,6 @@ public void roundTripSerdeWithInvalidPlanStatusSubmittedWithTasksPresent() {

@Test
public void roundTripSerdeWithInvalidPlanStatusSubmittedWithDeleteFilesNoFileScanTasksPresent() {

PlanStatus planStatus = PlanStatus.fromName("submitted");
assertThatThrownBy(
() -> {
Expand Down Expand Up @@ -225,4 +228,106 @@ public void roundTripSerdeWithValidStatusAndFileScanTasks() throws JsonProcessin
assertThat(FetchPlanningResultResponseParser.toJson(copyResponse, false))
.isEqualTo(expectedToJson);
}

@Test
public void emptyOrInvalidCredentials() {
assertThat(
FetchPlanningResultResponseParser.fromJson(
"{\"status\": \"completed\",\"storage-credentials\": null}",
PARTITION_SPECS_BY_ID,
false)
.credentials())
.isEmpty();

assertThat(
FetchPlanningResultResponseParser.fromJson(
"{\"status\": \"completed\",\"storage-credentials\": []}",
PARTITION_SPECS_BY_ID,
false)
.credentials())
.isEmpty();

assertThatThrownBy(
() ->
FetchPlanningResultResponseParser.fromJson(
"{\"status\": \"completed\",\"storage-credentials\": \"invalid\"}",
PARTITION_SPECS_BY_ID,
false))
.isInstanceOf(IllegalArgumentException.class)
.hasMessage("Cannot parse credentials from non-array: \"invalid\"");
}

@Test
public void roundTripSerdeWithCredentials() {
List<Credential> credentials =
ImmutableList.of(
ImmutableCredential.builder()
.prefix("s3://custom-uri")
.config(
ImmutableMap.of(
"s3.access-key-id",
"keyId",
"s3.secret-access-key",
"accessKey",
"s3.session-token",
"sessionToken"))
.build(),
ImmutableCredential.builder()
.prefix("gs://custom-uri")
.config(
ImmutableMap.of(
"gcs.oauth2.token", "gcsToken1", "gcs.oauth2.token-expires-at", "1000"))
.build(),
ImmutableCredential.builder()
.prefix("gs")
.config(
ImmutableMap.of(
"gcs.oauth2.token", "gcsToken2", "gcs.oauth2.token-expires-at", "2000"))
.build());

FetchPlanningResultResponse response =
FetchPlanningResultResponse.builder()
.withPlanStatus(PlanStatus.COMPLETED)
.withCredentials(credentials)
.build();

String expectedJson =
"{\n"
+ " \"status\" : \"completed\",\n"
+ " \"storage-credentials\" : [ {\n"
+ " \"prefix\" : \"s3://custom-uri\",\n"
+ " \"config\" : {\n"
+ " \"s3.access-key-id\" : \"keyId\",\n"
+ " \"s3.secret-access-key\" : \"accessKey\",\n"
+ " \"s3.session-token\" : \"sessionToken\"\n"
+ " }\n"
+ " }, {\n"
+ " \"prefix\" : \"gs://custom-uri\",\n"
+ " \"config\" : {\n"
+ " \"gcs.oauth2.token\" : \"gcsToken1\",\n"
+ " \"gcs.oauth2.token-expires-at\" : \"1000\"\n"
+ " }\n"
+ " }, {\n"
+ " \"prefix\" : \"gs\",\n"
+ " \"config\" : {\n"
+ " \"gcs.oauth2.token\" : \"gcsToken2\",\n"
+ " \"gcs.oauth2.token-expires-at\" : \"2000\"\n"
+ " }\n"
+ " } ]\n"
+ "}";

String json = FetchPlanningResultResponseParser.toJson(response, true);
assertThat(json).isEqualTo(expectedJson);

FetchPlanningResultResponse fromResponse =
FetchPlanningResultResponseParser.fromJson(json, PARTITION_SPECS_BY_ID, false);
FetchPlanningResultResponse copyResponse =
FetchPlanningResultResponse.builder()
.withPlanStatus(fromResponse.planStatus())
.withCredentials(credentials)
.build();

assertThat(FetchPlanningResultResponseParser.toJson(copyResponse, true))
.isEqualTo(expectedJson);
}
}