All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.flink.runtime.client.ClientUtils Maven / Gradle / Ivy

There is a newer version: 1.13.6
Show newest version
/*
 * 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.runtime.client;

import org.apache.flink.api.common.JobID;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.core.fs.Path;
import org.apache.flink.runtime.blob.BlobClient;
import org.apache.flink.runtime.blob.PermanentBlobKey;
import org.apache.flink.runtime.jobgraph.JobGraph;
import org.apache.flink.util.FlinkException;
import org.apache.flink.util.function.SupplierWithException;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.function.Supplier;
import java.util.stream.Collectors;

/**
 * Contains utility methods for clients.
 */
public enum ClientUtils {
	;

	/**
	 * Extracts all files required for the execution from the given {@link JobGraph} and uploads them using the {@link BlobClient}
	 * from the given {@link Supplier}.
	 *
	 * @param jobGraph jobgraph requiring files
	 * @param clientSupplier supplier of blob client to upload files with
	 * @throws FlinkException if the upload fails
	 */
	public static void extractAndUploadJobGraphFiles(JobGraph jobGraph, SupplierWithException clientSupplier) throws FlinkException {
		List userJars = jobGraph.getUserJars();
		Collection> userArtifacts = jobGraph.getUserArtifacts().entrySet().stream()
			.map(entry -> Tuple2.of(entry.getKey(), new Path(entry.getValue().filePath)))
			.collect(Collectors.toList());

		uploadJobGraphFiles(jobGraph, userJars, userArtifacts, clientSupplier);
	}

	/**
	 * Uploads the given jars and artifacts required for the execution of the given {@link JobGraph} using the {@link BlobClient} from
	 * the given {@link Supplier}.
	 *
	 * @param jobGraph jobgraph requiring files
	 * @param userJars jars to upload
	 * @param userArtifacts artifacts to upload
	 * @param clientSupplier supplier of blob client to upload files with
	 * @throws FlinkException if the upload fails
	 */
	public static void uploadJobGraphFiles(
			JobGraph jobGraph,
			Collection userJars,
			Collection> userArtifacts,
			SupplierWithException clientSupplier) throws FlinkException {
		if (!userJars.isEmpty() || !userArtifacts.isEmpty()) {
			try (BlobClient client = clientSupplier.get()) {
				uploadAndSetUserJars(jobGraph, userJars, client);
				uploadAndSetUserArtifacts(jobGraph, userArtifacts, client);
			} catch (IOException ioe) {
				throw new FlinkException("Could not upload job files.", ioe);
			}
		}
		jobGraph.writeUserArtifactEntriesToConfiguration();
	}

	/**
	 * Uploads the given user jars using the given {@link BlobClient}, and sets the appropriate blobkeys on the given {@link JobGraph}.
	 *
	 * @param jobGraph jobgraph requiring user jars
	 * @param userJars jars to upload
	 * @param blobClient client to upload jars with
	 * @throws IOException if the upload fails
	 */
	private static void uploadAndSetUserJars(JobGraph jobGraph, Collection userJars, BlobClient blobClient) throws IOException {
		Collection blobKeys = uploadUserJars(jobGraph.getJobID(), userJars, blobClient);
		setUserJarBlobKeys(blobKeys, jobGraph);
	}

	private static Collection uploadUserJars(JobID jobId, Collection userJars, BlobClient blobClient) throws IOException {
		Collection blobKeys = new ArrayList<>(userJars.size());
		for (Path jar : userJars) {
			final PermanentBlobKey blobKey = blobClient.uploadFile(jobId, jar);
			blobKeys.add(blobKey);
		}
		return blobKeys;
	}

	private static void setUserJarBlobKeys(Collection blobKeys, JobGraph jobGraph) {
		blobKeys.forEach(jobGraph::addUserJarBlobKey);
	}

	/**
	 * Uploads the given user artifacts using the given {@link BlobClient}, and sets the appropriate blobkeys on the given {@link JobGraph}.
	 *
	 * @param jobGraph jobgraph requiring user artifacts
	 * @param artifactPaths artifacts to upload
	 * @param blobClient client to upload artifacts with
	 * @throws IOException if the upload fails
	 */
	private static void uploadAndSetUserArtifacts(JobGraph jobGraph, Collection> artifactPaths, BlobClient blobClient) throws IOException {
		Collection> blobKeys = uploadUserArtifacts(jobGraph.getJobID(), artifactPaths, blobClient);
		setUserArtifactBlobKeys(jobGraph, blobKeys);
	}

	private static Collection> uploadUserArtifacts(JobID jobID, Collection> userArtifacts, BlobClient blobClient) throws IOException {
		Collection> blobKeys = new ArrayList<>(userArtifacts.size());
		for (Tuple2 userArtifact : userArtifacts) {
			// only upload local files
			if (!userArtifact.f1.getFileSystem().isDistributedFS()) {
				final PermanentBlobKey blobKey = blobClient.uploadFile(jobID, userArtifact.f1);
				blobKeys.add(Tuple2.of(userArtifact.f0, blobKey));
			}
		}
		return blobKeys;
	}

	private static void setUserArtifactBlobKeys(JobGraph jobGraph, Collection> blobKeys) throws IOException {
		for (Tuple2 blobKey : blobKeys) {
			jobGraph.setUserArtifactBlobKey(blobKey.f0, blobKey.f1);
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy