Skip to content

GH-3827: Fix RemoteFile GET STREAM session leak #3853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2022
Merged

GH-3827: Fix RemoteFile GET STREAM session leak #3853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...rg/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2021 the original author or authors.
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -673,6 +673,7 @@ private Object doGet(final Message<?> requestMessage) {
.setHeader(IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE, session);
}
catch (IOException e) {
session.close();
throw new MessageHandlingException(requestMessage,
"Error handling message in the [" + this
+ "]. Failed to get the remote file [" + remoteFilePath + "] as a stream", e);
Expand Down
8 changes: 7 additions & 1 deletion ...st/java/org/springframework/integration/sftp/outbound/SftpServerOutboundTests-context.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,13 @@
auto-create-directory="true"
remote-file-separator="/" />

<int-sftp:outbound-gateway session-factory="sftpSessionFactory"
<bean id="cachingSessionFactory" class="org.springframework.integration.file.remote.session.CachingSessionFactory">
<constructor-arg name="sessionFactory" ref="sftpSessionFactory"/>
<constructor-arg name="sessionCacheSize" value="1"/>
<property name="sessionWaitTimeout" value="100"/>
</bean>

<int-sftp:outbound-gateway session-factory="cachingSessionFactory"
request-channel="inboundGetStream"
command="get"
command-options="-stream"
Expand Down
16 changes: 13 additions & 3 deletions .../src/test/java/org/springframework/integration/sftp/outbound/SftpServerOutboundTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
import org.springframework.integration.test.util.TestUtils;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.MessageHandlingException;
import org.springframework.messaging.MessagingException;
import org.springframework.messaging.PollableChannel;
import org.springframework.messaging.support.GenericMessage;
Expand Down Expand Up @@ -273,7 +274,7 @@ public void testInt3172LocalDirectoryExpressionMGETRecursive() throws IOExceptio

@Test
@SuppressWarnings("unchecked")
void testLSRecursive() throws IOException {
void testLSRecursive() {
String dir = "sftpSource/";
this.inboundLSRecursive.send(new GenericMessage<Object>(dir));
Message<?> result = this.output.receive(1000);
Expand All @@ -291,7 +292,7 @@ void testLSRecursive() throws IOException {

@Test
@SuppressWarnings("unchecked")
void testLSRecursiveALL() throws IOException {
void testLSRecursiveALL() {
String dir = "sftpSource/";
this.inboundLSRecursiveALL.send(new GenericMessage<Object>(dir));
Message<?> result = this.output.receive(1000);
Expand Down Expand Up @@ -481,7 +482,7 @@ public void testInt3088MPutNotRecursive() throws Exception {
while (output.receive(0) != null) {
// drain
}
this.inboundMPut.send(new GenericMessage<File>(getSourceLocalDirectory()));
this.inboundMPut.send(new GenericMessage<>(getSourceLocalDirectory()));
@SuppressWarnings("unchecked")
Message<List<String>> out = (Message<List<String>>) this.output.receive(1000);
assertThat(out).isNotNull();
Expand Down Expand Up @@ -655,6 +656,15 @@ public void testStream() {
.containsEntry(FileHeaders.REMOTE_DIRECTORY, "sftpSource/")
.containsEntry(FileHeaders.REMOTE_FILE, " sftpSource1.txt");
verify(session).close();

assertThatExceptionOfType(MessageHandlingException.class)
.isThrownBy(() -> this.inboundGetStream.send(new GenericMessage<>(dir + "doesNotExist.txt")))
.withStackTraceContaining("No such file or directory");

// No leak for not closed session after the previous failure
assertThatExceptionOfType(MessageHandlingException.class)
.isThrownBy(() -> this.inboundGetStream.send(new GenericMessage<>(dir + "doesNotExist.txt")))
.withStackTraceContaining("No such file or directory");
}

@Test
Expand Down