Add reason parameter to sync abort methods

src/gui/accountsettings.cpp

@@ -609,7 +609,7 @@ void AccountSettings::slotEnableCurrentFolder(bool terminate)
         // message box can return at any time while the thread keeps running,
         // so better check again after the user has responded.
         if (folder->isSyncRunning() && terminate) {
-            folder->slotTerminateSync();
+            folder->slotTerminateSync(tr("Sync paused by user"));
         }
         folder->slotNextSyncFullLocalDiscovery(); // ensure we don't forget about local errors
         folder->setSyncPaused(!currentlyPaused);
@@ -645,7 +645,7 @@ void AccountSettings::slotForceSyncCurrentFolder()
         // Terminate and reschedule any running sync
         for (auto *folder : FolderMan::instance()->folders()) {
             if (folder->isSyncRunning()) {
-                folder->slotTerminateSync();
+                folder->slotTerminateSync(tr("User triggered force sync"));
                 FolderMan::instance()->scheduler()->enqueueFolder(folder);
             }
         }

src/gui/folder.cpp

@@ -806,7 +806,8 @@ void Folder::setVirtualFilesEnabled(bool enabled)
         };
         if (isSyncRunning()) {
             connect(this, &Folder::syncFinished, this, finalizeVfsSwitch, Qt::SingleShotConnection);
-            slotTerminateSync();
+            QString reason;
+            slotTerminateSync(tr("Switching VFS mode on folder '%1'").arg(displayName()));
         } else {
             finalizeVfsSwitch();
         }
@@ -879,12 +880,12 @@ bool Folder::isFileExcludedRelative(const QString &relativePath) const
     return isFileExcludedAbsolute(path() + relativePath);
 }
 
-void Folder::slotTerminateSync()
+void Folder::slotTerminateSync(const QString &reason)
 {
     if (isReady()) {
         qCInfo(lcFolder) << "folder " << path() << " Terminating!";
         if (_engine->isSyncRunning()) {
-            _engine->abort();
+            _engine->abort(reason);
             setSyncState(SyncResult::SyncAbortRequested);
         }
     }

src/gui/folder.h

@@ -362,7 +362,7 @@ public slots:
     /**
        * terminate the current sync run
        */
-    void slotTerminateSync();
+    void slotTerminateSync(const QString &reason);
 
     // connected to the corresponding signals in the SyncEngine
     void slotAboutToRemoveAllFiles(SyncFileItem::Direction);

src/gui/folderman.cpp

@@ -387,7 +387,7 @@ void FolderMan::slotIsConnectedChanged()
             if (f
                 && f->isSyncRunning()
                 && f->accountState() == accountState) {
-                f->slotTerminateSync();
+                f->slotTerminateSync(tr("Account disconnected or paused"));
             }
         }
     }
@@ -602,7 +602,7 @@ void FolderMan::removeFolder(Folder *f)
     const bool currentlyRunning = f->isSyncRunning();
     if (currentlyRunning) {
         // abort the sync now
-        f->slotTerminateSync();
+        f->slotTerminateSync(tr("Folder is about to be removed"));
     }
 
     f->setSyncPaused(true);

src/gui/folderstatusmodel.cpp

