feat(dock): integrate optional event logging support

Ivy233 · Ivy233 · commit 729c6244a885 · 2026-04-27T13:00:30.000+08:00
Add conditional event logging support for dock-related modules and wire
the required build detection and package dependency. The implementation
keeps the logging integration optional when the event logger headers are
unavailable.

Refactor event logging code to reduce duplication and fix a UI-blocking
issue: extract shared logDockConfig() helper in DockSettings and
updateAndLogTrayPluginList() helper in DockDBusProxy, unify
visiblePluginList/visiblePluginCount into VisiblePluginStats, simplify
timer wiring, and move dpkg-query off the UI thread using
QtConcurrent::run with pre-start in the constructor.

feat(dock): 集成可选事件日志支持

为 dock 相关模块添加条件事件日志支持，并接入所需的构建检测与包依赖。
该实现会在缺少事件日志头文件时保持日志集成可选。

重构事件日志代码以减少重复并修复 UI 阻塞问题：在 DockSettings 中
提取 logDockConfig() 辅助方法，在 DockDBusProxy 中提取
updateAndLogTrayPluginList() 辅助方法，将 visiblePluginList 和
visiblePluginCount 统一为 VisiblePluginStats，简化定时器连接，
并使用 QtConcurrent::run 将 dpkg-query 移至后台线程，在构造函数
中预启动以确保首次使用时结果已就绪。

PMS: TASK-388657
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -61,6 +61,17 @@ find_package(ICU 74.2 REQUIRED COMPONENTS uc i18n io)
 find_package(WaylandProtocols REQUIRED)
 find_package(PkgConfig REQUIRED)
 
