FANNG1 commented on code in PR #12541: URL: https://github.com/apache/gravitino/pull/12541#discussion_r3869184927
########## spark-connector/spark-common/src/test/java/org/apache/gravitino/spark/connector/plugin/TestLanceRESTCatalogProvider.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.gravitino.spark.connector.plugin; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.sun.net.httpserver.HttpExchange; +import com.sun.net.httpserver.HttpServer; +import java.io.IOException; +import java.io.OutputStream; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +public class TestLanceRESTCatalogProvider { + + private HttpServer server; + private String serverUri; + + @BeforeEach + void startServer() throws IOException { + server = HttpServer.create(new InetSocketAddress("localhost", 0), 0); + serverUri = "http://localhost:"; + server.getAddress().getPort() + "/lance/"; + } + + @AfterEach + void stopServer() { + server.stop(0); + } + + @Test + void testListsAllCatalogPages() { + AtomicInteger requests = new AtomicInteger(); + server.createContext( + "/lance/v1/namespace/$/list", + exchange -> { + int request = requests.getAndIncrement(); + if (request == 0) { + assertFalse(exchange.getRequestURI().getQuery().contains("page_token")); + respond(exchange, 200, "{\"namespaces\":[\"catalog_b\"],\"page_token\":\"next\"}"); + } else { + assertTrue(exchange.getRequestURI().getQuery().contains("page_token=next")); Review Comment: The generated Lance client always sends the non-null argument on every request, so the first request still has a query string; it only omits . Keeping this assertion strict also detects a regression in the generated client's request shape. The focused pagination test and Spark IT pass with this behavior. ########## spark-connector/spark-common/src/main/java/org/apache/gravitino/spark/connector/plugin/GravitinoLakehouseRESTDiscoveryDriverPlugin.java: ########## @@ -0,0 +1,434 @@ +/* + * 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.gravitino.spark.connector.plugin; + +import static org.apache.gravitino.spark.connector.ConnectorConstants.COMMA; +import static org.apache.gravitino.spark.connector.utils.ConnectorUtil.removeDuplicateSparkExtensions; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.lang.reflect.InvocationTargetException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.ServiceConfigurationError; +import java.util.ServiceLoader; +import java.util.Set; +import java.util.TreeMap; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.apache.commons.lang3.StringUtils; +import org.apache.spark.SparkConf; +import org.apache.spark.SparkContext; +import org.apache.spark.api.plugin.DriverPlugin; +import org.apache.spark.api.plugin.PluginContext; +import org.apache.spark.sql.catalyst.parser.CatalystSqlParser$; +import org.apache.spark.sql.internal.StaticSQLConf; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import scala.Tuple2; +import scala.collection.Seq; + +class GravitinoLakehouseRESTDiscoveryDriverPlugin implements DriverPlugin { + + @VisibleForTesting + static final String REGISTRATION_POLICY_CONFIG = "spark.sql.gravitino.REST.registrationPolicy"; + + private static final Logger LOG = + LoggerFactory.getLogger(GravitinoLakehouseRESTDiscoveryDriverPlugin.class); + private static final String GRAVITINO_PREFIX = "spark.sql.gravitino."; + private static final String SPARK_CATALOG_PREFIX = "spark.sql.catalog."; + private static final String URI_SUFFIX = "REST.uri"; + private static final String CATALOG_PROPERTIES_INFIX = "REST.catalogProperties."; + private static final Pattern PROVIDER_URI_PATTERN = + Pattern.compile("^spark\\.sql\\.gravitino\\.([A-Za-z][A-Za-z0-9]*)REST\\.uri$"); + private static final CatalogRegistrationPolicy DEFAULT_POLICY = (format, catalogName) -> true; + + private final List<LakehouseRESTCatalogProvider> providersForTesting; + + GravitinoLakehouseRESTDiscoveryDriverPlugin() { + this.providersForTesting = null; + } + + @VisibleForTesting + GravitinoLakehouseRESTDiscoveryDriverPlugin( + List<LakehouseRESTCatalogProvider> providersForTesting) { + this.providersForTesting = new ArrayList<>(providersForTesting); + } + + @Override + public Map<String, String> init(SparkContext sc, PluginContext pluginContext) { + initialize(sc.conf()); + return Collections.emptyMap(); + } + + @VisibleForTesting + void initialize(SparkConf sparkConf) { + validatePluginOrder(sparkConf); + SparkConf userConf = sparkConf.clone(); + Map<String, String> activeFormats = findActiveFormats(userConf); + if (activeFormats.isEmpty()) { + return; + } + + ClassLoader classLoader = contextClassLoader(); + Map<String, LakehouseRESTCatalogProvider> providers = loadProviders(classLoader); + CatalogRegistrationPolicy policy = loadRegistrationPolicy(userConf, classLoader); + List<CatalogRegistration> registrations = new ArrayList<>(); + Set<String> registeredNames = new LinkedHashSet<>(); + Set<String> extensions = new LinkedHashSet<>(); + + activeFormats.forEach( + (format, uri) -> { + LakehouseRESTCatalogProvider provider = providers.get(format); + Preconditions.checkArgument( + provider != null, + "No lakehouse REST catalog provider found for configured format: %s", + format); + validateProviderRuntime(provider, classLoader); + + Map<String, String> globalProperties = extractCatalogProperties(userConf, format); + List<String> advertisedCatalogs = + provider.listCatalogs(uri, Collections.unmodifiableMap(globalProperties)); + Preconditions.checkState( + advertisedCatalogs != null, + "Lakehouse REST catalog provider %s returned a null catalog list", + format); + + List<String> sortedCatalogs = new ArrayList<>(advertisedCatalogs); + Collections.sort(sortedCatalogs); + for (String catalogName : sortedCatalogs) { + addRegistration( + userConf, + provider, + policy, + format, + uri, + catalogName, + globalProperties, + registeredNames, + registrations); + } + extensions.addAll(Arrays.asList(provider.sparkExtensions())); + }); + + applyRegistrations(sparkConf, userConf, registrations); + registerSqlExtensions(sparkConf, extensions); + } + + private static void validatePluginOrder(SparkConf sparkConf) { + String configuredPlugins = sparkConf.get("spark.plugins", ""); + List<String> plugins = new ArrayList<>(); + for (String plugin : configuredPlugins.split(COMMA)) { + if (StringUtils.isNotBlank(plugin)) { + plugins.add(plugin.trim()); + } + } + + int discoveryPluginIndex = + plugins.indexOf(GravitinoLakehouseRESTDiscoveryPlugin.class.getName()); + int gravitinoPluginIndex = plugins.indexOf(GravitinoSparkPlugin.class.getName()); + Preconditions.checkArgument( + discoveryPluginIndex < 0 + || gravitinoPluginIndex < 0 + || discoveryPluginIndex < gravitinoPluginIndex, + "%s must be listed before %s in spark.plugins", + GravitinoLakehouseRESTDiscoveryPlugin.class.getName(), + GravitinoSparkPlugin.class.getName()); + } + + private static Map<String, String> findActiveFormats(SparkConf userConf) { + Map<String, String> activeFormats = new TreeMap<>(); + for (Tuple2<String, String> entry : userConf.getAll()) { + Matcher matcher = PROVIDER_URI_PATTERN.matcher(entry._1); + if (matcher.matches()) { + String format = matcher.group(1); + String uri = entry._2; + Preconditions.checkArgument( + StringUtils.isNotBlank(uri), + "%s%s%s must not be blank", + GRAVITINO_PREFIX, + format, + URI_SUFFIX); + activeFormats.put(format, uri); + } + } + return activeFormats; + } + + private Map<String, LakehouseRESTCatalogProvider> loadProviders(ClassLoader classLoader) { + List<LakehouseRESTCatalogProvider> loadedProviders = new ArrayList<>(); + if (providersForTesting != null) { + loadedProviders.addAll(providersForTesting); + } else { + try { + ServiceLoader.load(LakehouseRESTCatalogProvider.class, classLoader) + .forEach(loadedProviders::add); + } catch (ServiceConfigurationError e) { + throw new IllegalArgumentException("Failed to load lakehouse REST catalog providers", e); + } + } + + Map<String, LakehouseRESTCatalogProvider> providers = new HashMap<>(); + for (LakehouseRESTCatalogProvider provider : loadedProviders) { + String format = provider.format(); + Preconditions.checkArgument( + StringUtils.isNotBlank(format), "Lakehouse REST catalog provider format is blank"); + Preconditions.checkArgument( + format.matches("[A-Za-z][A-Za-z0-9]*"), + "Invalid lakehouse REST catalog provider format: %s", + format); + Preconditions.checkArgument( + providers.put(format, provider) == null, + "Multiple lakehouse REST catalog providers found for format: %s", + format); + } + return providers; + } + + private static CatalogRegistrationPolicy loadRegistrationPolicy( + SparkConf userConf, ClassLoader classLoader) { + if (!userConf.contains(REGISTRATION_POLICY_CONFIG)) { + return DEFAULT_POLICY; + } + + String policyClassName = userConf.get(REGISTRATION_POLICY_CONFIG); + Preconditions.checkArgument( + StringUtils.isNotBlank(policyClassName), + "%s must not be blank", + REGISTRATION_POLICY_CONFIG); + try { + Class<?> policyClass = Class.forName(policyClassName, true, classLoader); + Preconditions.checkArgument( + CatalogRegistrationPolicy.class.isAssignableFrom(policyClass), + "%s does not implement %s", + policyClassName, + CatalogRegistrationPolicy.class.getName()); + return CatalogRegistrationPolicy.class.cast(policyClass.getConstructor().newInstance()); + } catch (ClassNotFoundException + | NoSuchMethodException + | InstantiationException + | IllegalAccessException + | InvocationTargetException e) { + throw new IllegalArgumentException( + "Failed to instantiate catalog registration policy " + policyClassName, e); + } + } + + private static void validateProviderRuntime( + LakehouseRESTCatalogProvider provider, ClassLoader classLoader) { + validateRuntimeClass(provider.format(), provider.catalogClassName(), classLoader); + String[] providerExtensions = provider.sparkExtensions(); + Preconditions.checkState( + providerExtensions != null, + "Lakehouse REST catalog provider %s returned null Spark extensions", + provider.format()); + for (String extension : providerExtensions) { + validateRuntimeClass(provider.format(), extension, classLoader); + } + } + + private static void validateRuntimeClass( + String format, String className, ClassLoader classLoader) { + Preconditions.checkState( + StringUtils.isNotBlank(className), + "Lakehouse REST catalog provider %s returned a blank runtime class", + format); + try { + Class.forName(className, false, classLoader); + } catch (ClassNotFoundException | LinkageError e) { + throw new IllegalArgumentException( + String.format( + "Required runtime class %s for lakehouse REST format %s is not available", + className, format), + e); + } + } + + private static Map<String, String> extractCatalogProperties(SparkConf userConf, String format) { + String prefix = GRAVITINO_PREFIX + format + CATALOG_PROPERTIES_INFIX; + Map<String, String> properties = new LinkedHashMap<>(); + for (Tuple2<String, String> entry : userConf.getAllWithPrefix(prefix)) { + Preconditions.checkArgument( + StringUtils.isNotBlank(entry._1), "%s must include a property name", prefix); + properties.put(entry._1, entry._2); + } + return properties; + } + + private static void addRegistration( + SparkConf userConf, + LakehouseRESTCatalogProvider provider, + CatalogRegistrationPolicy policy, + String format, + String uri, + String advertisedCatalogName, + Map<String, String> globalProperties, + Set<String> registeredNames, + List<CatalogRegistration> registrations) { + Preconditions.checkState( + StringUtils.isNotBlank(advertisedCatalogName), + "Lakehouse REST catalog provider %s advertised a blank catalog name", + format); + if (userConf.contains(SPARK_CATALOG_PREFIX + advertisedCatalogName)) { + LOG.info( + "Skip auto-registering {} catalog {} because it is configured by the user.", + format, + advertisedCatalogName); + return; + } + if (!policy.shouldRegister(format, advertisedCatalogName)) { + return; + } + + String registeredCatalogName = policy.registeredCatalogName(format, advertisedCatalogName); + validateCatalogName(registeredCatalogName); + Preconditions.checkArgument( + !userConf.contains(SPARK_CATALOG_PREFIX + registeredCatalogName), + "Catalog registration policy returned name %s, which is configured by the user", + registeredCatalogName); + Preconditions.checkArgument( + registeredNames.add(registeredCatalogName), + "Catalog registration policy returned duplicate name: %s", + registeredCatalogName); + + Map<String, String> generatedProperties = + provider.generatedCatalogProperties(uri, advertisedCatalogName); + Preconditions.checkState( + generatedProperties != null, + "Lakehouse REST catalog provider %s returned null generated properties", + format); + Map<String, String> mergedProperties = new LinkedHashMap<>(globalProperties); + generatedProperties.forEach( + (key, value) -> { + Preconditions.checkState( + StringUtils.isNotBlank(key), + "Lakehouse REST catalog provider %s returned a blank property name", + format); + Preconditions.checkState( + value != null, + "Lakehouse REST catalog provider %s returned null for property %s", + format, + key); + mergedProperties.put(key, value); + }); + + registrations.add( + new CatalogRegistration( + format, + advertisedCatalogName, + registeredCatalogName, + provider.catalogClassName(), + mergedProperties)); + } + + private static void validateCatalogName(String catalogName) { + Preconditions.checkArgument( + StringUtils.isNotBlank(catalogName), + "Catalog registration policy returned a blank catalog name"); + try { + Seq<String> parts = CatalystSqlParser$.MODULE$.parseMultipartIdentifier(catalogName); + Preconditions.checkArgument( + parts.size() == 1 && catalogName.equals(parts.apply(0)), + "Catalog registration policy returned invalid Spark identifier: %s", + catalogName); + } catch (Exception e) { + throw new IllegalArgumentException( + "Catalog registration policy returned invalid Spark identifier: " + catalogName, e); + } + } + + private static void applyRegistrations( + SparkConf sparkConf, SparkConf userConf, List<CatalogRegistration> registrations) { + for (CatalogRegistration registration : registrations) { + String catalogPrefix = SPARK_CATALOG_PREFIX + registration.registeredCatalogName; + sparkConf.set(catalogPrefix, registration.catalogClassName); + registration.properties.forEach( + (key, value) -> { + String sparkConfigKey = catalogPrefix + "." + key; + if (!userConf.contains(sparkConfigKey)) { + sparkConf.set(sparkConfigKey, value); + } + }); + if (!registration.advertisedCatalogName.equals(registration.registeredCatalogName)) { + LOG.info( + "Register {} REST catalog {} as Spark catalog {}.", + registration.format, + registration.advertisedCatalogName, + registration.registeredCatalogName); + } else { + LOG.info( + "Register {} REST catalog {} in Spark.", + registration.format, + registration.advertisedCatalogName); + } + } + } + + private static void registerSqlExtensions(SparkConf sparkConf, Set<String> extensions) { + if (extensions.isEmpty()) { + return; + } + + String extensionsKey = StaticSQLConf.SPARK_SESSION_EXTENSIONS().key(); + String[] providerExtensions = extensions.toArray(new String[0]); + if (sparkConf.contains(extensionsKey) && StringUtils.isNotBlank(sparkConf.get(extensionsKey))) { + sparkConf.set( + extensionsKey, + removeDuplicateSparkExtensions( + providerExtensions, sparkConf.get(extensionsKey).split(COMMA))); Review Comment: already filters blank values and trims every element in before deduplication and joining. Therefore the values produced by cannot retain leading/trailing whitespace in the resulting Spark configuration, so no additional trimming is needed here. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
