fix(desktop): serve PipeWire in Desktop mode so screen capture works (#2446)

* fix(desktop): serve PipeWire in Desktop mode so screen capture works

* fix(desktop): preserve shared PipeWire lifecycle

* test(desktop): exercise shared PipeWire lifecycle

* fix(desktop): start PipeWire for bottom sessions

* fix(desktop): serialize shared PipeWire bundle preparation

Concurrent Steam and bottom Desktop starts unpacked the bundle into the
same staging directory and rewrote the access settings together. Hold an
exclusive lock around unpacking and access configuration, and cover the
race plus start success and failure environment handling in tests.

* fix(desktop): replace PipeWire access fragments atomically

Write each fragment to a temporary file and rename it so running daemons and clients never read a truncated file.

* fix(desktop): isolate runtime directories in concurrent PipeWire start test
This commit is contained in:
Kurt Himebauch authored and GitHub committed 2026-11-15 12:00:27 -05:00
1 parent 03812bb3b7
commit 9a93f59fbf
4 files changed
+159 -6

No files matched your search

+6
View File
@@ -125,9 +125,15 @@ if [ "$(cat /usr/share/droiddeck/kwin-compositor 2>/dev/null)" = opengl ]; then
chmod 755 /run/droiddeck/kwin/kwin_wayland
export PATH=/run/droiddeck/kwin:$PATH
fi
if /usr/local/bin/droiddeck-pipewire start; then
eval "$(/usr/local/bin/droiddeck-pipewire env)"
else
echo "== pipewire: not running; screen capture has no picture"
fi
echo "== droiddeck-desktop: Plasma on $WAYLAND_DISPLAY"
dbus-run-session -- startplasma-wayland
rc=$?
/usr/local/bin/droiddeck-pipewire stop
echo "== droiddeck-desktop: Plasma ended ($rc)"
if [ "$rc" -eq 0 ] && [ -z "${BL_BOTTOM_DESKTOP:-}" ]; then
/usr/local/bin/droiddeck-steam-launch bigpicture
@@ -20,9 +20,14 @@ unpack() {
{ rm -rf "$dir.new"; echo "droiddeck-pipewire: could not unpack $bundle" >&2; return 1; }
}
write_fragment() {
tmp=$1.$$
cat > "$tmp" && mv -f "$tmp" "$1" || { rm -f "$tmp"; return 1; }
}
access_config() {
mkdir -p "$dir/share/pipewire/pipewire.conf.d" "$dir/share/wireplumber/wireplumber.conf.d" || return 1
cat > "$dir/share/pipewire/pipewire.conf.d/droiddeck-access.conf" <<'EOF' || return 1
write_fragment "$dir/share/pipewire/pipewire.conf.d/droiddeck-access.conf" <<'EOF' || return 1
context.properties = {
module.access = false
}
@@ -34,7 +39,7 @@ context.modules = [
}
]
EOF
cat > "$dir/share/wireplumber/wireplumber.conf.d/droiddeck-access.conf" <<'EOF' || return 1
write_fragment "$dir/share/wireplumber/wireplumber.conf.d/droiddeck-access.conf" <<'EOF' || return 1
access.rules = [
{
matches = [ { pipewire.access = "unrestricted" } ]
@@ -54,8 +59,12 @@ env)
client_env
;;
start)
unpack || exit 1
access_config || { echo "droiddeck-pipewire: could not write the access settings" >&2; exit 1; }
mkdir -p "$(dirname "$dir")" 2>/dev/null
(
flock 9 || exit 1
unpack || exit 1
access_config || { echo "droiddeck-pipewire: could not write the access settings" >&2; exit 1; }
) 9> "$dir.lock" || exit 1
stop
mkdir -p "$state"
eval "$(client_env)"
+84
View File
@@ -0,0 +1,84 @@
import os
from pathlib import Path
import subprocess
import unittest
LINUXFS = Path(__file__).resolve().parents[1] / 'linuxfs'
DESKTOP = (LINUXFS / 'desktop/droiddeck-desktop').read_text()
SESSION = (LINUXFS / 'overlay/usr/local/bin/droiddeck-session').read_text()
BOTTOM_DESKTOP = (LINUXFS / 'overlay/usr/local/bin/droiddeck-bottom-desktop').read_text()
BOTTOM_SESSION = (
Path(__file__).resolve().parents[2]
/ 'app/src/main/java/com/droiddeck/launcher/session/BottomDesktop.kt'
).read_text()
HELPER = '/usr/local/bin/droiddeck-pipewire'
class DesktopPipeWireTest(unittest.TestCase):
def run_lifecycle_block(self, start, end, bottom, start_status=0, probe_env=False):
block = DESKTOP[DESKTOP.index(start):DESKTOP.index(end, DESKTOP.index(start))]
block = block.replace(HELPER, 'pipewire')
script = '''
pipewire() {
if [ "$1" = env ]; then
printf 'export PW_ENV=set\\n'
else
printf 'call:%s\\n' "$1"
[ "$1" != start ] || return "$PW_START_STATUS"
fi
}
''' + block + ('echo "env:${PW_ENV:-unset}"\n' if probe_env else '')
environment = dict(os.environ, BL_BOTTOM_DESKTOP='1' if bottom else '0',
PW_START_STATUS=str(start_status))
result = subprocess.run(['bash', '-c', script], env=environment, capture_output=True,
text=True, timeout=5)
self.assertEqual(0, result.returncode, result.stderr)
return result.stdout.splitlines()
def test_desktop_serves_pipewire_before_plasma_and_stops_it_after(self):
start = DESKTOP.index(HELPER + ' start')
env = DESKTOP.index(HELPER + ' env')
plasma = DESKTOP.index('dbus-run-session -- startplasma-wayland')
stop = DESKTOP.index(HELPER + ' stop')
self.assertLess(start, env)
self.assertLess(env, plasma)
self.assertLess(plasma, stop)
self.assertLess(stop, DESKTOP.index('droiddeck-steam-launch bigpicture'))
def test_steam_session_keeps_its_pipewire_startup(self):
self.assertEqual(1, SESSION.count(HELPER + ' start'))
self.assertIn('if [ "$mode" = steam ]; then\n if ' + HELPER + ' start', SESSION)
def test_bottom_desktop_starts_and_stops_its_pipewire_service(self):
self.assertIn('export BL_BOTTOM_DESKTOP=1', BOTTOM_DESKTOP)
self.assertLess(BOTTOM_DESKTOP.index('export BL_BOTTOM_DESKTOP=1'),
BOTTOM_DESKTOP.index('exec /usr/local/bin/droiddeck-desktop'))
self.assertIn('File(context.filesDir, ".wayland-rt-bottom")', BOTTOM_SESSION)
self.assertNotIn('if [ "${BL_BOTTOM_DESKTOP:-0}" != 1 ]; then', DESKTOP)
for bottom in (False, True):
self.assertEqual(['call:start'], self.run_lifecycle_block(
'if ' + HELPER + ' start',
'echo "== droiddeck-desktop: Plasma on $WAYLAND_DISPLAY"', bottom))
self.assertEqual(['call:stop'], self.run_lifecycle_block(
HELPER + ' stop',
'echo "== droiddeck-desktop: Plasma ended ($rc)"', bottom))
def test_successful_start_exports_the_client_environment(self):
for bottom in (False, True):
self.assertEqual(['call:start', 'env:set'], self.run_lifecycle_block(
'if ' + HELPER + ' start',
'echo "== droiddeck-desktop: Plasma on $WAYLAND_DISPLAY"', bottom, probe_env=True))
def test_failed_start_reports_it_and_leaves_the_environment_alone(self):
for bottom in (False, True):
self.assertEqual(
['call:start', '== pipewire: not running; screen capture has no picture', 'env:unset'],
self.run_lifecycle_block(
'if ' + HELPER + ' start',
'echo "== droiddeck-desktop: Plasma on $WAYLAND_DISPLAY"', bottom,
start_status=1, probe_env=True))
if __name__ == '__main__':
unittest.main()
+56 -2
View File
@@ -23,6 +23,7 @@ class PipeWireHelperTest(unittest.TestCase):
self.helper = self.root / 'droiddeck-pipewire'
self.helper.write_text(text)
self.environment = dict(os.environ, XDG_RUNTIME_DIR=str(self.runtime))
self.started = []
def pack(self, daemon_body):
tree = self.root / 'tree'
@@ -36,9 +37,27 @@ class PipeWireHelperTest(unittest.TestCase):
archive.add(tree, arcname='.')
subprocess.run(['zstd', '-q', '-f', str(tar), '-o', str(self.bundle)], check=True)
def run_helper(self, *args):
def pack_with_stub_zstd(self, delay=''):
tree = self.root / 'tree'
daemon = tree / 'bin/pipewire'
daemon.parent.mkdir(parents=True)
daemon.write_text('#!/bin/sh\npython3 -c "import socket,sys; s=socket.socket(socket.AF_UNIX); '
's.bind(sys.argv[1]); import time; time.sleep(30)" "$XDG_RUNTIME_DIR/pipewire-0"\n')
(tree / 'bin/wireplumber').write_text('#!/bin/sh\nexec sleep 30\n')
for script in daemon.parent.iterdir():
script.chmod(0o755)
with tarfile.open(self.bundle, 'w') as archive:
archive.add(tree, arcname='.')
stubs = self.root / 'stubs'
stubs.mkdir()
slow = stubs / 'zstd'
slow.write_text('#!/bin/sh\n' + delay + 'exec cat -- "$2"\n')
slow.chmod(0o755)
self.environment['PATH'] = '%s:%s' % (stubs, os.environ['PATH'])
def run_helper(self, *args, environment=None):
with tempfile.TemporaryFile('w+') as out, tempfile.TemporaryFile('w+') as err:
done = subprocess.run(['sh', str(self.helper), *args], env=self.environment, stdout=out, stderr=err,
done = subprocess.run(['sh', str(self.helper), *args], env=environment or self.environment, stdout=out, stderr=err,
text=True, timeout=15)
out.seek(0)
err.seek(0)
@@ -46,6 +65,8 @@ class PipeWireHelperTest(unittest.TestCase):
def tearDown(self):
self.run_helper('stop')
for environment in self.started:
self.run_helper('stop', environment=environment)
def test_env_points_clients_at_the_bundle(self):
out = self.run_helper('env').stdout
@@ -104,6 +125,39 @@ class PipeWireHelperTest(unittest.TestCase):
self.assertIn('could not write the access settings', result.stderr)
self.assertFalse((self.runtime / 'droiddeck-pipewire/pids').exists())
def test_access_settings_are_replaced_atomically_without_leftovers(self):
self.pack_with_stub_zstd()
self.assertEqual(self.run_helper('start').returncode, 0)
fragments = [self.dir / 'share/pipewire/pipewire.conf.d/droiddeck-access.conf',
self.dir / 'share/wireplumber/wireplumber.conf.d/droiddeck-access.conf']
before = [(f.stat().st_ino, f.read_text()) for f in fragments]
held = [f.open() for f in fragments]
self.assertEqual(self.run_helper('start').returncode, 0)
for handle, (_, text) in zip(held, before):
self.assertEqual(handle.read(), text)
handle.close()
for fragment, (inode, text) in zip(fragments, before):
self.assertNotEqual(fragment.stat().st_ino, inode)
self.assertEqual(fragment.read_text(), text)
self.assertEqual([c.name for c in fragment.parent.iterdir()], [fragment.name])
def test_concurrent_starts_share_one_unpack(self):
self.pack_with_stub_zstd('sleep 1\n')
errors = [tempfile.TemporaryFile('w+') for _ in range(3)]
for index in range(len(errors)):
runtime = self.root / ('run%d' % index)
runtime.mkdir()
self.started.append(dict(self.environment, XDG_RUNTIME_DIR=str(runtime)))
runs = [subprocess.Popen(['sh', str(self.helper), 'start'], env=environment,
stdout=subprocess.DEVNULL, stderr=err, text=True)
for environment, err in zip(self.started, errors)]
for run, err in zip(runs, errors):
run.wait(timeout=30)
err.seek(0)
self.assertEqual(run.returncode, 0, err.read())
self.assertTrue((self.dir / 'bin/pipewire').is_file())
self.assertFalse((self.lib / 'droiddeck-pipewire.new').exists())
def test_unchanged_bundle_is_not_unpacked_again(self):
self.pack('exec sleep 30')
self.run_helper('start')