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

Convert raw command line arguments to --file-uri and --folder-uri #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions code.sh
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,24 @@ copy_arg_with_parameter() {
copy_arg
fi
}
add_file_or_folder_arg() {
# For remote files, vscode uses patterns based on the filename. (Trailing slash: folder,
# contains a dot: file). To emulate the more accurate handling in the local case,
# check the file type and pass in in --file-uri or --folder-uri.
# See doResolveFilePath(), doResolvePathRemote() in:
# https://github.com/microsoft/vscode/blob/main/src/vs/platform/windows/electron-main/windowsMainService.ts
# vscode accepts URIs with non-ascii in them, so we only need to escape a few things (%#?)

escaped=$(sed 's/%/@TVSC_PERCENT@/g; s/#/%23/g; s/\?/%3F/g; s/@TVSC_PERCENT@/%25/g' <<<"$1")
# Don't have the container name yet, will substitute that in later
uri=vscode-remote://@TVSC_AUTHORITY@$escaped

if [ -d "$1" ] ; then
new_args+=(--folder-uri "$uri")
else
new_args+=(--file-uri "$uri")
fi
}

toolbox_reset_configuration=false
# Because 'code' without any arguments opens the last workspace in the
Expand Down Expand Up @@ -195,18 +213,19 @@ while [ "$arg_index" -lt "${#args[@]}" ] ; do
# absolute_paths
/*)
add_new_window=false
copy_arg
add_file_or_folder_arg "$arg"
next_arg
;;
# Special case relative path .
.)
add_new_window=false
new_args+=("$PWD")
add_file_or_folder_arg "$PWD"
next_arg
;;
# Other relative paths
*)
add_new_window=false
new_args+=("$PWD/$arg")
add_file_or_folder_arg "$PWD/$arg"
next_arg
;;
esac
Expand All @@ -221,6 +240,12 @@ flatpak="flatpak-spawn --host flatpak"
container_name="$(. /run/.containerenv && echo "$name")"
container_name_encoded=$(echo -n "$container_name" | od -t x1 -A none -v | tr -d ' \n')

### Go back and fix up the arguments to have the container name in them, if needed

for (( i=0; i < ${#new_args[@]}; i++ )) ; do
new_args[$i]=${new_args[$i]/@TVSC_AUTHORITY@/attached-container+$container_name_encoded}
done

### Make sure that we have the Visual Studio Code Flatpak installed

verbose "Checking if Visual Studio Code Flatpak is installed"
Expand Down
19 changes: 15 additions & 4 deletions tests/test-arg-parsing.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ mock_arg_parsing() {
}

ENCODED_REMOTE=746f6f6c626f782d7673636f64652d74657374
URI_PREFIX=vscode-remote://attached-container+$ENCODED_REMOTE

assert_args() {
tail -n 1 /logs/arg_parsing.cmd > /logs/arg_parsing.cmd.last
Expand All @@ -14,17 +15,27 @@ EOF
}

test_arg_parsing() {
mkdir MyProject

code
assert_args --new-window

code .
assert_args /home/testuser
assert_args --folder-uri "$URI_PREFIX/home/testuser"

code MyProject
assert_args /home/testuser/MyProject
assert_args --folder-uri "$URI_PREFIX/home/testuser/MyProject"

code /home/testuser/MyProject
assert_args --folder-uri "$URI_PREFIX/home/testuser/MyProject"

# Anything that isn't an existing folder should be treated as a file
code /home/testuser/somefile.py
assert_args --file-uri "$URI_PREFIX/home/testuser/somefile.py"

code /MyProject
assert_args /MyProject
# Test escaping
code /home/testuser/"%#?.py"
assert_args --file-uri "$URI_PREFIX/home/testuser/%25%23%3F.py"

code --file-uri=file:///home/testuser
assert_args --file-uri=file:///home/testuser
Expand Down
12 changes: 7 additions & 5 deletions tests/test-basic.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ test_basic() {
cd ~/project || exit 1
code --toolbox-verbose .

assert_contents /logs/basic.cmd <<'EOF'
AUTHORITY=attached-container+746f6f6c626f782d7673636f64652d74657374
assert_contents /logs/basic.cmd <<EOF
flatpak list --app --columns=application
podman inspect toolbox-vscode-test --format={{ range .Config.Env }}{{ println . }}{{ end }}
flatpak ps --columns=instance,application,pid
flatpak run com.visualstudio.code --remote attached-container+746f6f6c626f782d7673636f64652d74657374 /home/testuser/project
flatpak run com.visualstudio.code --remote $AUTHORITY --folder-uri vscode-remote://$AUTHORITY/home/testuser/project
EOF

assert_contents /home/testuser/.var/app/com.visualstudio.code/config/Code/User/settings.json <<'EOF'
Expand Down Expand Up @@ -67,13 +68,14 @@ test_installation() {
cd ~/project || exit 1
yes | code --toolbox-verbose .

assert_contents /logs/installation.cmd <<'EOF'
AUTHORITY=attached-container+746f6f6c626f782d7673636f64652d74657374
assert_contents /logs/installation.cmd <<EOF
flatpak list --app --columns=application
flatpak remotes --columns=name
flatpak install flathub com.visualstudio.code
podman inspect toolbox-vscode-test --format={{ range .Config.Env }}{{ println . }}{{ end }}
flatpak ps --columns=instance,application,pid
flatpak run com.visualstudio.code --remote attached-container+746f6f6c626f782d7673636f64652d74657374 /home/testuser/project
flatpak run com.visualstudio.code --remote $AUTHORITY --folder-uri vscode-remote://$AUTHORITY/home/testuser/project
EOF
}

Expand Down Expand Up @@ -119,6 +121,6 @@ flatpak enter 123456 sh -c
ELECTRON_RUN_AS_NODE=1 \
PATH="${PATH}:$XDG_CONFIG_HOME/node_modules/bin" \
exec "$@"
/home/testuser/project /home/testuser /app/extra/vscode/code /app/extra/vscode/resources/app/out/cli.js --ms-enable-electron-run-as-node --extensions-dir=/home/testuser/.var/app/com.visualstudio.code/data/vscode/extensions --remote attached-container+746f6f6c626f782d7673636f64652d74657374 /home/testuser/project
/home/testuser/project /home/testuser /app/extra/vscode/code /app/extra/vscode/resources/app/out/cli.js --ms-enable-electron-run-as-node --extensions-dir=/home/testuser/.var/app/com.visualstudio.code/data/vscode/extensions --remote attached-container+746f6f6c626f782d7673636f64652d74657374 --folder-uri vscode-remote://attached-container+746f6f6c626f782d7673636f64652d74657374/home/testuser/project
EOF
}