feat(GODT-2261): sync progress in GUI.

internal/frontend/bridge-gui/bridge-gui-tester/CMakeLists.txt

@@ -49,6 +49,48 @@ qt_standard_project_setup()
 message(STATUS "Using Qt ${Qt6_VERSION}")
 
 
+#*****************************************************************************************************************************************************
+# bridgelib
+#*****************************************************************************************************************************************************
+find_program(GO_BIN "go")
+if (NOT GO_BIN)
+    message(FATAL_ERROR "Could not location go compiler")
+endif()
+message(STATUS "go compiler is ${GO_BIN}")
+
+if (APPLE) # set some env variable for go compiler on macOS. Note the CGO_ENABLED=1 is required when cross-compiling.
+    if (CMAKE_OSX_ARCHITECTURES STREQUAL "arm64")
+        set(GO_BIN "MACOSX_DEPLOYMENT_TARGET=11.0" "GOARCH=arm64" "CGO_CFLAGS=\"-mmacosx-version-min=11.0\"" CGO_ENABLED=1 ${GO_BIN})
+    else ()
+        set(GO_BIN "MACOSX_DEPLOYMENT_TARGET=10.15" "GOARCH=amd64" "CGO_CFLAGS=\"-mmacosx-version-min=10.15\"" CGO_ENABLED=1 ${GO_BIN})
+    endif()
+endif()
+
+file(REAL_PATH "pkg/bridgelib" BRIDGELIB_DIR BASE_DIRECTORY  "${BRIDGE_REPO_ROOT}")
+message(STATUS "bridgelib folder is ${BRIDGELIB_DIR}")
+
+set(BRIDGELIB_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(BRIDGELIB_BASE_NAME "bridgelib")
+if (UNIX AND NOT APPLE)
+    set(BRIDGELIB_LIB_FILE "${BRIDGELIB_BASE_NAME}.so")
+endif()
+if (APPLE)
+    set(BRIDGELIB_LIB_FILE "${BRIDGELIB_BASE_NAME}.dylib")
+endif()
+if (WIN32)
+    set(BRIDGELIB_LIB_FILE "${BRIDGELIB_BASE_NAME}.dll")
+endif()
+
+set(BRIDGELIB_OUTPUT_PATH "${BRIDGELIB_OUTPUT_DIR}/${BRIDGELIB_LIB_FILE}")
+
+add_custom_target(
+    bridgelib
+    COMMAND ${GO_BIN} build -o ${BRIDGELIB_OUTPUT_PATH} --buildmode c-shared
+    WORKING_DIRECTORY ${BRIDGELIB_DIR}
+    COMMENT "Compile bridgelib library"
+)
+
+
 #*****************************************************************************************************************************************************
 # Source files and output
 #*****************************************************************************************************************************************************
@@ -72,6 +114,8 @@ add_executable(bridge-gui-tester
     UserTable.cpp UserTable.h
     )
 
+add_dependencies(bridge-gui-tester bridgelib)
+
 target_precompile_headers(bridge-gui-tester PRIVATE Pch.h)
 target_include_directories(bridge-gui-tester PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
 target_compile_definitions(bridge-gui-tester PRIVATE BRIDGE_APP_VERSION=\"${BRIDGE_APP_VERSION}\")

internal/frontend/bridge-gui/bridge-gui-tester/GRPCServerWorker.cpp

@@ -19,6 +19,7 @@
 #include "GRPCServerWorker.h"
 #include "Cert.h"
 #include "GRPCService.h"
+#include <bridgepp/BridgeLib.h>
 #include <bridgepp/Exception/Exception.h>
 #include <bridgepp/GRPC/GRPCUtils.h>
 #include <bridgepp/GRPC/GRPCConfig.h>
@@ -33,7 +34,6 @@ using namespace grpc;
 //****************************************************************************************************************************************************
 GRPCServerWorker::GRPCServerWorker(QObject *parent)
     : Worker(parent) {
-
 }
 
 
@@ -81,7 +81,7 @@ void GRPCServerWorker::run() {
 
         config.port = port;
         QString err;
-        if (!config.save(grpcServerConfigPath(), &err)) {
+        if (!config.save(grpcServerConfigPath(bridgelib::userConfigDir()), &err)) {
             throw Exception(QString("Could not save gRPC server config. %1").arg(err));
         }
 

internal/frontend/bridge-gui/bridge-gui-tester/GRPCService.cpp

@@ -192,17 +192,6 @@ Status GRPCService::IsAllMailVisible(ServerContext *, Empty const *request, Bool
 }
 
 
-//****************************************************************************************************************************************************
-/// \param[out] response The response.
-/// \return The status for the call.
-//****************************************************************************************************************************************************
-Status GRPCService::GoOs(ServerContext *, Empty const *, StringValue *response) {
-    app().log().debug(__FUNCTION__);
-    response->set_value(app().mainWindow().settingsTab().os().toStdString());
-    return Status::OK;
-}
-
-
 //****************************************************************************************************************************************************
 /// \return The status for the call.
 //****************************************************************************************************************************************************

internal/frontend/bridge-gui/bridge-gui-tester/GRPCService.h

@@ -51,7 +51,6 @@ public: // member functions.
     grpc::Status IsBetaEnabled(::grpc::ServerContext *, ::google::protobuf::Empty const *, ::google::protobuf::BoolValue *response) override;
     grpc::Status SetIsAllMailVisible(::grpc::ServerContext *context, ::google::protobuf::BoolValue const *request, ::google::protobuf::Empty *response) override;
     grpc::Status IsAllMailVisible(::grpc::ServerContext *context, ::google::protobuf::Empty const *request, ::google::protobuf::BoolValue *response) override;
-    grpc::Status GoOs(::grpc::ServerContext *, ::google::protobuf::Empty const *, ::google::protobuf::StringValue *response) override;
     grpc::Status TriggerReset(::grpc::ServerContext *, ::google::protobuf::Empty const *, ::google::protobuf::Empty *) override;
     grpc::Status Version(::grpc::ServerContext *, ::google::protobuf::Empty const *, ::google::protobuf::StringValue *response) override;
     grpc::Status LogsPath(::grpc::ServerContext *, ::google::protobuf::Empty const *, ::google::protobuf::StringValue *response) override;

internal/frontend/bridge-gui/bridge-gui-tester/Tabs/SettingsTab.cpp

@@ -18,6 +18,7 @@
 
 #include "SettingsTab.h"
 #include "GRPCService.h"
+#include <bridgepp/BridgeLib.h>
 #include <bridgepp/GRPC/EventFactory.h>
 #include <bridgepp/BridgeUtils.h>
 
@@ -438,7 +439,7 @@ void SettingsTab::resetUI() {
     this->setClientPlatform("Unknown");
 
     ui_.editVersion->setText(BRIDGE_APP_VERSION);
-    ui_.comboOS->setCurrentText(bridgepp::goos());
+    ui_.comboOS->setCurrentText(bridgelib::goos());
     ui_.editCurrentEmailClient->setText("Thunderbird/102.0.3");
     ui_.checkShowOnStartup->setChecked(true);
     ui_.checkShowSplashScreen->setChecked(false);

internal/frontend/bridge-gui/bridge-gui-tester/Tabs/UsersTab.cpp

@@ -55,6 +55,8 @@ UsersTab::UsersTab(QWidget *parent)
     connect(ui_.buttonImapLoginFailed, &QPushButton::clicked, this, &UsersTab::onSendIMAPLoginFailedEvent);
     connect(ui_.buttonUsedBytesChanged, &QPushButton::clicked, this, &UsersTab::onSendUsedBytesChangedEvent);
     connect(ui_.checkUsernamePasswordError, &QCheckBox::toggled, this, &UsersTab::updateGUIState);
+    connect(ui_.checkSync, &QCheckBox::toggled, this, &UsersTab::onCheckSyncToggled);
+    connect(ui_.sliderSync, &QSlider::valueChanged, this, &UsersTab::onSliderSyncValueChanged);
 
     users_.append(randomUser());
 
@@ -217,9 +219,19 @@ void UsersTab::updateGUIState() {
     ui_.groupBoxUsedSpace->setEnabled(hasSelectedUser && (UserState::Connected == state));
     ui_.editUsernamePasswordError->setEnabled(ui_.checkUsernamePasswordError->isChecked());
     ui_.spinUsedBytes->setValue(user ? user->usedBytes() : 0.0);
+    ui_.groupboxSync->setEnabled(user.get());
 
     if (user)
         ui_.editIMAPLoginFailedUsername->setText(user->primaryEmailOrUsername());
+
+    QSignalBlocker b(ui_.checkSync);
+    bool const syncing = user && user->isSyncing();
+    ui_.checkSync->setChecked(syncing);
+    b = QSignalBlocker(ui_.sliderSync);
+    ui_.sliderSync->setEnabled(syncing);
+    qint32 const progressPercent = syncing ? qint32(user->syncProgress() * 100.0f) : 0;
+    ui_.sliderSync->setValue(progressPercent);
+    ui_.labelSync->setText(syncing ? QString("%1%").arg(progressPercent) : "" );
 }
 
 
@@ -398,3 +410,44 @@ void UsersTab::configureUserAppleMail(QString const &userID, QString const &addr
     app().log().info(QString("Apple mail configuration was requested for user %1, address %2").arg(userID, address));
 
 }
+
+
+//****************************************************************************************************************************************************
+/// \param[in] checked Is the sync checkbox checked?
+//****************************************************************************************************************************************************
+void UsersTab::onCheckSyncToggled(bool checked) {
+    SPUser const user = this->selectedUser();
+    if ((!user) || (user->isSyncing() == checked)) {
+        return;
+    }
+
+    user->setIsSyncing(checked);
+    user->setSyncProgress(0.0);
+    GRPCService &grpc = app().grpc();
+
+    // we do not apply delay for these event.
+    if (checked) {
+        grpc.sendEvent(newSyncStartedEvent(user->id()));
+        grpc.sendEvent(newSyncProgressEvent(user->id(), 0.0, 1, 1));
+    } else {
+        grpc.sendEvent(newSyncFinishedEvent(user->id()));
+    }
+
+    this->updateGUIState();
+}
+
+
+//****************************************************************************************************************************************************
+/// \param[in] value The value for the slider.
+//****************************************************************************************************************************************************
+void UsersTab::onSliderSyncValueChanged(int value) {
+    SPUser const user = this->selectedUser();
+    if ((!user) || (!user->isSyncing()) || user->syncProgress() == value) {
+        return;
+    }
+
+    double const progress = value / 100.0;
+    user->setSyncProgress(progress);
+    app().grpc().sendEvent(newSyncProgressEvent(user->id(), progress, 1, 1));  // we do not simulate elapsed & remaining.
+    this->updateGUIState();
+}

internal/frontend/bridge-gui/bridge-gui-tester/Tabs/UsersTab.h

@@ -54,7 +54,6 @@ public slots:
     void logoutUser(QString const &userID); ///< slot for the logging out of a user.
     void removeUser(QString const &userID); ///< Slot for the removal of a user.
     void configureUserAppleMail(QString const &userID, QString const &address); ///< Slot for the configuration of Apple mail.
-
 private slots:
     void onAddUserButton(); ///< Add a user to the user list.
     void onEditUserButton(); ///< Edit the currently selected user.
@@ -63,6 +62,8 @@ private slots:
     void onSendUserBadEvent(); ///< Slot for the 'Send Bad Event Error' button.
     void onSendUsedBytesChangedEvent(); ///< Slot for the 'Send Used Bytes Changed Event' button.
     void onSendIMAPLoginFailedEvent(); ///< Slot for the 'Send IMAP Login failure Event' button.
+    void onCheckSyncToggled(bool checked); ///< Slot for the 'Synchronizing' check box.
+    void onSliderSyncValueChanged(int value); ///< Slot for the sync 'Progress' slider.
     void updateGUIState(); ///< Update the GUI state.
 
 private: // member functions.

internal/frontend/bridge-gui/bridge-gui-tester/Tabs/UsersTab.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>1225</width>
-    <height>717</height>
+    <width>1221</width>
+    <height>894</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -66,6 +66,52 @@
        </property>
       </spacer>
      </item>
+     <item>
+      <widget class="QGroupBox" name="groupboxSync">
+       <property name="minimumSize">
+        <size>
+         <width>0</width>
+         <height>0</height>
+        </size>
+       </property>
+       <property name="title">
+        <string>Sync</string>
+       </property>
+       <layout class="QVBoxLayout" name="verticalLayout_5">
+        <item>
+         <layout class="QHBoxLayout" name="horizontalLayout_4" stretch="1,0">
+          <item>
+           <widget class="QCheckBox" name="checkSync">
+            <property name="text">
+             <string>Synchronizing</string>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QLabel" name="labelSync">
+            <property name="text">
+             <string>0%</string>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </item>
+        <item>
+         <widget class="QSlider" name="sliderSync">
+          <property name="maximum">
+           <number>100</number>
+          </property>
+          <property name="orientation">
+           <enum>Qt::Horizontal</enum>
+          </property>
+          <property name="tickInterval">
+           <number>10</number>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </widget>
+     </item>
      <item>
       <widget class="QGroupBox" name="groupBoxBadEvent">
        <property name="minimumSize">

internal/frontend/bridge-gui/bridge-gui-tester/main.cpp

@@ -19,6 +19,7 @@
 #include "MainWindow.h"
 #include "AppController.h"
 #include "GRPCServerWorker.h"
+#include <bridgepp/BridgeLib.h>
 #include <bridgepp/Exception/Exception.h>
 #include <bridgepp/Worker/Overseer.h>
 
@@ -54,6 +55,8 @@ int main(int argc, char **argv) {
         QApplication::setOrganizationDomain("proton.ch");
         QApplication::setQuitOnLastWindowClosed(true);
 
+        bridgelib::loadLibrary();
+
         Log &log = app().log();
         log.setEchoInConsole(true);
         log.setLevel(Log::Level::Debug);
@@ -85,7 +88,10 @@ int main(int argc, char **argv) {
         return exitCode;
     }
     catch (Exception const &e) {
-        QTextStream(stderr) << QString("A fatal error occurred: %1\n").arg(e.qwhat());
+        QString message = e.qwhat();
+        if (!e.details().isEmpty())
+            message += "\n\nDetails:\n" + e.details();
+        QTextStream(stderr) << QString("A fatal error occurred: %1\n").arg(message);
         return EXIT_FAILURE;
     }
 }