Incompatible CLI changes between 26.0.16 and 26.2.8

[onavratil-monetplus]

Preflight Checklist

• [ X] I agree to follow the Code of Conduct that this project adheres to.
• [ X] I have searched the issue tracker for a feature request that matches the one I want to file, without success.

Describe the bug
I use the app in docker, headless mode with Xvfb, to build documentation with sphinx. The total command stack looks something like

/usr/bin/drawio --export --crop --page-index 0 --scale 1.0 --format svg --output /docs/output/.doctrees/drawio/c915ddac49c942e7c986f22a0b75bd9fb55460f7/test.svg /docs/test.drawio --enable-logging --no-sandbox

This is completely OK in version 26.0.16 and produces the exported file.

However, in the latest builds, this falls on some CLI argument validation. Note that I need to pass a few extra parameters to prevent Electron errors.

To Reproduce

Install .deb and Xvfb in a dockerized environment. I use sphinx image as base.

docker run -it --rm sphinxdoc/sphinx:latest /bin/bash
apt-get update
apt -y install libgbm1 libasound2 xvfb wget
wget --no-check-certificate "https://github.com/jgraph/drawio-desktop/releases/download/v26.2.2/drawio-amd64-26.2.2.deb" -O drawio.deb
apt -y install "./drawio.deb"
ln -s /opt/drawio /opt/draw.io

#Run xvfb
Xvfb :99 -screen 0 1024x768x16 &
export DISPLAY=:99

# Now try the command
/usr/bin/drawio --export --crop --page-index 0 --scale 1.0 --format svg --output /docs/output/.doctrees/drawio/c915ddac49c942e7c986f22a0b75bd9fb55460f7/test.svg /docs/test.drawio --enable-logging --no-sandbox
# This ends with error - expected 1 argument but got 3

# Try downgrading the package to 26.0.16
wget --no-check-certificate "https://github.com/jgraph/drawio-desktop/releases/download/v26.0.16/drawio-amd64-26.0.16.deb" -O drawio.deb
apt -y install "./drawio.deb" --allow-downgrades

# The same command
/usr/bin/drawio --export --crop --page-index 0 --scale 1.0 --format svg --output /docs/output/.doctrees/drawio/c915ddac49c942e7c986f22a0b75bd9fb55460f7/test.svg /docs/test.drawio --enable-logging --no-sandbox

Now it exits with another error - Error: input file/directory not found - but if it existed, it would work flawlessly. I can work it out from there, but I cannot pass CLI argument validation in the newer versions.

The point is, something must have changed in the CLI argument validation, which rendered otherwise working setups useless.

Expected behavior
CLI commands that worked in previous versions of the same majors will, with regards to backwards compatibility, remain functional.

Desktop (please complete the following information):

• Linux containerized

[KHKnobl]

The issue also happens when you use the sphinxcontrib-drawio in an other than the docker headless environment.
When I remove the extra arguments at the end of the command line it works.
(--enable-logging --no-sandbox)

You can reach this with following defines in your sphinx conf file.

#drawio_no_sandbox = True
drawio_disable_verbose_electron = True

I can't find these two arguments in the help of drawio and assume they are passed to Electron in former versions. 26.1.1 works, 26.2.2 failed on my side.

[onavratil-monetplus]

Hi @KHKnobl, thanks for the hint. I tried to work out a solution excluding the said parameters, but I ran into more problems.

I cannot easily achieve that since I run the container as a root user. And in such settings electron exits with error if the --no-sandbox parameter is not passed. There is no way (AFAIK) to pass that option bypassing drawio, and there is no option to pass it through drawio either.

I tried to make the container non-root, but after having to sort out a bunch of further issues (such as dynamically chown-ing mounted volumes and switching users on container startup) I still ran into further problems with drawio

49256@89cb36f4b1e4:/docs$ /usr/bin/drawio --export --crop --page-index 0 --scale 1.0 --format svg --output /docs/output/.doctrees/drawio/c915ddac49c942e7c986f22a0b75bd9fb55460f7/test.svg /docs/test.drawio
Failed to move to new namespace: PID namespaces supported, Network namespace supported, but failed: errno = Operation not permitted
[14:0414/103005.570049:FATAL:zygote_host_impl_linux.cc(211)] Check failed: . : Invalid argument (22)

I kind of found a workaround, but it requires my docker container to be ran either with --privileged option, or with --cap-add=SYS_ADMIN which kind of beats the whole purpose of non-root container. And moreover, I cannot require users of the image to pass these "obscure" arguments.

[KHKnobl]

Thanks @onavratil-monetplus for the feedback.

I was not really aware about the necessity for a user in the docker container at all. My simple docker for Sphinx worked fine with root and the --no-sandbox. But this is not recommended, is it.
Now I added a user and can also reproduce the issue with the namespace.
Thanks to your hint with the --privileged I have now back a running playground for generating sphinx docu with docker.

I understand that you are not happy with this workaround for your drawio container. But maybe the drawio team will change the commandline handling back to the previous version and let us define the additional arguments again. Currently I found no solution for the proper sandbox handling in docker.
Maybe this is a hint: https://stackoverflow.com/questions/62345581/node-js-puppeteer-on-docker-no-usable-sandbox
Here people are also struggling with security. Somehow back on your solution from above.

[ccvca]

I've noticed two additional changes in the CLI interface, which I don't found in the ChangeLog.

• You must now use -o for the output file, in the past just adding the filename as the last argument works fine. Or was it silently ignored in the past? I got expected 1 argument but got 2 in my existing converter script.
• draw.io.exe' (tested on Windows) now runs in a detached shell, and the executing shell is now immediately available, like putting a &` at the end of the command in Linux. This may annoy some scripts that want to wait for the export before continuing.

[linderd]

I have the same problem with CLI argument validation when using the snap version of draw.io with Xvfb.
I always get Error: expected 1 argument but got 2 when I use my scripts which worked perfectly fine before.

[linderd]

For anybody using the snap version of drawio with xvfb a possible workaround is to revert snap back to the last version of drawio (26.1.1) and disable automatic updates until this bug is fixed. This can be done by calling these two commands:
sudo snap revert drawio
sudo snap refresh --hold drawio
When the bug is fixed automatic updates can be reactivated by calling:
sudo snap refresh --unhold drawio

edit: If you have no old version cached by snap (see snap list drawio --all) you can still go back to the old version manually, because it is not fully deleted in the snap store yet:
sudo snap download drawio --revision 241
sudo snap ack drawio_241.assert
sudo snap install drawio_241.snap
sudo snap refresh --hold drawio

[Bryan2333]

I meet the issue of command line too. In 26.1.1, I can launch drawio like drawio /path/to/drawiofile --ozone-platform-hint=auto --enable-wayland-ime. But after upgrading to 26.2.2, I always got error: too many arguments. Expected 1 argument but got 3.".

[davidjgraph]

The issue is this breaking change in commander 13.0.0, tj/commander.js#2223. We'll disable excessive args checking for now.

[davidjgraph]

Please try 26.2.15.

[linderd]

thank you it seems fixed, my old scripts are working again with 26.2.15.