Skip to content

Unexpected stdout chars on neovim job api with pty enabled. #182

@supermomonga

Description

@supermomonga

Describe the bug

When attempting to start the devcontainer using the :RemoteStart command, an error occurs at the point where the provider tries to execute the devpod command using the executor and then decode the resulting stdout as JSON.

CleanShot 2024-11-19 at 12 38 16

I noticed that unexpected characters were mixed into stdout. As an experiment, I modified the implementation of executor.lua and disabled the pty option on Neovim's job API (vim.fn.jobstart()). By doing so, this error with stdout disappeared.

To reproduce

Minimal steps for reproduce:

vim.fn.jobstart without pty option

  1. Run neovim without any config using nvim -u NONE.
  2. Run :lua vim.fn.jobstart('devpod version', { pty = false, on_stdout = function(_, data, _) vim.api.nvim_echo({data}, true, {}) end })
  3. Run :mes to show echo history

CleanShot 2024-11-19 at 12 33 24

vim.fn.jobstart with pty option

  1. Run neovim without any config using nvim -u NONE.
  2. Run :lua vim.fn.jobstart('devpod version', { pty = true, on_stdout = function(_, data, _) vim.api.nvim_echo({data}, true, {}) end })
  3. Run :mes to show echo history

CleanShot 2024-11-19 at 12 32 18

Expected behavior

:RemoteStart will not fail to parse stdout

Screenshot/Screencast(s)

Please see above description and reproduce steps.

System information

  • Your local OS: macOS 13.6.9
  • CPU model: Apple M2 (Apple Silicon)
  • Local Neovim version: v0.10.2
  • Remote host OS (if applicable): none
  • Remote Neovim version (if applicable): none
  • devpod cli version: v0.6.1

Additional context

I'm using macOS's default terminal app and default shell (zsh).

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions