You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "nastra (via GitHub)" <gi...@apache.org> on 2023/05/12 10:00:52 UTC
[GitHub] [iceberg] nastra commented on a diff in pull request #7590: AWS: Add S3FileIOAwsClientFactory with s3.client-factory-impl catalog property for S3FileIO
nastra commented on code in PR #7590:
URL: https://github.com/apache/iceberg/pull/7590#discussion_r1192156737
##########
aws/src/main/java/org/apache/iceberg/aws/s3/S3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,86 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactories;
+import org.apache.iceberg.aws.AwsClientProperties;
+import org.apache.iceberg.aws.HttpClientProperties;
+import org.apache.iceberg.util.PropertyUtil;
+import software.amazon.awssdk.services.s3.S3Client;
+
+public class S3FileIOAwsClientFactory {
+ /**
+ * This property allows customizing AWS client factory implementation class. If this property is
+ * set, only {@link S3FileIOAwsClientFactory} class will be instantiated. If this property wasn't
+ * set, will load one of {@link org.apache.iceberg.aws.AwsClientFactory} factory classes to
+ * provide backward compatibility.
+ */
+ public static final String CLIENT_FACTORY = "s3.client-factory-impl";
+
+ private final S3FileIOProperties s3FileIOProperties;
+ private final HttpClientProperties httpClientProperties;
+ private final AwsClientProperties awsClientProperties;
+
+ S3FileIOAwsClientFactory(
+ S3FileIOProperties s3FileIOProperties,
+ HttpClientProperties httpClientProperties,
+ AwsClientProperties awsClientProperties) {
+ this.s3FileIOProperties = s3FileIOProperties;
+ this.httpClientProperties = httpClientProperties;
+ this.awsClientProperties = awsClientProperties;
+ }
+
+ /**
+ * Returns an instance of a client factory class based on properties. If the {@value
+ * #CLIENT_FACTORY} is set, will return an instance of type {@link S3FileIOAwsClientFactory}.
+ * Otherwise, will return an instance of type {@link org.apache.iceberg.aws.AwsClientFactory} for
+ * backward compatibility. To provide
+ *
+ * @param properties catalog properties
+ * @param <T> a java return type
+ * @return factory class object
+ */
+ @SuppressWarnings("unchecked")
+ public static <T> T getS3ClientFactoryImpl(Map<String, String> properties) {
+ boolean useS3FileIO = PropertyUtil.propertyAsBoolean(properties, CLIENT_FACTORY, false);
Review Comment:
nit: `useS3FileIO` is slightly misleading, maybe `initFactory` or something along those lines?
##########
aws/src/test/java/org/apache/iceberg/aws/s3/TestS3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,58 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactory;
+import org.apache.iceberg.relocated.com.google.common.collect.Maps;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class TestS3FileIOAwsClientFactory {
+
+ @Test
+ public void testS3FileIOImplSetToTrue() {
+ Map<String, String> properties = Maps.newHashMap();
+ properties.put(S3FileIOAwsClientFactory.CLIENT_FACTORY, "true");
+ Object factoryImpl = S3FileIOAwsClientFactory.getS3ClientFactoryImpl(properties);
+ Assertions.assertThat(factoryImpl instanceof S3FileIOAwsClientFactory)
Review Comment:
can be simplified to `assertThat(factoryImpl).isInstanceOf(S3FileIOAwsClientFactory.class)`
##########
aws/src/main/java/org/apache/iceberg/aws/s3/S3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,86 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactories;
+import org.apache.iceberg.aws.AwsClientProperties;
+import org.apache.iceberg.aws.HttpClientProperties;
+import org.apache.iceberg.util.PropertyUtil;
+import software.amazon.awssdk.services.s3.S3Client;
+
+public class S3FileIOAwsClientFactory {
Review Comment:
should this be `Serializable`?
##########
aws/src/main/java/org/apache/iceberg/aws/s3/S3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,86 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactories;
+import org.apache.iceberg.aws.AwsClientProperties;
+import org.apache.iceberg.aws.HttpClientProperties;
+import org.apache.iceberg.util.PropertyUtil;
+import software.amazon.awssdk.services.s3.S3Client;
+
+public class S3FileIOAwsClientFactory {
+ /**
+ * This property allows customizing AWS client factory implementation class. If this property is
+ * set, only {@link S3FileIOAwsClientFactory} class will be instantiated. If this property wasn't
+ * set, will load one of {@link org.apache.iceberg.aws.AwsClientFactory} factory classes to
+ * provide backward compatibility.
+ */
+ public static final String CLIENT_FACTORY = "s3.client-factory-impl";
+
+ private final S3FileIOProperties s3FileIOProperties;
+ private final HttpClientProperties httpClientProperties;
+ private final AwsClientProperties awsClientProperties;
+
+ S3FileIOAwsClientFactory(
+ S3FileIOProperties s3FileIOProperties,
+ HttpClientProperties httpClientProperties,
+ AwsClientProperties awsClientProperties) {
+ this.s3FileIOProperties = s3FileIOProperties;
+ this.httpClientProperties = httpClientProperties;
+ this.awsClientProperties = awsClientProperties;
+ }
+
+ /**
+ * Returns an instance of a client factory class based on properties. If the {@value
+ * #CLIENT_FACTORY} is set, will return an instance of type {@link S3FileIOAwsClientFactory}.
+ * Otherwise, will return an instance of type {@link org.apache.iceberg.aws.AwsClientFactory} for
+ * backward compatibility. To provide
+ *
+ * @param properties catalog properties
+ * @param <T> a java return type
+ * @return factory class object
+ */
+ @SuppressWarnings("unchecked")
+ public static <T> T getS3ClientFactoryImpl(Map<String, String> properties) {
Review Comment:
to me it feels like this functionality should live in a slimmed down version of `AwsClientFactories` where we don't have compile-time dependencies to dynamo/glue/.. (basically without the `DefaultAwsClientFactory`)
##########
aws/src/test/java/org/apache/iceberg/aws/s3/TestS3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,58 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactory;
+import org.apache.iceberg.relocated.com.google.common.collect.Maps;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class TestS3FileIOAwsClientFactory {
+
+ @Test
+ public void testS3FileIOImplSetToTrue() {
+ Map<String, String> properties = Maps.newHashMap();
+ properties.put(S3FileIOAwsClientFactory.CLIENT_FACTORY, "true");
+ Object factoryImpl = S3FileIOAwsClientFactory.getS3ClientFactoryImpl(properties);
+ Assertions.assertThat(factoryImpl instanceof S3FileIOAwsClientFactory)
+ .withFailMessage(
+ "should instantiate an object of type S3FileIOAwsClientFactory when s3.client-factory-impl is set")
+ .isTrue();
+ assert factoryImpl instanceof S3FileIOAwsClientFactory;
Review Comment:
not sure why we're using `assert` here. I believe this would even be always ignored because they have to be explicitly enabled.
##########
aws/src/main/java/org/apache/iceberg/aws/s3/S3FileIOAwsClientFactory.java:
##########
@@ -0,0 +1,86 @@
+/*
+ * 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.aws.s3;
+
+import java.util.Map;
+import org.apache.iceberg.aws.AwsClientFactories;
+import org.apache.iceberg.aws.AwsClientProperties;
+import org.apache.iceberg.aws.HttpClientProperties;
+import org.apache.iceberg.util.PropertyUtil;
+import software.amazon.awssdk.services.s3.S3Client;
+
+public class S3FileIOAwsClientFactory {
+ /**
+ * This property allows customizing AWS client factory implementation class. If this property is
+ * set, only {@link S3FileIOAwsClientFactory} class will be instantiated. If this property wasn't
+ * set, will load one of {@link org.apache.iceberg.aws.AwsClientFactory} factory classes to
+ * provide backward compatibility.
+ */
+ public static final String CLIENT_FACTORY = "s3.client-factory-impl";
Review Comment:
`impl` in the property name usually suggests that one would specify an actual implementation class, but here we're using a boolean, which seems inconsistent
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org