ghostel should block while performing ghostel_cmd?

[ackerleytng]

I'm using b4 prep --edit-cover and with vterm, opening the file using OSC51 works as expected - when I run b4 prep --edit-cover, an emacs window pops up, allowing me to edit the text, then when I close the window, the contents is saved for b4.

I've extracted the relevant code here:

#!/usr/bin/env python3

import os
import subprocess
import tempfile
import shlex

bdata = b'foobar'

with tempfile.TemporaryDirectory(prefix='b4-editor') as temp_dir:
    temp_fpath = os.path.join(temp_dir, "COMMIT_EDITMSG")
    with open(temp_fpath, 'xb') as edit_file:
        edit_file.write(bdata)

    cmdargs = ["printf", r"\e]51;E%s\e\\", f"find-file {temp_fpath}"]
    sp = subprocess.Popen(cmdargs)
    # ghostel should block here until the file is closed
    sp.wait()

    with open(temp_fpath, 'rb') as edited_file:
        bdata = edited_file.read()

    print(bdata)

In vterm, this would have opened the emacs buffer containing "foobar", and then it would print the new edited contents at the end.

In ghostel, this doesn't open a buffer. IIUC ghostel doesn't block while handling OSC 51, so the python script goes on to just read the edited file and declare there are no changes. Emacs then starts to handle the open request and declares that it cannot find the temporary directory in *Messages*

ghostel: error calling find-file: Setting current directory: No such file or directory, /tmp/b4-editordhiklqrq/

[dakra]

Thanks. Can you try with the latest version?

[ackerleytng]

This fix didn't work for me either, I'm getting the exact same behavior as before. Looking at 3f8846c, the reproducer above doesn't have to change, right? Nothing changed on the shell injection side?

[dakra]

Hmm, I even checked the vterm source and can't see how it would work there but not in ghostel.
Is everything else the same? Do you have maybre a different $EDITOR set in vterm that b4 prep --edit-cover is using? If you set EDITOR to just emacsclient (and not your script), something that is blocking it should work, no?

[ackerleytng]

Thanks, you're right! I did have $EDITOR set to oe, a custom script which allows me to use the same command everywhere to open a file in emacs:

#!/bin/bash

if [[ "$INSIDE_EMACS" = 'vterm' ]] \
    && [[ -n ${EMACS_VTERM_PATH} ]] \
    && [[ -f ${EMACS_VTERM_PATH}/etc/emacs-vterm-bash.sh ]]; then
        source ${EMACS_VTERM_PATH}/etc/emacs-vterm-bash.sh
fi

[[ "$INSIDE_EMACS" = 'ghostel' ]] && source "$EMACS_GHOSTEL_PATH/etc/shell/ghostel.bash"

path_to_open="$(realpath --canonicalize-missing "${@:-.}")"

if [[ "$INSIDE_EMACS" = 'vterm' ]]; then
    vterm_cmd find-file "$path_to_open"
elif [[ "$INSIDE_EMACS" = 'ghostel' ]]; then
    ghostel_cmd find-file "$path_to_open"
else
    emacsclient --tty --alternate-editor='' "$path_to_open"
fi

to my surprise vterm has EDITOR set to /usr/bin/emacsclient.emacs --socket-name=/run/user/111111111/emacs/server.

When I did EDITOR=emacsclient b4 prep --edit-cover, things work as expected.

[ackerleytng]

Oh, with-editor https://github.com/magit/with-editor/blob/14ea1d98337a47d899ee1860f96b7cbb1ef0e2a0/lisp/with-editor.el#L743 was setting up the environment within emacs for me...

[dakra]

Oh, with-editor https://github.com/magit/with-editor/blob/14ea1d98337a47d899ee1860f96b7cbb1ef0e2a0/lisp/with-editor.el#L743 was setting up the environment within emacs for me...

I saw that already but with-editor has an extra branch for vterm.
I even have a local patch already but didn't create a PR just yet as ghostel is too new with not
many users.
Hopefully it gets picked up by more people, then I'll create the PR.

Closing this issue now, feel free to reopen when there's something else wrong.

[ackerleytng]

Would you mind sharing your local patch? Did you patch with-editor directly or did you do some advising or something else?

[dakra]

I just pushed magit/with-editor@a5c7aba
(This will probably not be the final commit I use for the PR, but in general that's the way to go.)
With that you can (add-hook 'ghostel-pre-spawn-hook #'with-editor-setup-environment) and it should work,
or my use-package setup:

(use-package with-editor
  :hook (((shell-mode eshell-mode term-exec) . with-editor-export-editor)
         (ghostel-pre-spawn-hook . with-editor-setup-environment)))