Skip to content
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

Properly close connection on EOF #1111

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Properly close connection on EOF #1111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bede462
Properly close connection on EOF
cabarnes Dec 21, 2021
3f179a8
Restrict channel close to SFTP instances
cabarnes Jan 5, 2022
3e96dcf
Merge remote-tracking branch 'upstream/master' into fix-disconnect
cabarnes Jan 6, 2022
de31b00
Add OpenSSH sftp test
cabarnes Jan 24, 2022
3cb7eb4
Skip integration tests on Windows
cabarnes Jan 28, 2022
ef83912
Remove sftp integration test
cabarnes Jan 31, 2022
a4a4058
Add explanation for EOF handling
cabarnes Jan 31, 2022
56299f5
Add test for client sending EOF
cabarnes Jan 31, 2022
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
8 changes: 8 additions & 0 deletions lib/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,14 @@ class Session extends EventEmitter {
state: 'open'
}
};

// This is necessary to properly terminate the connection for some
// clients (ex: OpenSSH sftp) that send EOF when requesting to close the
// connection.
this.on('eof', () => {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might include a comment here about this being necessary to properly close the connection for some SFTP clients.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment seems to be addressed

if (this._channel instanceof SFTP)
this._channel.end();
});
}
}

Expand Down
5 changes: 5 additions & 0 deletions test/test-sftp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ setup('close', mustCall((client, server) => {
}));
}));

setup('eof', mustCall((client, server) => {
client.on('close', mustCall(() => {}));
client._protocol.channelEOF(client.outgoing.id);
}));

setup('read', mustCall((client, server) => {
const expected = Buffer.from('node.jsnode.jsnode.jsnode.jsnode.jsnode.js');
const handle_ = Buffer.from('node.js');
Expand Down