+# Check if dde-api eventlogger.hpp exists
+# Unset cache to force re-detection every time
+unset(DDE_API_EVENTLOGGER_INCLUDE_DIR CACHE)
+find_path(DDE_API_EVENTLOGGER_INCLUDE_DIR NAMES dde-api/eventlogger.hpp PATHS /usr/include)
+if(DDE_API_EVENTLOGGER_INCLUDE_DIR)
+    set(HAVE_DDE_API_EVENTLOGGER ON)
+    message(STATUS "Found dde-api eventlogger.hpp: ${DDE_API_EVENTLOGGER_INCLUDE_DIR}")
+else()
+    message(STATUS "dde-api eventlogger.hpp not found, event logging will be disabled")
+endif()
+
 qt_policy(SET QTP0001 NEW)
 
 try_compile(COMPILE_RESULT
diff --git a/debian/control b/debian/control
@@ -6,6 +6,7 @@ Build-Depends:
  debhelper-compat (= 13),
  cmake,
  dde-application-manager-api (>= 1.2.48),
+ dde-api-dev (>> 6.0.39),
  dde-tray-loader-dev (> 2.0.24),
  extra-cmake-modules,
  libdtk6core-bin,
diff --git a/panels/dock/CMakeLists.txt b/panels/dock/CMakeLists.txt
@@ -75,6 +75,10 @@ target_link_libraries(dockpanel PRIVATE
     dde-shell-dock
 )
 
+if (HAVE_DDE_API_EVENTLOGGER)
+    target_compile_definitions(dockpanel PRIVATE HAVE_DDE_API_EVENTLOGGER)
+endif()
+
 if (BUILD_WITH_X11)
     target_compile_definitions(dockpanel PRIVATE BUILD_WITH_X11=)
     pkg_check_modules(XCB REQUIRED IMPORTED_TARGET xcb xcb-aux xcb-res xcb-ewmh)
diff --git a/panels/dock/dockdbusproxy.cpp b/panels/dock/dockdbusproxy.cpp
@@ -9,6 +9,11 @@
 #include "dockdbusproxy.h"
 
 #include <QObject>
+#include <QJsonObject>
+
+#ifdef HAVE_DDE_API_EVENTLOGGER
+#include <dde-api/eventlogger.hpp>
+#endif
 
 #include <DWindowManagerHelper>
 #include <appletbridge.h>
@@ -17,6 +22,9 @@ DGUI_USE_NAMESPACE
 DS_USE_NAMESPACE
 namespace {
 constexpr auto DockVersionV1 = "1.0";
+#ifdef HAVE_DDE_API_EVENTLOGGER
+constexpr qint64 EVENT_LOGGER_TRAY_PLUGIN_LIST = 1000610007;
+#endif
 
 QList<DS_NAMESPACE::DAppletDock *> dockApplets(dock::DockPanel *panel)
 {
@@ -32,6 +40,28 @@ QList<DS_NAMESPACE::DAppletDock *> dockApplets(dock::DockPanel *panel)
     }
     return list;
 }
+
+#ifdef HAVE_DDE_API_EVENTLOGGER
+struct VisiblePluginStats {
+    int count = 0;
+    QString list;
+};
+
+VisiblePluginStats visiblePluginStats(const DockItemInfos &itemInfos)
+{
+    QStringList pluginNames;
+    int count = 0;
+    for (const DockItemInfo &itemInfo : itemInfos) {
+        if (itemInfo.visible) {
+            ++count;
+            if (!itemInfo.name.isEmpty())
+                pluginNames.append(itemInfo.name);
+        }
+    }
+    pluginNames.removeDuplicates();
+    return { count, pluginNames.join(QStringLiteral(",")) };
+}
+#endif
 }
 namespace dock {
 DockDBusProxy::DockDBusProxy(DockPanel* parent)
@@ -40,6 +70,13 @@ DockDBusProxy::DockDBusProxy(DockPanel* parent)
     , m_trayApplet(nullptr)
 {
     registerPluginInfoMetaType();
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    DDE_EventLogger::EventLogger::instance().init("org.deepin.dde.shell", false);
+    m_trayPluginListLogTimer.setSingleShot(true);
+    m_trayPluginListLogTimer.setInterval(1000);
+    connect(&m_trayPluginListLogTimer, &QTimer::timeout,
+            this, &DockDBusProxy::logTrayPluginList);
+#endif
 
     connect(DockSettings::instance(), &DockSettings::pluginsVisibleChanged, this, [this] (const QVariantMap &pluginsVisible) {
         updateDockPluginsVisible(pluginsVisible);
@@ -75,6 +112,12 @@ DockDBusProxy::DockDBusProxy(DockPanel* parent)
             timer->stop();
             timer->deleteLater();
             connect(m_trayApplet, SIGNAL(pluginsChanged()), this, SIGNAL(pluginsChanged()));
+#ifdef HAVE_DDE_API_EVENTLOGGER
+            connect(this, &DockDBusProxy::pluginsChanged, this, [this] {
+                m_trayPluginListLogTimer.start();
+            }, Qt::UniqueConnection);
+            m_trayPluginListLogTimer.start();
+#endif
         }
     });
     timer->start();
@@ -255,6 +298,41 @@ DockItemInfos DockDBusProxy::plugins()
     return iteminfos;
 }
 
+#ifdef HAVE_DDE_API_EVENTLOGGER
+bool DockDBusProxy::updateAndLogTrayPluginList(const DockItemInfos &itemInfos)
+{
+    const auto stats = visiblePluginStats(itemInfos);
+    if (stats.count == m_visiblePluginCount) {
+        return false;
+    }
+    m_visiblePluginCount = stats.count;
+
+    DDE_EventLogger::EventLogger::instance().writeEventLog(
+        DDE_EventLogger::EventLoggerData(EVENT_LOGGER_TRAY_PLUGIN_LIST, QStringLiteral("taskmanager_config"), {
+            {QStringLiteral("tray_plugin_list"), stats.list}
+        }));
+    qDebug() << "EventLogger: tray_plugin_list:" << stats.list;
+    return true;
+}
+
+void DockDBusProxy::logTrayPluginList()
+{
+    updateAndLogTrayPluginList(plugins());
+}
+
+void DockDBusProxy::logTrayPluginListChange(const QString &changedItemKey, bool visible)
+{
+    DockItemInfos itemInfos = plugins();
+    for (DockItemInfo &itemInfo : itemInfos) {
+        if (itemInfo.itemKey == changedItemKey) {
+            itemInfo.visible = visible;
+            break;
+        }
+    }
+    updateAndLogTrayPluginList(itemInfos);
+}
+#endif
+
 void DockDBusProxy::ReloadPlugins()
 {
     parent()->ReloadPlugins();
@@ -274,13 +352,19 @@ void DockDBusProxy::setItemOnDock(const QString &settingKey, const QString &item
             pluginsVisible[itemKey] = visible;
             DockSettings::instance()->setPluginsVisible(pluginsVisible);
             Q_EMIT pluginVisibleChanged(itemKey, visible);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+            logTrayPluginListChange(itemKey, visible);
+#endif
             return;
         }
     }
 
     if (m_trayApplet) {
         Q_EMIT pluginVisibleChanged(itemKey, visible);
         QMetaObject::invokeMethod(m_trayApplet, "setItemOnDock", Qt::QueuedConnection, settingKey, itemKey, visible);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+        logTrayPluginListChange(itemKey, visible);
+#endif
     }
 }
 
