Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Allow sending CHANNEL_EOF message when ChannelOutputStream is closed #554

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Allow sending CHANNEL_EOF message when ChannelOutputStream is closed #554

wants to merge 1 commit into from

Conversation

@jpstotz
Copy link
Contributor

@jpstotz jpstotz commented Jan 22, 2020 •
edited
Loading

As discussed in #553 it is sometimes necessary to send an CHANNEL_EOF message while in other situation it is redundant.

Therefore the best solution in my opinion is to let the programmer choose if to send the CHANNEL_EOF message or not. Until now sending such a message requires some ugly hacks using reflection which is really bad. Therefore I implemented a new property that allows to enable sending an CHANNEL_EOF message when close() is called.

It is designed to be used in this way:

final Command cmd = session.exec("cat");
ChannelOutputStream out = (ChannelOutputStream) cmd.getOutputStream();
out.setSignalCloseToRemote(true);
out.write(data);
out.close();

Note: I did not provide any additional unit tests as it is pretty complicated to write unit test that uses this feature and works on all common platforms (Linux, Window,s OSX, ...) as it requires an command to be executed that waits for stdin like cat or tar x. However not all platforms provide these commands by default, therefore the test would fail on at least one platform.

@codecov-io
Copy link

codecov-io commented Jan 22, 2020 •
edited
Loading

Codecov Report

Merging #554 into master will decrease coverage by 0.03%.
The diff coverage is 16.66%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #554      +/-   ##
============================================
- Coverage     56.37%   56.34%   -0.04%     
  Complexity     1239     1239              
============================================
  Files           195      195              
  Lines          7904     7910       +6     
  Branches        722      723       +1     
============================================
+ Hits           4456     4457       +1     
- Misses         3097     3101       +4     
- Partials        351      352       +1
Impacted Files Coverage Δ Complexity Δ
...z/sshj/connection/channel/ChannelOutputStream.java 73.17% <16.66%> (-4.47%) 9 <0> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d10a33e...40a7ef0. Read the comment docs.

@jpstotz jpstotz changed the title new method for sending CHANNEL_EOF message Allow sending CHANNEL_EOF message when ChannelOutputStream is closed Jan 23, 2020
@jpstotz
Copy link
Contributor Author

jpstotz commented Jan 23, 2020

@hierynomus from my perspective this PR is now ready - feel free to comment or to criticize it.

As I wrote in my first post I don't see a good way to increase the code coverage because of the problems providing a platform independent unit test for this scenario.

@jpstotz
Copy link
Contributor Author

jpstotz commented Jan 28, 2020

If I understand it correctly also bug #496 is also about the inability to send the CHANNEL_EOF when the OutputStream is closed. Therefore by applying this PR this would make it possible "fix" this issue, too.

@hierynomus
Copy link
Owner

@jpstotz I'm hesitant to merge this in, as I think the reason I commented it out is that there is a race condition with closing sometimes. I would rather always send the EOF on the channel, which is allowed according to the spec. See in #143 for when this got commented out.

@jpstotz
Copy link
Contributor Author

jpstotz commented Apr 27, 2020

I am not sure what you mean with "race condition". The log of #143 does not contain many detailed error description. To me it is just a bunch of messages with works, works not, works again, works not...

The only detailed description is your post - but if I understand it correctly this error happened when the "line" was commented out - which means that no EOF was send, correct?

So the main question remains: Do you see the chance for a general solution?

Because otherwise this workaround would at least to allow users to send EOF manually and therefore enable a lot of functionality which is currently unusable.

@jpstotz jpstotz mentioned this pull request Sep 7, 2021
Closed
hierynomus added a commit that referenced this pull request Sep 27, 2021
@hierynomus
Send EOF on channel Close (Fixes #143, #496, #553, #554)
eb09a16 
Signed-off-by: Jeroen van Erp <[email protected]>
@hierynomus
Copy link
Owner

I've run a small test connecting 1000 times and doing a command. I've decided to re-implement the fix in #143 unconditionally, and if there is a new bug, we'll have a look at it. So this PR can be closed I think.

@hierynomus hierynomus closed this Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jpstotz @codecov-io @hierynomus