feat(linux): Start dbus if not running #10863

ermshiperete · 2024-02-27T18:27:17Z

This change checks the DBus environment variables when initializing the keyman_config module and starts DBus if the variables are not set. This particularly happens when trying to install or uninstall a keyboard for a different user, which will now be possible with this change.

Fixes #9363.

User Testing

Preparations

The tests should be run on these Linux platforms:
- GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11
- GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
Install build artifacts of this PR
Reboot
Create a second user myuser without admin privileges

Tests

TEST_INST: Can install a keyboard for the second user

in a terminal window, login as myuser by running su --login myuser
as myuser run: km-package-install -p sil_euro_latin --bcp47 de
verify that this doesn't output errors
logout and login as myuser
verify that the "German (EuroLatin (SIL))" keyboard appears in the toolbar
verify that you can switch to and type with that keyboard

TEST_UNINST: Can uninstall a keyboard for the second user

logout and login as regular user again
in a terminal window, login as myuser by running su --login myuser
as myuser run: km-package-uninstall sil_euro_latin
verify that this doesn't output errors
logout and login as myuser
verify that the "German (EuroLatin (SIL))" keyboard no longer appears in the toolbar

This change checks the DBus environment variables when initializing the `keyman_config` module and starts DBus if the variables are not set. This particularly happens when trying to install or uninstall a keyboard for a different user, which will now be possible with this change. Fixes #9363.

keymanapp-test-bot · 2024-02-27T18:27:23Z

User Test Results

Test specification and instructions

