Flaugh24 commented on code in PR #2390: URL: https://github.com/apache/ignite-3/pull/2390#discussion_r1288268310
########## modules/file-transfer/src/main/java/org/apache/ignite/internal/network/file/FileTransferServiceImpl.java: ########## @@ -0,0 +1,402 @@ +/* + * 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.ignite.internal.network.file; + +import static java.util.concurrent.CompletableFuture.completedFuture; +import static java.util.concurrent.CompletableFuture.failedFuture; +import static java.util.concurrent.CompletableFuture.supplyAsync; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import org.apache.ignite.internal.logger.IgniteLogger; +import org.apache.ignite.internal.logger.Loggers; +import org.apache.ignite.internal.network.configuration.FileTransferConfiguration; +import org.apache.ignite.internal.network.file.exception.FileHandlerNotFoundException; +import org.apache.ignite.internal.network.file.exception.FileProviderNotFoundException; +import org.apache.ignite.internal.network.file.exception.FileTransferException; +import org.apache.ignite.internal.network.file.messages.FileChunkMessage; +import org.apache.ignite.internal.network.file.messages.FileDownloadRequest; +import org.apache.ignite.internal.network.file.messages.FileDownloadResponse; +import org.apache.ignite.internal.network.file.messages.FileHeaderMessage; +import org.apache.ignite.internal.network.file.messages.FileTransferErrorMessage; +import org.apache.ignite.internal.network.file.messages.FileTransferFactory; +import org.apache.ignite.internal.network.file.messages.FileTransferInfoMessage; +import org.apache.ignite.internal.network.file.messages.FileTransferMessageType; +import org.apache.ignite.internal.network.file.messages.FileUploadRequest; +import org.apache.ignite.internal.network.file.messages.FileUploadResponse; +import org.apache.ignite.internal.network.file.messages.Metadata; +import org.apache.ignite.internal.util.ExceptionUtils; +import org.apache.ignite.internal.util.FilesUtils; +import org.apache.ignite.internal.util.IgniteUtils; +import org.apache.ignite.network.ChannelType; +import org.apache.ignite.network.ClusterNode; +import org.apache.ignite.network.MessagingService; +import org.apache.ignite.network.TopologyEventHandler; +import org.apache.ignite.network.TopologyService; +import org.apache.ignite.network.annotations.Transferable; +import org.jetbrains.annotations.TestOnly; + +/** + * Implementation of {@link FileTransferService}. + */ +public class FileTransferServiceImpl implements FileTransferService { + private static final IgniteLogger LOG = Loggers.forClass(FileTransferServiceImpl.class); + + private static final ChannelType FILE_TRANSFERRING_CHANNEL = ChannelType.register((short) 1, "FileTransferring"); + + private static final long RESPONSE_TIMEOUT = 10_000; + + /** + * Topology service. + */ + private final TopologyService topologyService; + /** + * Cluster service. + */ + private final MessagingService messagingService; + + /** + * Temporary directory for saving files. + */ + private final Path tempDirectory; + + /** + * File sender. + */ + private final FileSender fileSender; + + /** + * File receiver. + */ + private final FileReceiver fileReceiver; + + /** + * Map of file providers. + */ + private final Map<Short, FileProvider<Metadata>> metadataToProvider = new ConcurrentHashMap<>(); + + /** + * Map of file handlers. + */ + private final Map<Short, FileConsumer<Metadata>> metadataToHandler = new ConcurrentHashMap<>(); + + /** + * File transfer factory. + */ + private final FileTransferFactory factory = new FileTransferFactory(); + + /** + * Constructor. + * + * @param messagingService Messaging service. + * @param tempDirectory Temporary directory. + */ + public FileTransferServiceImpl( + String nodeName, + TopologyService topologyService, + MessagingService messagingService, + FileTransferConfiguration configuration, + Path tempDirectory + ) { + this( + topologyService, + messagingService, + tempDirectory, + new FileSender( + nodeName, + configuration.value().senderThreadPoolSize(), + configuration.value().chunkSize(), + new RateLimiter(configuration.value().maxConcurrentRequests()), + (recipientConsistentId, message) -> messagingService.send(recipientConsistentId, FILE_TRANSFERRING_CHANNEL, + message) + ), + new FileReceiver(nodeName, configuration.value().receiverThreadPoolSize()) + ); + } + + @TestOnly + FileTransferServiceImpl( + TopologyService topologyService, + MessagingService messagingService, + Path tempDirectory, + FileSender fileSender, + FileReceiver fileReceiver + ) { + this.topologyService = topologyService; + this.messagingService = messagingService; + this.tempDirectory = tempDirectory; + this.fileSender = fileSender; + this.fileReceiver = fileReceiver; + } + + @Override + public void start() { + topologyService.addEventHandler(new TopologyEventHandler() { + @Override + public void onDisappeared(ClusterNode member) { + fileReceiver.cancelTransfersFromSender(member.id()); + } + }); + + messagingService.addMessageHandler(FileTransferMessageType.class, + (message, senderConsistentId, correlationId) -> { + if (message instanceof FileDownloadRequest) { + processDownloadRequest((FileDownloadRequest) message, senderConsistentId, correlationId); + } else if (message instanceof FileUploadRequest) { + processUploadRequest((FileUploadRequest) message, senderConsistentId, correlationId); + } else if (message instanceof FileTransferErrorMessage) { + processFileTransferErrorMessage((FileTransferErrorMessage) message); + } else if (message instanceof FileTransferInfoMessage) { + processFileTransferInfo((FileTransferInfoMessage) message); + } else if (message instanceof FileHeaderMessage) { + processFileHeader((FileHeaderMessage) message); + } else if (message instanceof FileChunkMessage) { + processFileChunk((FileChunkMessage) message); + } else { + LOG.error("Unexpected message received: {}", message); + } + }); + } + + private void processFileTransferErrorMessage(FileTransferErrorMessage message) { + fileReceiver.receiveFileTransferErrorMessage(message); + } + + private void processUploadRequest(FileUploadRequest message, String senderConsistentId, long correlationId) { + completedFuture(UUID.randomUUID()) + .thenCompose(transferId -> { + Path directory = createTransferDirectory(transferId); + FileTransferMessagesHandler handler = fileReceiver.registerTransfer( + senderConsistentId, + transferId, + directory + ); + FileUploadResponse response = factory.fileUploadResponse() + .transferId(transferId) + .build(); + Metadata metadata = message.metadata(); + return messagingService.respond(senderConsistentId, FILE_TRANSFERRING_CHANNEL, response, correlationId) + .thenCompose(ignored -> { + return handler.result() + .thenCompose(files -> getFileHandler(metadata).handleUpload(metadata, files)); + }) + .whenComplete((v, e) -> { + if (e != null) { + LOG.error( + "Failed to handle file upload. Transfer ID: {}. Metadata: {}. Exception: {}", + transferId, + metadata, + e + ); + } + deleteDirectoryIfExists(directory); + }); + }); + } + + private void processDownloadRequest(FileDownloadRequest message, String senderConsistentId, Long correlationId) { + supplyAsync(() -> getFileProvider(message.metadata())) + .thenCompose(provider -> provider.files(message.metadata())) + .whenComplete((files, e) -> { + if (e != null) { + LOG.error("Failed to get files for download. Metadata: {}", message.metadata(), e); + FileDownloadResponse response = factory.fileDownloadResponse() + .error(unwrapFileTransferException(e).getMessage()) + .build(); + messagingService.respond(senderConsistentId, FILE_TRANSFERRING_CHANNEL, response, correlationId); + } else if (files.isEmpty()) { + LOG.warn("No files to download. Metadata: {}", message.metadata()); + FileDownloadResponse response = factory.fileDownloadResponse() + .error("No files to download") + .build(); + messagingService.respond(senderConsistentId, FILE_TRANSFERRING_CHANNEL, response, correlationId); + } else { + FileDownloadResponse response = factory.fileDownloadResponse().build(); + messagingService.respond(senderConsistentId, FILE_TRANSFERRING_CHANNEL, response, correlationId) + .thenCompose(v -> sendFiles(senderConsistentId, message.transferId(), files)); + } + }); + } + + private CompletableFuture<Void> sendFiles(String recipientConsistentId, UUID transferId, List<File> files) { + return fileSender.send(recipientConsistentId, transferId, files) + .whenComplete((v, e) -> { + if (e != null) { + LOG.error("Failed to send files to node: {}, transfer id: {}. Exception: {}", + recipientConsistentId, + transferId, + e + ); + FileTransferErrorMessage message = factory.fileTransferErrorMessage() + .transferId(transferId) + .error(unwrapFileTransferException(e).getMessage()) + .build(); + messagingService.send(recipientConsistentId, FILE_TRANSFERRING_CHANNEL, message); + } + }); + } + + private void processFileTransferInfo(FileTransferInfoMessage info) { + fileReceiver.receiveFileTransferInfo(info); + } + + private void processFileHeader(FileHeaderMessage header) { + fileReceiver.receiveFileHeader(header); + } + + private void processFileChunk(FileChunkMessage fileChunk) { + fileReceiver.receiveFileChunk(fileChunk); + } + + @Override + public void stop() throws Exception { + IgniteUtils.closeAllManually(fileSender, fileReceiver); + } + + @Override + public <M extends Metadata> void addFileProvider( + Class<M> metadata, + FileProvider<M> provider + ) { + metadataToProvider.compute( + getMessageType(metadata), + (k, v) -> { + if (v != null) { + throw new IllegalArgumentException("File provider for metadata " + metadata.getName() + " already exists"); + } + return (FileProvider<Metadata>) provider; + } + ); + } + + @Override + public <M extends Metadata> void addFileHandler( + Class<M> metadata, + FileConsumer<M> handler + ) { + metadataToHandler.compute( + getMessageType(metadata), + (k, v) -> { + if (v != null) { + throw new IllegalArgumentException("File handler for metadata " + metadata.getName() + " already exists"); + } + return (FileConsumer<Metadata>) handler; + } + ); + } + + @Override + public CompletableFuture<List<File>> download(String nodeConsistentId, Metadata metadata) { + return completedFuture(UUID.randomUUID()) + .thenApply(transferId -> factory.fileDownloadRequest() + .transferId(transferId) + .metadata(metadata) + .build()) + .thenCompose(message -> { + Path directory = createTransferDirectory(message.transferId()); + FileTransferMessagesHandler handler = fileReceiver.registerTransfer(nodeConsistentId, message.transferId(), directory); + return messagingService.invoke(nodeConsistentId, FILE_TRANSFERRING_CHANNEL, message, + RESPONSE_TIMEOUT) + .thenApply(FileDownloadResponse.class::cast) + .thenCompose(response -> { + if (response.error() != null) { + return failedFuture(new FileTransferException(response.error())); + } else { + return handler.result(); + } + }); + }); + } + + @Override + public CompletableFuture<Void> upload(String nodeConsistentId, Metadata metadata) { + return supplyAsync(() -> getFileProvider(metadata)) + .thenCompose(provider -> provider.files(metadata)) + .thenCompose(files -> { + FileUploadRequest message = factory.fileUploadRequest() + .metadata(metadata) + .build(); + + if (files.isEmpty()) { + return failedFuture(new FileTransferException("No files to upload")); + } else { + return messagingService.invoke(nodeConsistentId, FILE_TRANSFERRING_CHANNEL, message, RESPONSE_TIMEOUT) + .thenApply(FileUploadResponse.class::cast) + .thenCompose(response -> sendFiles(nodeConsistentId, response.transferId(), files)); + } + }); + } + + private static short getMessageType(Class<?> metadata) { Review Comment: We do the same thing when registering `NetworkMessageHandler` (`org.apache.ignite.network.AbstractMessagingService#addMessageHandler`). The problem with numeric message types is we can't validate them at all. -- 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]
