Inconsistent behaviour between listing and downloading the files.

[SimoneGiusso]

In what version(s) of Spring Integration are you seeing this issue?

6.2.4

Describe the bug

/ at the beginning of the remote dir path is not necessary when listing files although it is necessary to download them

To Reproduce

    @Test
    fun testFileDownload() {
        sftpTemplate.list("remote-dir").forEach { // All the files under remote-dir are listed
            log.info { it.filename }
        }

        log.info { "---- FINISHED TO LIST DIRECTORIES -----\n\n\n\n" }

        sftpTemplate.get("/remote-dir/MyFile.csv") { // remote-dir/MyFile.csv won't work
            inputStream -> inputStream.use {
                localDir.mkdir()
                FileUtils.copyInputStreamToFile(inputStream, File(localDir.absolutePath + "test.csv"))
        }}
    }

Expected behavior

sftpTemplate.get should work also with "remote-dir/MyFile.csv" as input.

See also stackOverflow question.

[artembilan]

For LIST command we do this:

		remoteDir =
				!remoteDir.isEmpty() && remoteDir.charAt(0) == '/'
						? remoteDir
						: this.sftpClient.canonicalPath(remoteDir);

For GET - do not:

	public InputStream readRaw(String source) throws IOException {
		return this.sftpClient.read(source);
	}

So, maybe this is a problem and we can try to normalize path if it does not start with /?

[SimoneGiusso]

Yes, both commands should threat the dirPath in the same way.

Here probably the GET should normalize the path as the LIST command does.

I found unexpected the fact that one command without "/" does not work while it works for the other.

[SimoneGiusso]

Additionally, in the message's header file_remoteDirectory, two '/' are present before the remote repository name

[artembilan]

@SimoneGiusso , do you mean for the SftpOutboundGateway with a Command.GET ?
Or what part of the flow you are talking about which produces the Message for you?

[artembilan]

The canonical path has been fixed.
I need more info about:

two / are present before the remote repository name

Thanks

[SimoneGiusso]

The canonical path has been fixed. I need more info about:

two / are present before the remote repository name

Thanks

If you enable the logging level to debug, you should see that file_remoteDirectory header for the message emitted contains the remote_repository path and two /.

Example:

//my_remote_repository instead of just /my_remote_repository

But's this is a minor problem.

[artembilan]

Sure! But what I have to run to follow such a debug procedure ?

[SimoneGiusso]

Sure! But what I have to run to follow such a debug procedure ?

If you run my demo in the other opened issue with this config in the application-test.yaml file:

logging:
  level:
    org.springframework.integration.*: debug

You should see logged something similar to

2024-05-08T13:33:19.407+02:00 DEBUG 35630 --- [   scheduling-1] o.s.integration.channel.DirectChannel    : postSend (sent=true) on channel 'bean 'sftpChannel'', message: GenericMessage [payload=/tmp/extractions/MyFile1_data.csv, headers={file_remoteHostPort=localhost:2222, file_name=MyFile1_data.csv, file_remoteDirectory=//deliveries, file_originalFile=/tmp/extractions/MyFile1_data.csv, id=7d1b4bd1-9452-c652-403d-6c607498e5c6, file_relativePath=MyFile1_data.csv, file_remoteFile=MyFile1_data.csv, timestamp=1715167999402}]

As you'll see file_remoteDirectory value has two '/'

[artembilan]

Thanks, @SimoneGiusso .
Unfortunately, from GitHub it is not obvious that we may talk about the same sample.
So, would be great to point there properly.
Here it is anyway: #9124 (comment)

[SimoneGiusso]

Thanks, @SimoneGiusso .

Unfortunately, from GitHub it is not obvious that we may talk about the same sample.

So, would be great to point there properly.

Here it is anyway: #9124 (comment)

Yes it is this one. Thanks

[artembilan]

Right. When I change my test for this .remoteDirectory("/sftpSource"), I indeed se double / in the file_remoteDirectory header.
Will fix shortly: #9129