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.

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

Another attempt of support pty on windows with ConPTY api #155

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

Conversation

photostorm
Copy link

@photostorm photostorm commented Jul 25, 2022

This is an another attempt to support pseudo-terminal on windows using ConPty API (should resolve issue #95)

This pull request does introduce major api change for Start method (*os.File -> Pty),

I have tested this code with remote terminal application that I wrote. It would be great to get some additional testing with other use cases.

@pete-woods
Copy link

This looks very promising, I will try it out to see if it works in our system

@pete-woods
Copy link

I just tried this out, and works perfectly for my use case (an SSH server that must work on UNIX and Windows) 👍

@mjudeikis
Copy link

Trying this now. Would be really nice if this works on go 1.18 too :) considering repo is still pointing to 1.13 :D

@pete-woods
Copy link

It worked on Go 1.18 for me

@mjudeikis
Copy link

mjudeikis commented Jul 28, 2022 via email

@pete-woods
Copy link

pete-woods commented Jul 28, 2022

@creack if you have time to look at this, it would be most appreciated, I found the API break to be extremely unintrusive (in that I didn't need to change any code)

@creack
Copy link
Owner

creack commented Jul 28, 2022 via email

@pete-woods
Copy link

minions-please

@mjudeikis
Copy link

image
Please help to remove wild forks!

@gabemarshall
Copy link

Worked for me on 1.18 and 1.17.1, thanks @photostorm 👏👏👏

@pete-woods
Copy link

@creack Is there anything we can do to help with this PR getting reviewed? Windows support is a really big deal for a bunch of users of your library.

@mohammed90
Copy link

I'm happy this PR exists. However, it introduces a breaking change: *os.File -> Pty. The func Start and StartWithAttrs return *os.File currently, but the PR changes this to type Pty.

@kr
Copy link
Collaborator

kr commented Oct 23, 2022

FWIW I agree there should be a high bar to justify incompatible changes to the interface. It's not immediately clear to me why that would be necessary to add Windows support.

@photostorm
Copy link
Author

There should be high bar to justify incompatible changes to the interface. Due to the return type of Start, I do not see a way to pass the handles. I think this API change would make it possible for other systems in future to be added.

@kr
Copy link
Collaborator

kr commented Oct 24, 2022

Would it be possible to use a Unix socket on Windows instead of a pair of pipes? Each end of a socket is full-duplex, which might mean the exported interface can be a single os.File object.

https://devblogs.microsoft.com/commandline/af_unix-comes-to-windows/

@photostorm
Copy link
Author

photostorm commented Oct 24, 2022

ok, I will look into it. Thanks for your feedback. @kr

@photostorm
Copy link
Author

@kr I do not think I can used that. there is window handle that I need access to also.

@kr
Copy link
Collaborator

kr commented Oct 26, 2022

Ultimately we will have to defer to @creack, it's his library.

My feeling is, it might be worth breaking the API, if that's absolutely necessary to support Windows. Even in that case, I think any new interface should undergo careful design review (which I could participate in).

But we haven't exhausted all the strategies to maintain compatibility. For instance, maybe the window handle could be stored on the side in a global lookup table, and the *os.File pointer or a file descriptor or something could be used to look up the window handle when it's needed.

var (
	windowHandles = map[*os.File]windows.Handle{}
	windowHandlesMu sync.Mutex
)

Choosing a suitable value to use as the map key could be tricky. The fd might not work if the client code calls dup or something. I don't have great knowledge of the Windows API and its semantics so I don't know offhand if there's a good value to use. Is there a stable way to identify a pty in Windows? Maybe something available via os.FileInfo.Sys?

Also, this would probably need to use a finalizer to delete map entries.

What do you think?

@pete-woods
Copy link

That seems like a plausible strategy to me, but without input from @creack I don't thing we can realistically progress

@sabattle
Copy link

@creack have you gotten the chance to review this PR? My team could definitely use this. At the moment we are relying on @photostorm's fork (which has worked perfectly so far)

Don't close consoleR & consoleW in Windows
@pete-woods
Copy link

Thankyou for continuing to plug away at this

@iyzyi
Copy link

iyzyi commented Apr 24, 2024

I don't mean to disrupt the discussion about this PR, but perhaps you could take a look at aiopty/pty/conpty/conpty_windows.go and aiopty/term/term_windows.go.

@kcmvp
Copy link

kcmvp commented May 20, 2024

thank you all very much for implementation tty on windows!
any update on this?

@creack
Copy link
Owner

creack commented May 22, 2024

Sorry for the delay, I have been swamped recently, I'll take a look as soon as I can.

@pidgeon777
Copy link

Great news! 👍

@creack creack self-requested a review May 30, 2024 14:11
@creack
Copy link
Owner

creack commented Jun 4, 2024

Getting an error when running the tests (go1.22.3)

.\io_test.go:33:32: cannot use int(ptmx.Fd()) (value of type int) as syscall.Handle value in argument to syscall.SetNonblock
.\io_test.go:69:32: cannot use int(ptmx.Fd()) (value of type int) as syscall.Handle value in argument to syscall.SetNonblock 

@creack
Copy link
Owner

creack commented Jun 4, 2024

When commenting out the SetDeadline section which cause the build to fail, I get test errors:

--- FAIL: TestSetsize (0.01s)e.
    doc_test.go:102: Unexpected Getsize X result after Setsize: 1 != 0.
    doc_test.go:103: Unexpected Getsize Y result after Setsize: 1 != 0.
    doc_test.go:104: Unexpected Getsize Rows result after Setsize: 2 != 1.
    doc_test.go:105: Unexpected Getsize Cols result after Setsize: 2 != 1.
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
--- FAIL: TestOpen (0.01s)
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
--- FAIL: TestGetsizeFull (0.02s)
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
--- FAIL: TestOpenByName (0.02s)
    doc_test.go:38: Failed to open tty file: open |0: The filename, directory name, or volume label syntax is incorrect..
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
--- FAIL: TestName (0.02s)
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
--- FAIL: TestGetsize (0.02s)
    helpers_test.go:24: Unexpected error from pty Close: Access is denied..
exit status 0xc0000374
FAIL    github.com/creack/pty/v2        0.357s

Running the tests as Administrator yields the same result, including Access is denied.

@photostorm
Copy link
Author

I still working on fixing invalid handle with get size, but just been busy with work.

@kareemmahlees
Copy link

Any update on this ?

abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 7, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 7, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 7, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 8, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 8, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 8, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 8, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 8, 2024
Adds Windows to the test matrix. We'll see what breaks.
For creack/pty, we need to use the currently-unmerged change in
`creack/pty#155` for Windows support.
abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 14, 2024
This adds support for using git-spice with Windows.
I'm pretty sure it already works, but testing it is a bit difficult,
especially since I don't have a Windows system to test on.

All terminal prompt use creack/pty to create a fake terminal.
Until creack/pty#155 is merged, these tests cannot be run on Windows.
We'll skip the prompt tests on Windows for the time being.
@GitMurf
Copy link

GitMurf commented Sep 15, 2024

Really waiting for this to merge so lazygit pagers will be usable for windows

jesseduffield/lazygit#1453

This is why I am here too 😢 Any updates? It seems without this, LazyGit cannot allow using a custom pager like delta for git diffing things. Would be super useful. Thanks so much for everyone's work on this!

@pidgeon777
Copy link

Hope is still high for this PR

@photostorm
Copy link
Author

I am still here. Just been busy with my work. I hope to get back to soon. If any one can help me with looking into invalid handle problem that would be great.

@wellcomez
Copy link

I am still here. Just been busy with my work. I hope to get back to soon. If any one can help me with looking into invalid handle problem that would be great.

it works fine for , thanks. @photostorm
@creack it looks ok, why not?

@creack
Copy link
Owner

creack commented Nov 8, 2024

Running the tests yield somme failures, cf my last message. @photostorm mentioned he still needs some work on this.
When I find some time myself, I’ll try to wrap it up.

@wellcomez
Copy link

Running the tests yield somme failures, cf my last message. @photostorm mentioned he still needs some work on this. When I find some time myself, I’ll try to wrap it up.

compared with *nix, I find main issue is its performace is too poor under window
@photostorm @creack

@pidgeon777
Copy link

Running the tests yield somme failures, cf my last message. @photostorm mentioned he still needs some work on this. When I find some time myself, I’ll try to wrap it up.

compared with *nix, I find main issue is its performace is too poor under window @photostorm @creack

Could you please add more details?

@wellcomez
Copy link

wellcomez commented Nov 25, 2024

Running the tests yield somme failures, cf my last message. @photostorm mentioned he still needs some work on this. When I find some time myself, I’ll try to wrap it up.

compared with *nix, I find main issue is its performace is too poor under window @photostorm @creack

Could you please add more details?

https://github.com/wellcomez/lspvi/releases/tag/v100test my project

  1. ./lspvi --gui open browser open url in browser https://localhost:13000 or 1300x
  2. ./lspvi in windows terminal (not cmd.exe)
    web is slower than terminal
  3. but under linux/macos, web mode is as fast as terminal
    @pidgeon777

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.