wuchong commented on code in PR #19859: URL: https://github.com/apache/flink/pull/19859#discussion_r901090327
########## flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/resource/ResourceManager.java: ########## @@ -0,0 +1,208 @@ +/* + * 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.flink.table.resource; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.VisibleForTesting; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.core.fs.FileSystem; +import org.apache.flink.core.fs.Path; +import org.apache.flink.table.api.config.TableConfigOptions; +import org.apache.flink.util.FileUtils; +import org.apache.flink.util.FlinkRuntimeException; +import org.apache.flink.util.JarUtils; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.Closeable; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; + +import static org.apache.flink.util.FlinkUserCodeClassLoaders.SafetyNetWrapperClassLoader; + +/** A manager for dealing with all user defined resource. */ +@Internal +public class ResourceManager implements Closeable { + + private static final Logger LOG = LoggerFactory.getLogger(ResourceManager.class); + + private final Path localResourceDir; + private final Map<ResourceUri, URL> resourceInfos; + private final SafetyNetWrapperClassLoader userClassLoader; + + public ResourceManager(Configuration config, SafetyNetWrapperClassLoader userClassLoader) { + this.localResourceDir = + new Path( + config.get(TableConfigOptions.RESOURCE_DOWNLOAD_DIR), + String.format("flink-table-%s", UUID.randomUUID())); + this.resourceInfos = new HashMap<>(); + this.userClassLoader = userClassLoader; + } + + public URLClassLoader getUserClassLoader() { + return userClassLoader; + } + + public void registerResource(ResourceUri resourceUri) { + // check whether the resource has been registered + if (resourceInfos.containsKey(resourceUri)) { + LOG.info( + "Resource [{}] has been registered, overwriting of registered resource is not supported " + + "in the current version, skipping.", + resourceUri.getUri()); + return; + } + + // here can check whether the resource path is valid + Path path = new Path(resourceUri.getUri()); + // check resource firstly + checkResource(path); + + URL localUrl; + // check resource scheme + String scheme = StringUtils.lowerCase(path.toUri().getScheme()); + // download resource to local path firstly if in remote + if (scheme != null && !"file".equals(scheme)) { + localUrl = downloadResource(path); + } else { + localUrl = getURLFromPath(path); + } + + // only need add jar resource to classloader + if (ResourceType.JAR.equals(resourceUri.getResourceType())) { + // check the Jar file firstly + try { + JarUtils.checkJarFile(localUrl); + } catch (IOException e) { + throw new FlinkRuntimeException( + String.format("Failed to check jar resource [%s].", localUrl), e); + } + + // add it to classloader + userClassLoader.addURL(localUrl); + LOG.info("Added jar resource [{}] to class path.", localUrl); + } + + resourceInfos.put(resourceUri, localUrl); + LOG.info("Register resource [{}] successfully.", resourceUri.getUri()); + } + + public Map<ResourceUri, URL> getResources() { + return Collections.unmodifiableMap(resourceInfos); + } + + public Set<URL> getJarResourceURLs() { + return resourceInfos.entrySet().stream() + .filter(entry -> ResourceType.JAR.equals(entry.getKey().getResourceType())) + .map(Map.Entry::getValue) + .collect(Collectors.toSet()); + } + + private void checkResource(Path path) { + try { + FileSystem fs = path.getFileSystem(); + // check resource exists firstly + if (!fs.exists(path)) { + throw new IllegalArgumentException(String.format("Resource [%s] not found.", path)); + } + + // register directory is not allowed for resource + if (fs.getFileStatus(path).isDir()) { + throw new IllegalArgumentException( + String.format( + "Directory [%s] is not allowed for registering resource.", path)); + } + } catch (IOException e) { + throw new FlinkRuntimeException( + String.format("Failed to check resource [%s].", path), e); + } + } + + @VisibleForTesting + protected URL downloadResource(Path remotePath) { + // get local resource path + Path localPath = getResourceLocalPath(remotePath); + try { + FileUtils.copy(remotePath, localPath, true); + LOG.info( + "Download resource [{}] to local path [{}] successfully.", + remotePath, + localPath); + } catch (IOException e) { + throw new FlinkRuntimeException( + String.format( + "Failed to download resource [%s] to local path [%s].", + remotePath, localPath), + e); + } + return getURLFromPath(localPath); + } + + private Path getResourceLocalPath(Path remotePath) { + String fileName = remotePath.getName(); + // add UUID suffix to avoid conflicts + String fileNameWithUUID; + if (fileName.toLowerCase().endsWith(".jar")) { Review Comment: Please do not hard code for `.jar`. This can be generalized to extract suffix (e.g. `com.google.common.io.Files.getFileExtension`) and append UUID. ########## flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/resource/ResourceManager.java: ########## @@ -0,0 +1,208 @@ +/* + * 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.flink.table.resource; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.VisibleForTesting; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.core.fs.FileSystem; +import org.apache.flink.core.fs.Path; +import org.apache.flink.table.api.config.TableConfigOptions; +import org.apache.flink.util.FileUtils; +import org.apache.flink.util.FlinkRuntimeException; +import org.apache.flink.util.JarUtils; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.Closeable; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; + +import static org.apache.flink.util.FlinkUserCodeClassLoaders.SafetyNetWrapperClassLoader; + +/** A manager for dealing with all user defined resource. */ +@Internal +public class ResourceManager implements Closeable { + + private static final Logger LOG = LoggerFactory.getLogger(ResourceManager.class); + + private final Path localResourceDir; + private final Map<ResourceUri, URL> resourceInfos; + private final SafetyNetWrapperClassLoader userClassLoader; + + public ResourceManager(Configuration config, SafetyNetWrapperClassLoader userClassLoader) { + this.localResourceDir = + new Path( + config.get(TableConfigOptions.RESOURCE_DOWNLOAD_DIR), + String.format("flink-table-%s", UUID.randomUUID())); + this.resourceInfos = new HashMap<>(); + this.userClassLoader = userClassLoader; + } + + public URLClassLoader getUserClassLoader() { + return userClassLoader; + } + + public void registerResource(ResourceUri resourceUri) { + // check whether the resource has been registered + if (resourceInfos.containsKey(resourceUri)) { + LOG.info( + "Resource [{}] has been registered, overwriting of registered resource is not supported " + + "in the current version, skipping.", + resourceUri.getUri()); + return; + } + + // here can check whether the resource path is valid + Path path = new Path(resourceUri.getUri()); + // check resource firstly + checkResource(path); + + URL localUrl; + // check resource scheme + String scheme = StringUtils.lowerCase(path.toUri().getScheme()); + // download resource to local path firstly if in remote + if (scheme != null && !"file".equals(scheme)) { + localUrl = downloadResource(path); + } else { + localUrl = getURLFromPath(path); + } + + // only need add jar resource to classloader + if (ResourceType.JAR.equals(resourceUri.getResourceType())) { + // check the Jar file firstly + try { + JarUtils.checkJarFile(localUrl); + } catch (IOException e) { + throw new FlinkRuntimeException( + String.format("Failed to check jar resource [%s].", localUrl), e); Review Comment: The exception message is not clear to me, unable to check or the resource is illegal? Maybe the message can be improved to "The resource URL %s is not a valid JAR file" . ########## flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/resource/ResourceManager.java: ########## @@ -0,0 +1,208 @@ +/* + * 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.flink.table.resource; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.VisibleForTesting; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.core.fs.FileSystem; +import org.apache.flink.core.fs.Path; +import org.apache.flink.table.api.config.TableConfigOptions; +import org.apache.flink.util.FileUtils; +import org.apache.flink.util.FlinkRuntimeException; +import org.apache.flink.util.JarUtils; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.Closeable; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.net.URLClassLoader; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.stream.Collectors; + +import static org.apache.flink.util.FlinkUserCodeClassLoaders.SafetyNetWrapperClassLoader; + +/** A manager for dealing with all user defined resource. */ +@Internal +public class ResourceManager implements Closeable { + + private static final Logger LOG = LoggerFactory.getLogger(ResourceManager.class); + + private final Path localResourceDir; + private final Map<ResourceUri, URL> resourceInfos; + private final SafetyNetWrapperClassLoader userClassLoader; + + public ResourceManager(Configuration config, SafetyNetWrapperClassLoader userClassLoader) { + this.localResourceDir = + new Path( + config.get(TableConfigOptions.RESOURCE_DOWNLOAD_DIR), + String.format("flink-table-%s", UUID.randomUUID())); + this.resourceInfos = new HashMap<>(); + this.userClassLoader = userClassLoader; + } + + public URLClassLoader getUserClassLoader() { + return userClassLoader; + } + + public void registerResource(ResourceUri resourceUri) { + // check whether the resource has been registered + if (resourceInfos.containsKey(resourceUri)) { + LOG.info( + "Resource [{}] has been registered, overwriting of registered resource is not supported " + + "in the current version, skipping.", + resourceUri.getUri()); + return; + } + + // here can check whether the resource path is valid + Path path = new Path(resourceUri.getUri()); + // check resource firstly + checkResource(path); + + URL localUrl; + // check resource scheme + String scheme = StringUtils.lowerCase(path.toUri().getScheme()); + // download resource to local path firstly if in remote + if (scheme != null && !"file".equals(scheme)) { + localUrl = downloadResource(path); + } else { + localUrl = getURLFromPath(path); + } + + // only need add jar resource to classloader + if (ResourceType.JAR.equals(resourceUri.getResourceType())) { + // check the Jar file firstly + try { + JarUtils.checkJarFile(localUrl); + } catch (IOException e) { + throw new FlinkRuntimeException( + String.format("Failed to check jar resource [%s].", localUrl), e); + } + + // add it to classloader + userClassLoader.addURL(localUrl); + LOG.info("Added jar resource [{}] to class path.", localUrl); + } + + resourceInfos.put(resourceUri, localUrl); + LOG.info("Register resource [{}] successfully.", resourceUri.getUri()); + } + + public Map<ResourceUri, URL> getResources() { + return Collections.unmodifiableMap(resourceInfos); + } + + public Set<URL> getJarResourceURLs() { + return resourceInfos.entrySet().stream() + .filter(entry -> ResourceType.JAR.equals(entry.getKey().getResourceType())) + .map(Map.Entry::getValue) + .collect(Collectors.toSet()); + } + + private void checkResource(Path path) { + try { + FileSystem fs = path.getFileSystem(); + // check resource exists firstly + if (!fs.exists(path)) { + throw new IllegalArgumentException(String.format("Resource [%s] not found.", path)); + } + + // register directory is not allowed for resource + if (fs.getFileStatus(path).isDir()) { + throw new IllegalArgumentException( + String.format( + "Directory [%s] is not allowed for registering resource.", path)); Review Comment: "The resource %s is a directory, however, the directory is not allowed for registering resource. " Make the failed reason clear (i.e. directory is not allowed) ? -- 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]