@@ -340,4 +424,3 @@ void DockDBusProxy::setLocked(bool newLocked)
 }
 
 }
-
diff --git a/panels/dock/dockdbusproxy.h b/panels/dock/dockdbusproxy.h
@@ -15,6 +15,7 @@
 #include <QObject>
 #include <QDBusContext>
 #include <QDBusArgument>
+#include <QTimer>
 
 /** this class used for old dock api compatible
   * it will forward old dbus call to new implementation
@@ -88,9 +89,18 @@ class DockDBusProxy final: public QObject, public QDBusContext
     DockPanel* parent() const;
     QString getAppID(const QString &desktopfile);
     void updateDockPluginsVisible(const QVariantMap &pluginsVisible);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    bool updateAndLogTrayPluginList(const DockItemInfos &itemInfos);
+    void logTrayPluginList();
+    void logTrayPluginListChange(const QString &changedItemKey, bool visible);
+#endif
 
     DS_NAMESPACE::DAppletProxy *m_oldDockApplet;
     DS_NAMESPACE::DAppletProxy *m_trayApplet;
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    QTimer m_trayPluginListLogTimer;
+    int m_visiblePluginCount = -1;
+#endif
 };
 }
 
diff --git a/panels/dock/docksettings.cpp b/panels/dock/docksettings.cpp
@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2023 UnionTech Software Technology Co., Ltd.
+// SPDX-FileCopyrightText: 2023 - 2026 UnionTech Software Technology Co., Ltd.
 //
 // SPDX-License-Identifier: GPL-3.0-or-later
 
@@ -9,6 +9,16 @@
 #include <QTimer>
 #include <QLoggingCategory>
 
+#ifdef HAVE_DDE_API_EVENTLOGGER
+#include <QJsonObject>
+#include <dde-api/eventlogger.hpp>
+
+// Event IDs for dock settings (10-digit numbers)
+// 1000600010: shell_pos + shell_dock_mode (merged output)
+// 1000600011: merge_app_model_on + tray_plugin_list (used in taskmanagersettings) + icon_theme (used in dde-appearance)
+constexpr qint64 EVENT_LOGGER_DOCK_CONFIG = 1000610006;
+#endif
+
 Q_LOGGING_CATEGORY(dockSettingsLog, "org.deepin.dde.shell.dock.docksettings")
 
 const static QString keyPosition                = "Position";
@@ -82,6 +92,21 @@ static QString itemAlignment2String(const ItemAlignment& alignment)
     return "center";
 }
 
+#ifdef HAVE_DDE_API_EVENTLOGGER
+void DockSettings::logDockConfig(std::optional<Position> pos, std::optional<ItemAlignment> align, const QString &reason) const
+{
+    QJsonObject payload;
+    if (pos)
+        payload.insert(QStringLiteral("shell_pos"), position2String(*pos));
+    if (align)
+        payload.insert(QStringLiteral("shell_dock_mode"), itemAlignment2String(*align));
+
+    DDE_EventLogger::EventLogger::instance().writeEventLog(
+        DDE_EventLogger::EventLoggerData(EVENT_LOGGER_DOCK_CONFIG, QStringLiteral("dock_config"), payload));
+    qCInfo(dockSettingsLog) << "EventLogger: dock config" << reason << payload;
+}
+#endif
+
 static ItemAlignment string2ItenAlignment(const QString& alignmentStr)
 {
     if (alignmentStr == "left")
@@ -136,6 +161,12 @@ DockSettings::DockSettings(QObject* parent)
 {
     m_writeTimer->setSingleShot(true);
     m_writeTimer->setInterval(1000);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    DDE_EventLogger::EventLogger::instance().init("org.deepin.dde.shell", false);
+    qCInfo(dockSettingsLog) << "EventLogger initialized";
+#else
+    qCInfo(dockSettingsLog) << "EventLogger not available (dde-api eventlogger.hpp not found)";
+#endif
     init();
 }
 
@@ -151,6 +182,11 @@ void DockSettings::init()
         m_showInPrimary = m_dockConfig->value(keyShowInPrimary).toBool();
         m_locked = m_dockConfig->value(keyLocked).toBool();
 
+        // Log dock config on startup - merge shell_pos and shell_dock_mode into one log entry
+#ifdef HAVE_DDE_API_EVENTLOGGER
+        logDockConfig(m_dockPosition, m_alignment, QStringLiteral("on startup"));
+#endif
+
         connect(m_dockConfig.data(), &DConfig::valueChanged, this, [this](const QString& key){
             if (keyDockSize == key) {
                 auto size = m_dockConfig->value(keyDockSize).toUInt();
@@ -237,6 +273,9 @@ void DockSettings::setPosition(const Position& position)
     m_dockPosition = position;
     Q_EMIT positionChanged(m_dockPosition);
     addWriteJob(positionJob);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    logDockConfig(position, std::nullopt, QStringLiteral("position changed"));
+#endif
 }
 
 ItemAlignment DockSettings::itemAlignment()
@@ -251,6 +290,9 @@ void DockSettings::setItemAlignment(const ItemAlignment& alignment)
     m_alignment = alignment;
     Q_EMIT itemAlignmentChanged(m_alignment);
     addWriteJob(itemAlignmentJob);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    logDockConfig(std::nullopt, alignment, QStringLiteral("itemAlignment changed"));
+#endif
 }
 
 IndicatorStyle DockSettings::indicatorStyle()
diff --git a/panels/dock/docksettings.h b/panels/dock/docksettings.h
@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2023 UnionTech Software Technology Co., Ltd.
+// SPDX-FileCopyrightText: 2023-2026 UnionTech Software Technology Co., Ltd.
 //
 // SPDX-License-Identifier: GPL-3.0-or-later
 
@@ -10,6 +10,7 @@
 #include <QObject>
 #include <DConfig>
 #include <QScopedPointer>
+#include <optional>
 
 DCORE_USE_NAMESPACE
 
@@ -62,6 +63,9 @@ class DockSettings : public QObject
     void init();
 
     void addWriteJob(WriteJob job);
+#ifdef HAVE_DDE_API_EVENTLOGGER
+    void logDockConfig(std::optional<Position> pos, std::optional<ItemAlignment> align, const QString &reason) const;
+#endif
     inline void checkWriteJob();
 
 Q_SIGNALS:
diff --git a/panels/dock/multitaskview/CMakeLists.txt b/panels/dock/multitaskview/CMakeLists.txt
@@ -28,10 +28,15 @@ qt_generate_wayland_protocol_client_sources(dock-multitaskview
 target_link_libraries(dock-multitaskview PRIVATE
     PkgConfig::WaylandClient
     Qt${QT_VERSION_MAJOR}::WaylandClient
+    Qt${QT_VERSION_MAJOR}::Concurrent
     dde-shell-frame
     dde-shell-dock
 )
 
+if (HAVE_DDE_API_EVENTLOGGER)
+    target_compile_definitions(dock-multitaskview PRIVATE HAVE_DDE_API_EVENTLOGGER)
+endif()
+
 ds_install_package(PACKAGE org.deepin.ds.dock.multitaskview TARGET dock-multitaskview)
 ds_handle_package_translation(PACKAGE org.deepin.ds.dock.multitaskview)
 
diff --git a/panels/dock/multitaskview/multitaskview.cpp b/panels/dock/multitaskview/multitaskview.cpp
diff --git a/panels/dock/taskmanager/CMakeLists.txt b/panels/dock/taskmanager/CMakeLists.txt
diff --git a/panels/dock/taskmanager/taskmanagersettings.cpp b/panels/dock/taskmanager/taskmanagersettings.cpp
diff --git a/panels/dock/taskmanager/taskmanagersettings.h b/panels/dock/taskmanager/taskmanagersettings.h