@@ -938,7 +938,7 @@ void FolderStatusModel::slotApplySelectiveSync()
         const auto changes = (oldBlackListSet - blackListSet) + (blackListSet - oldBlackListSet);
         if (!changes.isEmpty()) {
             if (folder->isSyncRunning()) {
-                folder->slotTerminateSync();
+                folder->slotTerminateSync(tr("Selective sync list changed"));
             }
             //The part that changed should not be read from the DB on next sync because there might be new folders
             // (the ones that are no longer in the blacklist)
@@ -1219,7 +1219,7 @@ void FolderStatusModel::slotSyncAllPendingBigFolders()
 
         // Trigger a sync
         if (folder->isSyncRunning()) {
-            folder->slotTerminateSync();
+            folder->slotTerminateSync(tr("User triggered sync-all for selective synced folder"));
         }
         // The part that changed should not be read from the DB on next sync because there might be new folders
         // (the ones that are no longer in the blacklist)

src/gui/owncloudgui.cpp

@@ -943,7 +943,7 @@ void ownCloudGui::setPauseOnAllFoldersHelper(const QList<AccountStatePtr> &accou
         if (accounts.contains(f->accountState())) {
             f->setSyncPaused(pause);
             if (pause) {
-                f->slotTerminateSync();
+                f->slotTerminateSync(tr("User paused sync for account '%1'").arg(f->accountState()->account()->displayName()));
             }
         }
     }

src/libsync/syncengine.cpp

@@ -84,7 +84,7 @@ SyncEngine::SyncEngine(AccountPtr account, const QUrl &baseUrl, const QString &l
 SyncEngine::~SyncEngine()
 {
     _goingDown = true;
-    abort();
+    abort(tr("application exit", "abort reason"));
     _excludedFiles.reset();
 }
 
@@ -855,7 +855,7 @@ bool SyncEngine::shouldDiscoverLocally(const QString &path) const
     return false;
 }
 
-void SyncEngine::abort()
+void SyncEngine::abort(const QString &reason)
 {
     bool aborting = false;
     if (_propagator) {
@@ -871,7 +871,7 @@ void SyncEngine::abort()
     if (aborting) {
         qCInfo(lcEngine) << "Aborting sync";
         if (!_goingDown) {
-            Q_EMIT syncError(tr("Aborted"));
+            Q_EMIT syncError(tr("Aborted due to %1").arg(reason));
         }
         finalize(false);
     }

src/libsync/syncengine.h

@@ -72,8 +72,8 @@ class OWNCLOUDSYNC_EXPORT SyncEngine : public QObject
     Q_INVOKABLE void startSync();
     void setNetworkLimits(int upload, int download);
 
-    /* Abort the sync.  Called from the main thread */
-    void abort();
+    /* Abort the sync. Called from the main thread */
+    void abort(const QString &reason);
 
     bool isSyncRunning() const { return _syncRunning; }
 

test/testchunkingng.cpp

@@ -34,7 +34,7 @@ void partialUpload(FakeFolder &fakeFolder, const QString &name, quint64 size)
                                     [&](const ProgressInfo &progress) {
                 if (progress.completedSize() > (progress.totalSize() /3 )) {
                     sizeWhenAbort = progress.completedSize();
-                    fakeFolder.syncEngine().abort();
+                    fakeFolder.syncEngine().abort({});
                 }
     });
 
@@ -248,7 +248,7 @@ private slots:
         const auto responseDelay = 24h; // bigger than abort-wait timeout
         fakeFolder.setServerOverride([&](QNetworkAccessManager::Operation op, const QNetworkRequest &request, QIODevice *) -> QNetworkReply * {
             if (request.attribute(QNetworkRequest::CustomVerbAttribute).toByteArray() == "MOVE") {
-                QTimer::singleShot(50ms, &parent, [&]() { fakeFolder.syncEngine().abort(); });
+                QTimer::singleShot(50ms, &parent, [&]() { fakeFolder.syncEngine().abort({}); });
                 moveChecksumHeader = request.rawHeader("OC-Checksum");
                 return new DelayedReply<FakeChunkMoveReply>(responseDelay, fakeFolder.uploadState(), fakeFolder.remoteModifier(), op, request, &parent);
             } else if (op == QNetworkAccessManager::GetOperation) {
@@ -345,7 +345,7 @@ private slots:
         const auto responseDelay = 200ms; // smaller than abort-wait timeout
         fakeFolder.setServerOverride([&](QNetworkAccessManager::Operation op, const QNetworkRequest &request, QIODevice *) -> QNetworkReply * {
             if (request.attribute(QNetworkRequest::CustomVerbAttribute).toByteArray() == "MOVE") {
-                QTimer::singleShot(50ms, &parent, [&]() { fakeFolder.syncEngine().abort(); });
+                QTimer::singleShot(50ms, &parent, [&]() { fakeFolder.syncEngine().abort({}); });
                 // while the response is delayed, the move is performed in the constructor, thus it happens immediately
                 return new DelayedReply<FakeChunkMoveReply>(responseDelay, fakeFolder.uploadState(), fakeFolder.remoteModifier(), op, request, &parent);
             }

test/testdownload.cpp

@@ -214,7 +214,10 @@ private slots:
         });
 
         bool timedOut = false;
-        QTimer::singleShot(10s, &fakeFolder.syncEngine(), [&]() { timedOut = true; fakeFolder.syncEngine().abort(); });
+        QTimer::singleShot(10s, &fakeFolder.syncEngine(), [&]() {
+            timedOut = true;
+            fakeFolder.syncEngine().abort({});
+        });
         if (filesAreDehydrated) {
             QVERIFY(fakeFolder.applyLocalModificationsAndSync()); // Success, because files are never downloaded
         } else {

test/testsyncengine.cpp

@@ -779,7 +779,7 @@ private slots:
         // wait until the sync engine is ready
         // wait a second and abort
         connect(&fakeFolder.syncEngine(), &SyncEngine::aboutToPropagate, &fakeFolder.syncEngine(),
-            [&]() { QTimer::singleShot(1s, &fakeFolder.syncEngine(), [&]() { fakeFolder.syncEngine().abort(); }); });
+            [&]() { QTimer::singleShot(1s, &fakeFolder.syncEngine(), [&]() { fakeFolder.syncEngine().abort({}); }); });
         QVERIFY(!fakeFolder.applyLocalModificationsAndSync());
 
         QCOMPARE(counter->nPUT, 3);