(fix/UX) Track menu: Left key in Search related & Crates menus closes them again

[ronso0]

If a QWidgetAction in either Search related & Crates menu is focused, Left/Right keys are translated to Up/Down which prevents closing the submenus with Left key like in other submenus.
(in the Crates menu left works as soon as the New Crate button is reached)

Fix:

Translate Left to Esc to close this submenu.
Call hide() of the respective sumenu.

For fixing the crates menu this should actually go to 2.4 ("Search related Tracks" has QWidgetActions only in 2.5), but since we're going to release that shortly before 2.5 I think it's okay to merge the double fix to 2.5-beta

[cr7pt0gr4ph7]

LGTM. The issue fixed by this is still present in main, so maybe merge it to main if it should already be too late for 2.5.

[JoergAtGithub]

I tried this and it crashed with:
Exception thrown: read access violation. this->d_ptr.**d** was 0x10001004A.

 	Qt6Core.dll!QObject::parent() Line 376	C++
>	[Inline Frame] mixxx.exe!parented_ptr<QWidgetAction>::{dtor}() Line 37	C++
 	[Inline Frame] mixxx.exe!parented_ptr<QWidgetAction>::operator=(parented_ptr<QWidgetAction> &&) Line 65	C++
 	mixxx.exe!WSearchRelatedTracksMenu::addActionsForTrack(const Track & track={...}) Line 364	C++
 	[Inline Frame] mixxx.exe!WTrackMenu::createMenus::__l29::<lambda_1>::operator()() Line 255	C++
 	[Inline Frame] mixxx.exe!QtPrivate::FunctorCall<QtPrivate::IndexesList<>,QtPrivate::List<>,void,`WTrackMenu::createMenus'::`29'::<lambda_1>>::call(WTrackMenu::createMenus::__l29::<lambda_1> &) Line 129	C++
 	[Inline Frame] mixxx.exe!QtPrivate::Functor<`WTrackMenu::createMenus'::`29'::<lambda_1>,0>::call(WTrackMenu::createMenus::__l29::<lambda_1> &) Line 243	C++
 	mixxx.exe!QtPrivate::QFunctorSlotObject<`WTrackMenu::createMenus'::`29'::<lambda_1>,0,QtPrivate::List<>,void>::impl(int which, QtPrivate::QSlotObjectBase * this_=0x000001fd0829df70, QObject * r=0x000000516c6fb500, void * * a=0x00007ffed961946d, bool * ret=0x0000000000000000) Line 457	C++
 	[Inline Frame] Qt6Core.dll!QtPrivate::QSlotObjectBase::call(QObject *) Line 374	C++
 	Qt6Core.dll!doActivate<0>(QObject * sender=0x000001fd13bd6420, int signal_index=7, void * * argv) Line 4036	C++
 	Qt6Core.dll!QMetaObject::activate(QObject * sender=0x000001fd13bd6420, const QMetaObject * m, int local_signal_index=0, void * * argv=0x0000000000000000) Line 4097	C++
 	[Inline Frame] Qt6Widgets.dll!QMenu::aboutToShow() Line 352	C++
 	Qt6Widgets.dll!QMenuPrivate::popup(const QPoint & p={...}, QAction * atAction=0x0000000000000000, std::function<QPoint __cdecl(QSize const &)> positionFunction={...}) Line 2369	C++
 	[Inline Frame] Qt6Widgets.dll!QMenu::popup(const QPoint &) Line 2306	C++
 	Qt6Widgets.dll!QMenu::internalDelayedPopup() Line 3627	C++
 	[Inline Frame] Qt6Widgets.dll!QEvent::accept() Line 303	C++
 	Qt6Widgets.dll!QMenu::keyPressEvent(QKeyEvent * e=0x000000516c6fc6e0) Line 3418	C++
 	Qt6Widgets.dll!QWidget::event(QEvent * event=0x000000516c6fc6e0) Line 9005	C++
 	Qt6Widgets.dll!QMenu::event(QEvent * e=0x000000516c6fc6e0) Line 3047	C++
 	Qt6Widgets.dll!QApplicationPrivate::notify_helper(QObject * receiver=0x000001fd07da7700, QEvent * e=0x000000516c6fc6e0) Line 3292	C++
 	Qt6Widgets.dll!QApplication::notify(QObject * receiver=0x000001fd07da7700, QEvent * e=0x000000516c6fc6e0) Line 2718	C++
 	Qt6Core.dll!QCoreApplication::notifyInternal2(QObject * receiver=0x000001fd07da7700, QEvent * event=0x000000516c6fc6e0) Line 1118	C++
 	Qt6Widgets.dll!QWidgetWindow::event(QEvent * event=0x000000516c6fc6e0) Line 313	C++
 	Qt6Widgets.dll!QApplicationPrivate::notify_helper(QObject * receiver=0x000001fd35e643f0, QEvent * e=0x000000516c6fc6e0) Line 3292	C++
 	Qt6Widgets.dll!QApplication::notify(QObject * receiver=0x000001fd35e643f0, QEvent * e=0x000000516c6fc6e0) Line 3244	C++
 	Qt6Core.dll!QCoreApplication::notifyInternal2(QObject * receiver=0x000001fd35e643f0, QEvent * event=0x000000516c6fc6e0) Line 1118	C++
 	Qt6Gui.dll!QGuiApplicationPrivate::processKeyEvent(QWindowSystemInterfacePrivate::KeyEvent * e=0x000001fd15e06ce0) Line 2459	C++
 	Qt6Gui.dll!QWindowSystemInterface::sendWindowSystemEvents(QFlags<enum QEventLoop::ProcessEventsFlag> flags={...}) Line 1100	C++
 	Qt6Core.dll!QEventDispatcherWin32::processEvents(QFlags<enum QEventLoop::ProcessEventsFlag> flags={...}) Line 464	C++
 	Qt6Gui.dll!QWindowsGuiEventDispatcher::processEvents(QFlags<enum QEventLoop::ProcessEventsFlag> flags) Line 37	C++
 	[Inline Frame] Qt6Core.dll!QEventLoop::processEvents(QFlags<enum QEventLoop::ProcessEventsFlag>) Line 100	C++
 	Qt6Core.dll!QEventLoop::exec(QFlags<enum QEventLoop::ProcessEventsFlag> flags={...}) Line 182	C++
 	Qt6Core.dll!QCoreApplication::exec() Line 1439	C++
 	mixxx.exe!`anonymous namespace'::runMixxx(MixxxApplication * pApp=0x000000516c6ffc48, const CmdlineArgs & args={...}) Line 108	C++
 	mixxx.exe!main(int argc=1, char * * argv=0x000001fd36dfc1b0) Line 243	C++
 	[Inline Frame] mixxx.exe!invoke_main() Line 78	C++
 	mixxx.exe!__scrt_common_main_seh() Line 288	C++
 	kernel32.dll!BaseThreadInitThunk()	Unknown
 	ntdll.dll!RtlUserThreadStart()	
```Unknown

For consistency, I would also filter the Right key.

[daschuer]

@JoergAtGithub I can't reproduce the crasher. It looks like a dangling pointer access. Unfortunately I cannot reproduce the issue.
Do you have receipt for it?

[acolombier]

friendly ping @JoergAtGithub - are you able to provide reproduction steps for this bug?

[acolombier]

Clang tidy here

Suggested change

	for (const auto ch : m_pSearchRelatedMenu->children()) {
	for (auto *const ch : m_pSearchRelatedMenu->children()) {

[ronso0]

Ah, thanks! overlooked that.
Though, why is it suggesting
auto *const ch and not
const auto* ch?

[ronso0]

I extended that to ignore Right key as suggested by @JoergAtGithub