SocketApi: cleanup debug output
authorDominik Schmidt <dev@dominik-schmidt.de>
Thu, 6 Jun 2019 09:48:31 +0000 (11:48 +0200)
committerKevin Ottens <kevin.ottens@nextcloud.com>
Tue, 15 Dec 2020 09:58:57 +0000 (10:58 +0100)
src/gui/socketapi.cpp
src/gui/socketapi.h

index f33727f463083bdc25e8cf3cb21f4f2f042967a3..5583574a7e4de49a84d8fcfee42bfebcf7b2247f 100644 (file)
 // The first number should be changed if there is an incompatible change that breaks old clients.
 // The second number should be changed when there are new features.
 #define MIRALL_SOCKET_API_VERSION "1.1"
-#define DEBUG qDebug() << "SocketApi: "
 
 namespace {
 #if GUI_TESTING
 
+using namespace OCC;
+
 QList<QObject*> allObjects(const QList<QWidget*> &widgets) {
     QList<QObject*> objects;
     std::copy(widgets.constBegin(), widgets.constEnd(), std::back_inserter(objects));
@@ -96,13 +97,13 @@ QObject *findWidget(const QString &queryString, const QList<QWidget*> &widgets =
     QList<QObject*>::const_iterator foundWidget;
 
     if (queryString.contains('>')) {
-        DEBUG << "queryString contains >";
+        qCDebug(lcSocketApi) << "queryString contains >";
 
         auto subQueries = queryString.split('>', QString::SkipEmptyParts);
         Q_ASSERT(subQueries.count() == 2);
 
         auto parentQueryString = subQueries[0].trimmed();
-        DEBUG << "Find parent: " << parentQueryString;
+        qCDebug(lcSocketApi) << "Find parent: " << parentQueryString;
         auto parent = findWidget(parentQueryString);
 
         if(!parent) {
@@ -111,12 +112,12 @@ QObject *findWidget(const QString &queryString, const QList<QWidget*> &widgets =
 
         auto childQueryString = subQueries[1].trimmed();
         auto child = findWidget(childQueryString, parent->findChildren<QWidget*>());
-        DEBUG << "found child: " << !!child;
+        qCDebug(lcSocketApi) << "found child: " << !!child;
         return child;
 
     } else if(queryString.startsWith('#')) {
         auto objectName = queryString.mid(1);
-        DEBUG << "find objectName: " << objectName;
+        qCDebug(lcSocketApi) << "find objectName: " << objectName;
         foundWidget = std::find_if(objects.constBegin(), objects.constEnd(), [&](QObject *widget) {
             return widget->objectName() == objectName;
         });
@@ -128,7 +129,7 @@ QObject *findWidget(const QString &queryString, const QList<QWidget*> &widgets =
 
         std::for_each(matches.constBegin(), matches.constEnd(), [](QObject* w) {
             if(!w) return;
-            DEBUG << "WIDGET: " << w->objectName() << w->metaObject()->className();
+            qCDebug(lcSocketApi) << "WIDGET: " << w->objectName() << w->metaObject()->className();
         });
 
         if(matches.empty()) {
@@ -1210,10 +1211,10 @@ void SocketApi::command_ASYNC_INVOKE_WIDGET_METHOD(const QSharedPointer<SocketAp
 
 void SocketApi::command_ASYNC_GET_WIDGET_PROPERTY(const QSharedPointer<SocketApiJob> &job)
 {
-    auto widget = findWidget(job->arguments()[QLatin1String("objectName")].toString());
+    QString widgetName = job->arguments()[QLatin1String("objectName")].toString();
+    auto widget = findWidget(widgetName);
     if (!widget) {
-        QString message("Widget not found: 2: ");
-        message.append(job->arguments()["objectName"].toString());
+        QString message = QString(QLatin1String("Widget not found: 2: %1")).arg(widgetName);
         job->reject(message);
         return;
     }
@@ -1231,8 +1232,6 @@ void SocketApi::command_ASYNC_GET_WIDGET_PROPERTY(const QSharedPointer<SocketApi
         if(var.canConvert<QString>()) {
             var.convert(QMetaType::QString);
             value = var.value<QString>();
-
-            DEBUG << "VALUE: " << value;
             break;
         }
 
@@ -1240,7 +1239,9 @@ void SocketApi::command_ASYNC_GET_WIDGET_PROPERTY(const QSharedPointer<SocketApi
         if(tmpObject) {
             currentObject = tmpObject;
         } else {
-            DEBUG << "TODO: object not found, what should happen here now?";
+            QString message = QString(QLatin1String("Widget not found: 3: %1")).arg(widgetName);
+            job->reject(message);
+            return;
         }
     }
 
@@ -1250,9 +1251,11 @@ void SocketApi::command_ASYNC_GET_WIDGET_PROPERTY(const QSharedPointer<SocketApi
 void SocketApi::command_ASYNC_SET_WIDGET_PROPERTY(const QSharedPointer<SocketApiJob> &job)
 {
     auto &arguments = job->arguments();
-    auto widget = findWidget(arguments["objectName"].toString());
+    QString widgetName = arguments["objectName"].toString();
+    auto widget = findWidget(widgetName);
     if (!widget) {
-        job->reject(QLatin1String("widget not found"));
+        QString message = QString(QLatin1String("Widget not found: 4: %1")).arg(widgetName);
+        job->reject(message);
         return;
     }
     widget->setProperty(arguments["property"].toString().toUtf8().constData(),
@@ -1263,9 +1266,11 @@ void SocketApi::command_ASYNC_SET_WIDGET_PROPERTY(const QSharedPointer<SocketApi
 void SocketApi::command_ASYNC_WAIT_FOR_WIDGET_SIGNAL(const QSharedPointer<SocketApiJob> &job)
 {
     auto &arguments = job->arguments();
+    QString widgetName = arguments["objectName"].toString();
     auto widget = findWidget(arguments["objectName"].toString());
     if (!widget) {
-        job->reject(QLatin1String("widget not found"));
+        QString message = QString(QLatin1String("Widget not found: 5: %1")).arg(widgetName);
+        job->reject(message);
         return;
     }
 
@@ -1285,7 +1290,8 @@ void SocketApi::command_ASYNC_TRIGGER_MENU_ACTION(const QSharedPointer<SocketApi
     auto objectName = arguments["objectName"].toString();
     auto widget = findWidget(objectName);
     if (!widget) {
-        job->reject(QLatin1String("widget not found: ") + objectName);
+        QString message = QString(QLatin1String("Object not found: 1: %1")).arg(objectName);
+        job->reject(message);
         return;
     }
 
@@ -1303,15 +1309,15 @@ void SocketApi::command_ASYNC_TRIGGER_MENU_ACTION(const QSharedPointer<SocketApi
         }
     }
 
-    job->reject("Action not found");
+    QString message = QString(QLatin1String("Action not found: 1: %1")).arg(arguments["actionName"].toString());
+    job->reject(message);
 }
 
 void SocketApi::command_ASYNC_ASSERT_ICON_IS_EQUAL(const QSharedPointer<SocketApiJob> &job)
 {
     auto widget = findWidget(job->arguments()[QLatin1String("queryString")].toString());
     if (!widget) {
-        QString message("Widget not found: 37: ");
-        message.append(job->arguments()["objectName"].toString());
+        QString message = QString(QLatin1String("Object not found: 6: %1")).arg(job->arguments()["queryString"].toString());
         job->reject(message);
         return;
     }
@@ -1329,8 +1335,6 @@ void SocketApi::command_ASYNC_ASSERT_ICON_IS_EQUAL(const QSharedPointer<SocketAp
         if(var.canConvert<QIcon>()) {
             var.convert(QMetaType::QIcon);
             value = var.value<QIcon>();
-
-            DEBUG << "VALUE: " << value;
             break;
         }
 
@@ -1338,7 +1342,7 @@ void SocketApi::command_ASYNC_ASSERT_ICON_IS_EQUAL(const QSharedPointer<SocketAp
         if(tmpObject) {
             currentObject = tmpObject;
         } else {
-            DEBUG << "HUH not found .. what do";
+            job->reject(QString(QLatin1String("Icon not found: %1")).arg(propertyName));
         }
     }
 
index 47aaef550fc0006a7d8d6212025d2b72441bfbe8..1c2ef49f72d4b6536ee6a13344d6f439119c6185 100644 (file)
@@ -41,6 +41,8 @@ class SocketListener;
 class DirectEditor;
 class SocketApiJob;
 
+Q_DECLARE_LOGGING_CATEGORY(lcSocketApi)
+
 /**
  * @brief The SocketApi class
  * @ingroup gui