✅ GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11
2 tests PASSED
- ✅ TEST_INST (PASSED): Retested this PR, as per Eberhard's suggestion with the attached PR build (Keyman 17.0.293-beta (package version 17.0.293-1~PR-10863-2581.1+focal1) on Ubuntu 20.04 Focal Linux (X11) and here is my observation : 1. In the terminal window, logged in to myuser. 2. In myuser, run the above-mentioned command line to install sil_euro_latin keyboard. It shows some irrelevant error message on the terminal window. 3. Logged out and logged in as myuser. Verfied that the "German (EuroLatin (SIL))" keyboard appeared in the toolbar. Able to type in that keyboard in the text editor. (notes)
- ✅ TEST_UNINST (PASSED): 1. Logged out and logged in as regular user again. 2. In terminal window, logged in as myuser. 3. As myuser, run the above mentioned command. It shows up some irrelevant error message on the terminal window. 4. Logged out and logged in as myuser. Verified that the "German (EuroLatin (SIL))" keyboard did not appear in the toolbar.
✅ GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
2 tests PASSED
- ✅ TEST_INST (PASSED): Retested (as per Eberhard's suggestion) with the attached PR build (Keyman 17.0.293-beta (package vesion 17.0.293-1~PR-10863-2581.1+jammy1) on Ubuntu 20.04 Focal Linux (Wayland) and here is my observation : 1. In the terminal window, logged in to myuser. 2. In myuser, run the above mentioned command line to install sil_euro_latin keyboard. It shows up some irrelevant error message on the terminal window. 3. Logged out and logged in as myuser. Verfied that the "German (EuroLatin (SIL))" keyboard appeared in the toolbar. Able to type in that keyboard in the text editor. (notes)
- ✅ TEST_UNINST (PASSED): 1. Logged out and logged in as regular user again. 2. In a terminal window, logged in as myuser. 3. As myuser, run the above mentioned command . It shows up some irrelevant error message on the terminal window. 4. Logged out and logged in as myuser. Verified that the "German (EuroLatin (SIL))" keyboard did not appear in the toolbar.

Test Artifacts

Linux

darcywong00 · 2024-02-27T23:03:16Z

linux/keyman-config/keyman_config/__init__.py

+                logging.warning('Got unexpected line from dbus-launch: %s', line)
+                continue
+            name = line[:equal_sign]
+            value = line[equal_sign+1:]


Is this empty if = is at the end of the line?

ermshiperete · 2024-02-29T16:18:32Z

When installing the packages for this PR on Focal it's no longer possible to type with Keyman. Most often the keyboards don't show up, and if they do typing doesn't work.

…nux/9363DBusEnv

ermshiperete · 2024-02-29T17:44:26Z

Things work after rebooting after the installation.

bharanidharanj · 2024-03-01T12:46:42Z

Test Results

GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

TEST_INST (FAILED): Tested with the attached PR build on Ubuntu 20.04 Focal Linux OS (x11) (VM) and here is my observation: 1. Installed the PR build Keyman 17.0.279-beta (package version 17.0.279-1~PR-10863-2470.1+focal1). 2. Restarted the system. 3. Created a second user 'myuser1' without admin privileges. 4. Opened terminal window. Changed to second user 'myuser1'. 5. Ran the above-mentioned command and noticed that it is displaying an error message.
TEST_UNINST (FAILED): Tested with the attached PR build on Ubuntu 20.04 Focal Linux OS (x11) (VM) and here is my observation: 1. Restarted the system. 2. Opened terminal window. Changed to second user 'myuser1'. 5. Ran the above-mentioned (uninstall) command and noticed that it is displaying an error message.

bharanidharanj · 2024-03-04T10:26:49Z

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

TEST_INST (PASSED): Tested with the attached PR build (keyman 17.0.279-beta (package version 17.0.279-1~PR-10863-2470.1+jammy1) on Ubuntu 22.04 Jammy with Gnome Shell and Wayland (Virtual Box) and here is my observation: 1. Created a second user 'myuser' without admin privileges. 2. Changed to second user 'myuser'. 3. Run the above mentioned package-install command on the terminal. 4. Verified it doesn't output any errors. 5. logged out then logged in as 'myuser'. 5. Verified that the "German (EuroLatin(SIL))" keyboard is appearing in the toolbar. 6. Verified that switching to German Keyboard and typing with that keyboard is possible.

bharanidharanj · 2024-03-04T10:35:35Z

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

TEST_UNINST (PASSED): 1. Logged in as a regular user again. 2. Changed to Second user 'myuser' in the terminal window. 3. Run the above mentioned package-uninstall command and verified that it doesn't output any errors. 4. Logged out then logged in as 'myuser'. Verified that the "German (EuroLatin(SIL))" keyboard doesn't appear in the toolbar. Seems to be working as expected.

If we want to log messages we need to start DBus after we initialized logging.

…nux/9363DBusEnv

ermshiperete · 2024-03-20T10:27:24Z

GROUP_FOCAL:

TEST_INST (SKIPPED): error message is unrelated
TEST_UNINST (SKIPPED): error message is unrelated

Also need to start as daemon so that it works when run as a different user.

When we launch dbus if it is not running, we're probably (un-)installing keyboards for a different user. This is an unusual environment where not everything is available, e.g. dconf-service won't be running and can't be started because DISPLAY variable is not set. This means we can't write gsettings values through the API. However, we can read them, and we can write a keyfile and update the database. This is what this change implements for the cases where we started dbus.

`DBUS_SESSION_BUS_PID` gets only set when launching dbus in the process, but not when it's already running.

ermshiperete · 2024-03-22T16:10:08Z

@bharanidharanj Could you please run the tests again? I had to change quite a bit. Thanks! Note that on Ubuntu 20.04 Focal you can ignore the "Unable to init server: Could not connect: Connection refused" message.

@keymanapp-test-bot retest

bharanidharanj · 2024-03-25T07:39:43Z

Test Results

GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

TEST_INST (PASSED): Retested this PR, as per Eberhard's suggestion with the attached PR build (Keyman 17.0.293-beta (package version 17.0.293-1~PR-10863-2581.1+focal1) on Ubuntu 20.04 Focal Linux (X11) and here is my observation : 1. In the terminal window, logged in to myuser. 2. In myuser, run the above-mentioned command line to install sil_euro_latin keyboard. It shows some irrelevant error message on the terminal window. 3. Logged out and logged in as myuser. Verfied that the "German (EuroLatin (SIL))" keyboard appeared in the toolbar. Able to type in that keyboard in the text editor.
TEST_UNINST (PASSED): 1. Logged out and logged in as regular user again. 2. In terminal window, logged in as myuser. 3. As myuser, run the above mentioned command. It shows up some irrelevant error message on the terminal window. 4. Logged out and logged in as myuser. Verified that the "German (EuroLatin (SIL))" keyboard did not appear in the toolbar.

bharanidharanj · 2024-03-25T08:24:30Z

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

TEST_INST (PASSED): Retested (as per Eberhard's suggestion) with the attached PR build (Keyman 17.0.293-beta (package vesion 17.0.293-1~PR-10863-2581.1+jammy1) on Ubuntu 20.04 Focal Linux (Wayland) and here is my observation : 1. In the terminal window, logged in to myuser. 2. In myuser, run the above mentioned command line to install sil_euro_latin keyboard. It shows up some irrelevant error message on the terminal window. 3. Logged out and logged in as myuser. Verfied that the "German (EuroLatin (SIL))" keyboard appeared in the toolbar. Able to type in that keyboard in the text editor.
TEST_UNINST (PASSED): 1. Logged out and logged in as regular user again. 2. In a terminal window, logged in as myuser. 3. As myuser, run the above mentioned command . It shows up some irrelevant error message on the terminal window. 4. Logged out and logged in as myuser. Verified that the "German (EuroLatin (SIL))" keyboard did not appear in the toolbar.

keyman-server · 2024-03-26T18:03:45Z

Changes in this pull request will be available for download in Keyman version 17.0.295-beta

ermshiperete requested a review from darcywong00 as a code owner February 27, 2024 18:27

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Feb 27, 2024

keymanapp-test-bot bot added this to the B17S2 milestone Feb 27, 2024

github-actions bot added linux/ linux/config/ feat labels Feb 27, 2024

ermshiperete linked an issue Feb 27, 2024 that may be closed by this pull request

feat(linux): Allow to install/uninstall keyboards if DBus is not started #9363

Closed

darcywong00 reviewed Feb 27, 2024

View reviewed changes

mcdurdin approved these changes Feb 29, 2024

View reviewed changes

ermshiperete marked this pull request as draft February 29, 2024 16:16

chore(linux): Merge remote-tracking branch 'origin/beta' into feat/li…

639ac25

…nux/9363DBusEnv

ermshiperete marked this pull request as ready for review February 29, 2024 17:49

keymanapp-test-bot bot added the user-test-failed label Mar 1, 2024

mcdurdin modified the milestones: B17S2, B17S3 Mar 3, 2024

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 4, 2024

darcywong00 modified the milestones: B17S3, B17S4 Mar 16, 2024

ermshiperete added 2 commits March 20, 2024 11:18

chore(linux): Change order of initialization

37024fa

If we want to log messages we need to start DBus after we initialized logging.

chore(linux): Merge remote-tracking branch 'origin/beta' into feat/li…

01b8016

…nux/9363DBusEnv

keymanapp-test-bot bot removed the user-test-failed label Mar 20, 2024

ermshiperete added 2 commits March 20, 2024 12:17

fix(linux): Start ibus if not running

2af4a04

Also need to start as daemon so that it works when run as a different user.

chore(linux): Merge branch 'beta' into feat/linux/9363DBusEnv

27b09fc

ermshiperete marked this pull request as draft March 21, 2024 21:31

ermshiperete added 4 commits March 22, 2024 12:54

chore(linux): Merge branch 'beta' into feat/linux/9363DBusEnv

c0a927c

fix(linux): Don't expect DBUS_SESSION_BUS_PID to be set

6b292ae

`DBUS_SESSION_BUS_PID` gets only set when launching dbus in the process, but not when it's already running.

fix(linux): Fix cleanup of files

aefcfb1

ermshiperete marked this pull request as ready for review March 22, 2024 16:07

ermshiperete requested review from mcdurdin and darcywong00 March 22, 2024 16:07

keymanapp-test-bot bot added the user-test-required User tests have not been completed label Mar 22, 2024

feat(linux): Add pyxdg as binary pkg dependency and to setup.py

b4755c2

mcdurdin approved these changes Mar 25, 2024

View reviewed changes

keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 25, 2024

ermshiperete merged commit 58ce4fb into beta Mar 26, 2024
7 checks passed

ermshiperete deleted the feat/linux/9363DBusEnv branch March 26, 2024 14:56

ermshiperete mentioned this pull request Mar 26, 2024

feat(linux): Allow to install/uninstall keyboards if DBus is not started #9363

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(linux): Start dbus if not running #10863

feat(linux): Start dbus if not running #10863

ermshiperete commented Feb 27, 2024 •

edited

keymanapp-test-bot bot commented Feb 27, 2024 •

edited

darcywong00 Feb 27, 2024

ermshiperete Feb 28, 2024

ermshiperete commented Feb 29, 2024

ermshiperete commented Feb 29, 2024

bharanidharanj commented Mar 1, 2024

bharanidharanj commented Mar 4, 2024

bharanidharanj commented Mar 4, 2024

ermshiperete commented Mar 20, 2024

ermshiperete commented Mar 22, 2024

bharanidharanj commented Mar 25, 2024

bharanidharanj commented Mar 25, 2024

keyman-server commented Mar 26, 2024

feat(linux): Start dbus if not running #10863

feat(linux): Start dbus if not running #10863

Conversation

ermshiperete commented Feb 27, 2024 • edited

User Testing

Preparations

Tests

keymanapp-test-bot bot commented Feb 27, 2024 • edited

User Test Results

Test Artifacts

darcywong00 Feb 27, 2024

Choose a reason for hiding this comment

ermshiperete Feb 28, 2024

Choose a reason for hiding this comment

ermshiperete commented Feb 29, 2024

ermshiperete commented Feb 29, 2024

bharanidharanj commented Mar 1, 2024

Test Results

GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

bharanidharanj commented Mar 4, 2024

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

bharanidharanj commented Mar 4, 2024

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

ermshiperete commented Mar 20, 2024

ermshiperete commented Mar 22, 2024

bharanidharanj commented Mar 25, 2024

Test Results

GROUP_FOCAL: Ubuntu 20.04 Focal with Gnome Shell and X11

bharanidharanj commented Mar 25, 2024

Test Results

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

keyman-server commented Mar 26, 2024

ermshiperete commented Feb 27, 2024 •

edited

keymanapp-test-bot bot commented Feb 27, 2024 •

edited