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

photostorm · 2022-07-25T22:54:31Z

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.

This reverts commit 2aa609e.

This reverts commit d44d7f7.

pete-woods · 2022-07-27T10:23:58Z

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

pete-woods · 2022-07-27T14:43:10Z

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

mjudeikis · 2022-07-28T15:25:32Z

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 · 2022-07-28T16:49:47Z

It worked on Go 1.18 for me

mjudeikis · 2022-07-28T16:50:52Z

It just passed our ci too. Worked like a charm too :)

…

On Thu, Jul 28, 2022, 7:49 PM Pete Woods ***@***.***> wrote: It worked on Go 1.18 for me — Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAYTREGNBTBOT5HCXFTO3ATVWK23LANCNFSM54T43GUQ> . You are receiving this because you commented.Message ID: ***@***.***>

pete-woods · 2022-07-28T16:51:31Z

@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 · 2022-07-28T16:52:56Z

I’ll take a look over the weekend. Quite a few tickets in backlog, sorry about that.

On Thu, Jul 28, 2022 at 10:51 AM Pete Woods ***@***.***> wrote: @CrEaK <https://github.com/CrEaK> 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) — Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAD7LZMFPY36MECEUL42SDDVWK3CBANCNFSM54T43GUQ> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

-- -- Guillaume J. Charmes

pete-woods · 2022-08-11T13:47:12Z

mjudeikis · 2022-08-11T13:53:06Z

Please help to remove wild forks!

gabemarshall · 2022-09-27T14:35:34Z

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

pete-woods · 2022-10-03T10:33:54Z

@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 · 2022-10-22T21:45:59Z

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 · 2022-10-23T03:14:34Z

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 · 2022-10-24T16:32:16Z

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 · 2022-10-24T18:08:19Z

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 · 2022-10-24T19:17:29Z

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

photostorm · 2022-10-26T01:19:58Z

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

kr · 2022-10-26T02:33:58Z

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 · 2023-02-01T20:11:51Z

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

sabattle · 2023-02-21T18:34:21Z

@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 · 2024-04-19T17:34:18Z

Thankyou for continuing to plug away at this

iyzyi · 2024-04-24T10:30:28Z

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 · 2024-05-20T10:47:47Z

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

creack · 2024-05-22T14:10:07Z

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

pidgeon777 · 2024-05-22T14:35:21Z

Great news! 👍

creack · 2024-06-04T23:11:38Z

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 · 2024-06-04T23:29:49Z

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 · 2024-06-04T23:34:03Z

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

kareemmahlees · 2024-06-30T14:55:00Z

Any update on this ?

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.

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 · 2024-09-15T22:16:02Z

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 · 2024-09-16T06:00:20Z

Hope is still high for this PR

photostorm · 2024-09-19T02:40:21Z

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 · 2024-11-08T07:15:09Z

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 · 2024-11-08T10:45:09Z

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 · 2024-11-11T02:10:33Z

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 · 2024-11-17T11:53:51Z

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 · 2024-11-25T09:34:45Z

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

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

photostorm and others added 6 commits July 25, 2022 17:24

new windows support

580600d

Update README.md

d44d7f7

temporary module path

2aa609e

Revert "temporary module path"

d193ef7

This reverts commit 2aa609e.

made exec cmd struct private

f40884c

Revert "Update README.md"

82ad622

This reverts commit d44d7f7.

photostorm mentioned this pull request Jul 27, 2022

Support pty on windows with ConPty api #109

Closed

5 tasks

nullishamy mentioned this pull request Aug 15, 2022

Change default terminal for custom commands jesseduffield/lazygit#1550

Open

cleanup some unused fields

0a71ca4

EldinHb mentioned this pull request Nov 6, 2022

Custom Pager support for windows jesseduffield/lazygit#1453

Open

Merge pull request #7 from HuckRidgeSW/master

871f917

Don't close consoleR & consoleW in Windows

kcmvp mentioned this pull request May 20, 2024

disable pty on windows temporarily kcmvp/gob#113

Closed

creack self-requested a review May 30, 2024 14:11

abhinav added a commit to abhinav/git-spice that referenced this pull request Sep 7, 2024

Try to test against Windows

1f684ef

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

Try to test against Windows

21fb406

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

Try to test against Windows

b80eebd

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

Try to test against Windows

23c0d40

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

Try to test against Windows

09f99dc

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

Try to test against Windows

a3ee9e0

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

Try to test against Windows

584d540

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

Try to test against Windows

431eec6

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 mentioned this pull request Sep 8, 2024

Windows support abhinav/git-spice#387

Merged

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

Are you sure you want to change the base?

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

Conversation

photostorm commented Jul 25, 2022 • edited Loading

pete-woods commented Jul 27, 2022

pete-woods commented Jul 27, 2022

mjudeikis commented Jul 28, 2022

pete-woods commented Jul 28, 2022

mjudeikis commented Jul 28, 2022 via email

pete-woods commented Jul 28, 2022 • edited Loading

creack commented Jul 28, 2022 via email

pete-woods commented Aug 11, 2022

mjudeikis commented Aug 11, 2022

gabemarshall commented Sep 27, 2022

pete-woods commented Oct 3, 2022

mohammed90 commented Oct 22, 2022

kr commented Oct 23, 2022

photostorm commented Oct 24, 2022

kr commented Oct 24, 2022

photostorm commented Oct 24, 2022 • edited Loading

photostorm commented Oct 26, 2022

kr commented Oct 26, 2022

pete-woods commented Feb 1, 2023

sabattle commented Feb 21, 2023

pete-woods commented Apr 19, 2024

iyzyi commented Apr 24, 2024

kcmvp commented May 20, 2024

creack commented May 22, 2024

pidgeon777 commented May 22, 2024

creack commented Jun 4, 2024

creack commented Jun 4, 2024 • edited Loading

photostorm commented Jun 4, 2024

kareemmahlees commented Jun 30, 2024

GitMurf commented Sep 15, 2024

pidgeon777 commented Sep 16, 2024

photostorm commented Sep 19, 2024

wellcomez commented Nov 8, 2024

creack commented Nov 8, 2024

wellcomez commented Nov 11, 2024

pidgeon777 commented Nov 17, 2024

wellcomez commented Nov 25, 2024 • edited Loading

photostorm commented Jul 25, 2022 •

edited

Loading

pete-woods commented Jul 28, 2022 •

edited

Loading

photostorm commented Oct 24, 2022 •

edited

Loading

creack commented Jun 4, 2024 •

edited

Loading

wellcomez commented Nov 25, 2024 •

edited

Loading