[BUG] Missing critical env var from `Internal/System/Run shell path`

[fritz-fritz]

Make sure you're on the latest stable or beta build

• I have tested this on the latest stable or beta release

Is this a bug in companion itself or a module?

• I believe this to be a bug in companion and not a specific module

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

With the update to v4.2.0 there was a bugfix note of limit env vars passed to modules. This broke some of my buttons that launched GUI applications with the following log message:

25.12.22 00:45:13 Internal/System: Shell command failed. Guru meditation:
{
  "code": 134,
  "killed": false,
  "signal": null,
  "cmd": "obs",
  "stdout": "",
  "stderr": "Detected locale \"C\" with character encoding \"ANSI_X3.4-1968\", which is not UTF-8.
                 Qt depends on a UTF-8 locale, and has switched to \"C.UTF-8\" instead.
                 If this causes problems, reconfigure your locale. See the locale(1) manual
                 for more information.
                 qt.qpa.xcb: could not connect to display 
                 qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin.
                 qt.qpa.plugin: Could not load the Qt platform plugin \"xcb\" in \"\" even though it was found.
                 This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.

                 Available platform plugins are: vnc, wayland, offscreen, minimal, vkkhrdisplay, xcb, linuxfb, eglfs, wayland-egl, minimalegl.

                 Aborted (core dumped)
                 "
}

Steps To Reproduce

1. Add a new press action to a button
2. Select internal > System: Run shell path (local)
3. Enter a path to a graphical application under path
4. Press button

Expected Behavior

Previously, the configured application would be launched without issue but due to the restricted environment variables it is now failing. I expect the application to be launched.

Environment (please complete the following information)

- OS: Linux x86_64 KDE Plasma 6.5.4 Wayland
- Companion Version: v4.2.0

Additional context

After testing it seems companion is only passing:

HOME=/home/user
XDG_RUNTIME_DIR=/run/user/1000
PWD=/usr/local/bin/companion-x64/resources

A recommended fix would be to also pass XDG_SESSION_TYPE as adding that to the path before the application seems to resolve the problem for me on a wayland desktop.

[fritz-fritz]

Environmental variables worthy of consideration:

Display and Session:

    XDG_SESSION_TYPE - Indicates the session type (wayland/x11)
    WAYLAND_DISPLAY - Wayland socket name (e.g., wayland-0)
    DISPLAY - X11/XWayland display socket (e.g., :0)
    XAUTHORITY - X11 authentication file path
    DBUS_SESSION_BUS_ADDRESS - D-Bus session bus socket

For Qt Applications (like OBS):

    QT_QPA_PLATFORM - Qt platform selection (wayland/xcb)

Additional Recommended Variables:

    PATH - System executable paths
    LANG, LC_ALL - Locale settings

I can understand wanting to limit the number of environmental variables passed to modules, but the internal shell execution should likely have the above environmental variables or have the old behavior restored.

An example is to launch Spotify from a button:
XDG_SESSION_TYPE=wayland DBUS_SESSION_BUS_ADDRESS="unix:path=/run/user/$(id -u)/bus" /usr/bin/spotify --disable-gpu %u &

[Danie10]

I'm still trying to diagnose mine but on v4.2.1 I'm having a similar issue with numerous of my Internal/System/Run shell not working on Linux. Many such actions run my software updates from a terminal, run bash scripts to display status of things I'm monitoring, launch apps with gtk-launch etc. I'm just trying to pinpoint the pattern as the log is a mass of errors now.

[Danie10]

It looks like mine is related to the same issue here. It has totally broken all my Run shell path (local) commands relating to these functions:

1. gtk-launch to open apps e.g. gtk-launch org.kde.kcalc
2. bash scrips - where I have a lot of triggers running to check conditions etc

I'm seeing errors like this:

25.12.22 17:44:51 Controls/ControlTypes/Triggers/trigger:rci4rJeMh0_3ZoToKfolz: Execute Get Firewall Temp
25.12.22 17:44:51 Internal/System: Shell command failed. Guru meditation: {"code":127,"killed":false,"signal":null,"cmd":"opnsensetemp.sh","stdout":"","stderr":"/bin/sh: line 1: opnsensetemp.sh: command not found\n"}

The one above was supposed to run my bash script file and return the firewall temp. It is not an OS issue because if I run that bash script from the terminal, it still returns the temp as e.g. 48.

The only thing working for me is the ydotool command under Run shell path (local). That still executes the various keystrokes fine as far as I can see. For example this works fine still ydotool key 125:1 52:1 52:0 125:0.

So I can't figure out quite why this is happening. I did check the changelog, and did not see any breaking changes regarding syntax that we must update?