[SRU] Studio-controls not launching on Ubuntu 21.10, KeyError: 'id'

[Stephen Park]

[ Impact ]

Users in certain edge cases of hardware configurations are running into issues where studio-controls is failing to upgrade previous configurations and therefore failing to launch. It was found that an integer needed to be converted to a string in some cases, and was overlooked previously.

[ Test Plan ]

Using a system that had been upgraded from 20.04 to 20.10, 21.04, and finally 21.10 and having run studio-controls previously with success, run studio-controls. In certain hardware configurations, it will crash and return invalid key of "id". This is due to an incorrect conversion of the old-style configuration to the newer json configuration.

[ Where problems could occur ]

While this fixes the issue outlined above, it could cause problems where the json file was previously converted correctly, but this is unlikely.

[ Other Information ]

Original bug report follows:

---

Hi,

I am using studio-controls 2.2.7-0ubuntu1 after having upgraded to Impish. Studio-controls fails to launch with the following traceback:

install path: /usr
Config file: /home/steve/.config/autojack/autojack.json
Traceback (most recent call last):
  File "/usr/bin/studio-controls", line 1837, in <module>
    us = StudioControls()
  File "/usr/bin/studio-controls", line 555, in __init__
    self.devdb.scan_dev(self.conf_db)
  File "/usr/bin/studio-controls", line 164, in scan_dev
    if usb and [ conf['devices'][dev]['id'], conf['devices'][dev]['bus'] ] == [ d_id, bus ]:
KeyError: 'id'

Here is my system info:

Operating System: Kubuntu 21.10
KDE Plasma Version: 5.22.5
KDE Frameworks Version: 5.86.0
Qt Version: 5.15.2
Kernel Version: 5.13.0-21-lowlatency (64-bit)
Graphics Platform: X11
Processors: 8 × Intel® Core™ i7-8550U CPU @ 1.80GHz
Memory: 15.3 GiB of RAM
Graphics Processor: Mesa Intel® UHD Graphics 620

I do have the file autojack.json in .config/autojack that is referred to in another bug report.

After failing to launch, I have a studio-controls.lock file created in the .config/autojack directory. The studio-controls interface does not appear at any time.

Last point, I'm using Pipewire, as I was before upgrading to 21.10, which didn't create a problem with Studio-controls then. I would like to continue to use Studio-controls to control cpu performance and intel boost, and possibly other things.

Thanks !!

Stephen
---
ProblemType: Bug
ApportVersion: 2.20.11-0ubuntu71
Architecture: amd64
CasperMD5CheckResult: unknown
CurrentDesktop: KDE
DistroRelease: Ubuntu 21.10
InstallationDate: Installed on 2020-09-18 (421 days ago)
InstallationMedia: Kubuntu 20.04.1 LTS "Focal Fossa" - Release amd64 (20200731)
Package: studio-controls 2.2.7-0ubuntu1
PackageArchitecture: all
ProcVersionSignature: Ubuntu 5.13.0-21.21-lowlatency 5.13.18
Tags: impish third-party-packages
Uname: Linux 5.13.0-21-lowlatency x86_64
UpgradeStatus: Upgraded to impish on 2021-10-26 (19 days ago)
UserGroups: adm audio cdrom dip lpadmin lxd plugdev sambashare sudo www-data
_MarkForUpload: True

[Erich Eickmeyer (eeickmeyer)]

Thank you for taking the time to report this bug and helping to make Ubuntu better. Please execute the following command only once, as it will automatically gather debugging information, in a terminal:

apport-collect 1950817

When reporting bugs in the future please use apport by using 'ubuntu-bug' and the name of the package affected. You can learn more about this functionality at https://wiki.ubuntu.com/ReportingBugs.

N.B. This bug will expire after 60 days if there is not further activity.

[Stephen Park (mtlspark)]

apport information

[Stephen Park (mtlspark)]

apport information

[Stephen Park (mtlspark)]

apport information

[Erich Eickmeyer (eeickmeyer)]

Reported upstream at https://github.com/ovenwerks/studio-controls/issues/71

[Launchpad Janitor (janitor)]

This bug was fixed in the package studio-controls - 2.2.8-0ubuntu1

---------------
studio-controls (2.2.8-0ubuntu1) jammy; urgency=medium

  [ Erich Eickmeyer]
  * New upstream release 2.2.8

  [ Len Ovens ]
  * USB devices may be less than 3 char
  * Convert old style int to name (LP: #1950817)

 -- Erich Eickmeyer <email address hidden> Tue, 16 Nov 2021 09:08:28 -0800

[Brian Murray (brian-murray)]

Hello Stephen, or anyone else affected,

Accepted studio-controls into impish-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/studio-controls/2.2.8-0ubuntu0.21.10.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-impish to verification-done-impish. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-impish. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Stephen Park (mtlspark)]

Hi Brian,

Thanks for the updated version and I can confirm that the application launches successfully now. It is performing as it did before my upgrade to Impish. As I mentioned, I am not using the application to the full extent of its capabilities because I am using Pipewire as a replacement for Jack, but it remains useful to me control CPU, launch Carla, and some other functions.

Thanks,

Stephen

[Launchpad Janitor (janitor)]

This bug was fixed in the package studio-controls - 2.2.8-0ubuntu0.21.10.1

---------------
studio-controls (2.2.8-0ubuntu0.21.10.1) impish; urgency=medium

  [ Erich Eickmeyer]
  * New upstream release 2.2.8

  [ Len Ovens ]
  * USB devices may be less than 3 char
  * Convert old style int to name (LP: #1950817)

 -- Erich Eickmeyer <email address hidden> Tue, 16 Nov 2021 09:08:28 -0800

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for studio-controls has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.