Skip to content
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

Auth Manager API part 4: RESTClient, HTTPClient #11992

Merged
merged 10 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from 8 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
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.apache.iceberg.rest.ErrorHandlers;
import org.apache.iceberg.rest.HTTPClient;
import org.apache.iceberg.rest.RESTClient;
import org.apache.iceberg.rest.auth.AuthSession;
import org.apache.iceberg.rest.auth.OAuth2Properties;
import org.apache.iceberg.rest.auth.OAuth2Util;
import org.apache.iceberg.rest.credentials.Credential;
Expand Down Expand Up @@ -74,7 +75,11 @@ private RESTClient httpClient() {
if (null == client) {
synchronized (this) {
if (null == client) {
client = HTTPClient.builder(properties).uri(properties.get(URI)).build();
client =
HTTPClient.builder(properties)
.uri(properties.get(URI))
.withAuthSession(AuthSession.EMPTY)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here? The default should not be EMPTY, that just cases it to fall through.

.build();
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ private RESTClient httpClient() {
HTTPClient.builder(properties())
.uri(baseSignerUri())
.withObjectMapper(S3ObjectMapper.mapper())
.withAuthSession(org.apache.iceberg.rest.auth.AuthSession.EMPTY)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we setting this to EMPTY? In order to sign we need an auth session. Wouldn't this result in no headers/sigs being produced if a call was made without explicitly setting the auth session? We want enforce that an auth session is used, but this results in falling back to nothing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with your suggestions for other components, but here I disagree: the HTTP client must be configured with an empty auth session because it will be used for token refreshes. If it contains, say, token t1, and token t1 gets refreshed and exchanged for t2, there would be a clash between the token from the HTTP client (t1) and the one from the refreshed auth session (t2).

Copy link
Contributor Author

@adutra adutra Feb 5, 2025

Choose a reason for hiding this comment

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

I will however move this call to the authSession() method and add a comment to explain why an EMPTY session is needed in this specific case.

.build();
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Maps;
import org.apache.iceberg.rest.HTTPClient;
import org.apache.iceberg.rest.auth.AuthSession;
import org.apache.iceberg.rest.auth.OAuth2Util;
import org.apache.iceberg.rest.responses.ConfigResponse;
import org.apache.iceberg.rest.responses.OAuthTokenResponse;
Expand Down Expand Up @@ -64,6 +65,7 @@ public static void beforeClass() {
HTTPClient.builder(properties)
.uri("http://localhost:" + mockServer.getLocalPort())
.withHeader(HttpHeaders.AUTHORIZATION, "Bearer existing_token")
.withAuthSession(AuthSession.EMPTY)
.build();
}

Expand Down
126 changes: 126 additions & 0 deletions core/src/main/java/org/apache/iceberg/rest/BaseHTTPClient.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License 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 org.apache.iceberg.rest;

import java.util.Map;
import java.util.function.Consumer;
import org.apache.iceberg.rest.HTTPRequest.HTTPMethod;
import org.apache.iceberg.rest.auth.AuthSession;
import org.apache.iceberg.rest.responses.ErrorResponse;

/**
* A base class for {@link RESTClient} implementations.
*
* <p>All methods in {@link RESTClient} are implemented in the same way: first, an {@link
* HTTPRequest} is {@linkplain #buildRequest(HTTPMethod, String, Map, Map, Object) built from the
* method arguments}, then {@linkplain #execute(HTTPRequest, Class, Consumer, Consumer) executed}.
*
* <p>This allows subclasses to provide a consistent way to execute all requests, regardless of the
* method or arguments.
*/
public abstract class BaseHTTPClient implements RESTClient {

@Override
public abstract RESTClient withAuthSession(AuthSession session);

@Override
public void head(String path, Map<String, String> headers, Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.HEAD, path, null, headers, null);
execute(request, null, errorHandler, h -> {});
}

@Override
public <T extends RESTResponse> T delete(
danielcweeks marked this conversation as resolved.
Show resolved Hide resolved
String path,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.DELETE, path, null, headers, null);
return execute(request, responseType, errorHandler, h -> {});
}

@Override
public <T extends RESTResponse> T delete(
String path,
Map<String, String> queryParams,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.DELETE, path, queryParams, headers, null);
return execute(request, responseType, errorHandler, h -> {});
}

@Override
public <T extends RESTResponse> T get(
String path,
Map<String, String> queryParams,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.GET, path, queryParams, headers, null);
return execute(request, responseType, errorHandler, h -> {});
}

@Override
public <T extends RESTResponse> T post(
String path,
RESTRequest body,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, body);
return execute(request, responseType, errorHandler, h -> {});
}

@Override
public <T extends RESTResponse> T post(
String path,
RESTRequest body,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler,
Consumer<Map<String, String>> responseHeaders) {
HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, body);
return execute(request, responseType, errorHandler, responseHeaders);
}

@Override
public <T extends RESTResponse> T postForm(
String path,
Map<String, String> formData,
Class<T> responseType,
Map<String, String> headers,
Consumer<ErrorResponse> errorHandler) {
HTTPRequest request = buildRequest(HTTPMethod.POST, path, null, headers, formData);
return execute(request, responseType, errorHandler, h -> {});
}

protected abstract HTTPRequest buildRequest(
HTTPMethod method,
String path,
Map<String, String> queryParams,
Map<String, String> headers,
Object body);

protected abstract <T extends RESTResponse> T execute(
HTTPRequest request,
Class<T> responseType,
Consumer<ErrorResponse> errorHandler,
Consumer<Map<String, String>> responseHeaders);
}
Loading