Skip to content

[stable-3.16] Bugfix/do not crash when propagating changes with move or rename #8199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgallien merged 5 commits into from
Apr 24, 2025
Merged

[stable-3.16] Bugfix/do not crash when propagating changes with move or rename #8199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9c73c97
perf(discovery): optimize empty strings
mgallien Apr 22, 2025
ed48808
feat(discovery): add missing inode info for discovered files
mgallien Apr 22, 2025
5bd6a25
feat(discovery): add more info for renamed items
mgallien Apr 22, 2025
47b3a5c
fix(rename): handle complex rename/move scenario
mgallien Apr 23, 2025
2286255
fix(rename): avoid hitting runtime assert when renaming virtual files
mgallien Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/libsync/discovery.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,8 +573,8 @@ void ProcessDirectoryJob::processFile(PathTuple path,
const auto hasLocal = localEntry.isValid() ? "true" : _queryLocal == ParentNotChanged ? "db" : "false";
const auto serverFileIsLocked = (serverEntry.isValid() ? (serverEntry.locked == SyncFileItem::LockStatus::LockedItem ? "locked" : "not locked") : "");
const auto localFileIsLocked = dbEntry._lockstate._locked ? "locked" : "not locked";
const auto serverFileLockType = serverEntry.isValid() ? QString::number(static_cast<int>(serverEntry.lockOwnerType)) : QStringLiteral("");
const auto localFileLockType = dbEntry._lockstate._locked ? QString::number(static_cast<int>(dbEntry._lockstate._lockOwnerType)) : QStringLiteral("");
const auto serverFileLockType = serverEntry.isValid() ? QString::number(static_cast<int>(serverEntry.lockOwnerType)) : QString{};
const auto localFileLockType = dbEntry._lockstate._locked ? QString::number(static_cast<int>(dbEntry._lockstate._lockOwnerType)) : QString{};

QString processingLog;
QDebug deleteLogger{&processingLog};
Expand All @@ -587,6 +587,7 @@ void ProcessDirectoryJob::processFile(PathTuple path,
<< " | checksum: " << dbEntry._checksumHeader << "//" << serverEntry.checksumHeader
<< " | perm: " << dbEntry._remotePerm << "//" << serverEntry.remotePerm
<< " | fileid: " << dbEntry._fileId << "//" << serverEntry.fileId
<< " | inode: " << dbEntry._inode << "/" << localEntry.inode << "/"
<< " | type: " << dbEntry._type << "/" << localEntry.type << "/" << (serverEntry.isDirectory ? ItemTypeDirectory : ItemTypeFile)
<< " | e2ee: " << dbEntry.isE2eEncrypted() << "/" << serverEntry.isE2eEncrypted()
<< " | e2eeMangledName: " << dbEntry.e2eMangledName() << "/" << serverEntry.e2eMangledName
Expand Down
31 changes: 17 additions & 14 deletions src/libsync/propagatorjobs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,9 @@ void PropagateLocalRename::start()
const auto previousNameInDb = propagator()->adjustRenamedPath(_item->_file);
const auto existingFile = propagator()->fullLocalPath(previousNameInDb);
const auto targetFile = propagator()->fullLocalPath(_item->_renameTarget);
const auto originalFile = propagator()->fullLocalPath(_item->_originalFile);

const auto fileAlreadyMoved = !FileSystem::fileExists(propagator()->fullLocalPath(_item->_originalFile)) && FileSystem::fileExists(existingFile);
const auto fileAlreadyMoved = (!FileSystem::fileExists(originalFile) || !FileSystem::fileExists(existingFile))&& FileSystem::fileExists(targetFile);
auto pinState = OCC::PinState::Unspecified;
if (!fileAlreadyMoved) {
auto pinStateResult = vfs->pinState(propagator()->adjustRenamedPath(_item->_file));
Expand All @@ -315,6 +316,8 @@ void PropagateLocalRename::start()
// if the file is a file underneath a moved dir, the _item->file is equal
// to _item->renameTarget and the file is not moved as a result.
qCDebug(lcPropagateLocalRename) << _item->_file << _item->_renameTarget << _item->_originalFile << previousNameInDb << (fileAlreadyMoved ? "original file has already moved" : "original file is still there");
qCDebug(lcPropagateLocalRename()) << (FileSystem::fileExists(originalFile) ? "original file exists" : "orignal file is missing") << originalFile << _item->_originalFile;
qCDebug(lcPropagateLocalRename()) << (FileSystem::fileExists(existingFile) ? "existing file exists" : "existing file is missing") << existingFile << previousNameInDb;
Q_ASSERT(FileSystem::fileExists(propagator()->fullLocalPath(_item->_originalFile)) || FileSystem::fileExists(existingFile));
if (_item->_file != _item->_renameTarget) {
propagator()->reportProgress(*_item, 0);
Expand Down Expand Up @@ -444,7 +447,7 @@ void PropagateLocalRename::start()

if (fileAlreadyMoved && !deleteOldDbRecord(previousNameInDb)) {
return;
} else if (!deleteOldDbRecord(_item->_originalFile)) {
} else if (!deleteOldDbRecord(previousNameInDb)) {
qCWarning(lcPropagateLocalRename) << "Could not delete file from local DB" << _item->_originalFile;
return;
}
Expand All @@ -470,34 +473,34 @@ void PropagateLocalRename::start()
done(SyncFileItem::SoftError, tr("The file %1 is currently in use").arg(newItem._file), ErrorCategory::GenericError);
return;
}
} else {
const auto dbQueryResult = propagator()->_journal->getFilesBelowPath(oldFile.toUtf8(), [oldFile, this] (const SyncJournalFileRecord &record) -> void {
const auto oldFileName = record._path;
const auto oldFileNameString = QString::fromUtf8(oldFileName);
} else if (!fileAlreadyMoved) {
qCDebug(lcPropagateLocalRename) << "propagate child items after move from" << existingFile << "to" << targetFile;
const auto dbQueryResult = propagator()->_journal->getFilesBelowPath(previousNameInDb.toUtf8(), [previousNameInDb, this] (const SyncJournalFileRecord &record) -> void {
const auto oldFileNameString = propagator()->adjustRenamedPath(QString::fromUtf8(record._path));
auto newFileNameString = oldFileNameString;
newFileNameString.replace(0, oldFile.length(), _item->_renameTarget);
newFileNameString.replace(0, previousNameInDb.length(), _item->_renameTarget);

qCDebug(lcPropagateLocalRename) << "child rename from" << oldFileNameString << "to" << newFileNameString;

if (oldFileNameString == newFileNameString) {
Q_ASSERT(false);
return;
}

SyncJournalFileRecord oldRecord;
if (!propagator()->_journal->getFileRecord(oldFileName, &oldRecord)) {
qCWarning(lcPropagateLocalRename) << "Could not get file from local DB" << oldFileName;
done(SyncFileItem::NormalError, tr("Could not get file %1 from local DB").arg(oldFileNameString), OCC::ErrorCategory::GenericError);
if (!propagator()->_journal->getFileRecord(oldFileNameString, &oldRecord)) {
qCWarning(lcPropagateLocalRename) << "Could not get file from local DB" << oldFileNameString;
return;
}
if (!propagator()->_journal->deleteFileRecord(oldFileName)) {
qCWarning(lcPropagateLocalRename) << "could not delete file from local DB" << oldFileName;
done(SyncFileItem::NormalError, tr("Could not delete file record %1 from local DB").arg(oldFileNameString), OCC::ErrorCategory::GenericError);
if (!propagator()->_journal->deleteFileRecord(oldFileNameString)) {
qCWarning(lcPropagateLocalRename) << "could not delete file from local DB" << oldFileNameString;
return;
}

const auto newItem = SyncFileItem::fromSyncJournalFileRecord(oldRecord);
newItem->_file = newFileNameString;
const auto result = propagator()->updateMetadata(*newItem);
if (!result) {
done(SyncFileItem::FatalError, tr("Error updating metadata: %1").arg(result.error()), OCC::ErrorCategory::GenericError);
return;
}
});
Expand Down
6 changes: 5 additions & 1 deletion src/libsync/syncfilestatustracker.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,11 @@ void SyncFileStatusTracker::slotAboutToPropagate(SyncFileItemVector &items)
std::swap(_syncProblems, oldProblems);

for (const auto &item : std::as_const(items)) {
qCInfo(lcStatusTracker) << "Investigating" << item->destination() << item->_status << item->_instruction << item->_direction;
if (item->_instruction == CSyncEnums::CSYNC_INSTRUCTION_RENAME) {
qCInfo(lcStatusTracker) << "Investigating" << item->destination() << item->_status << item->_instruction << item->_direction << item->_file << item->_originalFile << item->_renameTarget;
} else {
qCInfo(lcStatusTracker) << "Investigating" << item->destination() << item->_status << item->_instruction << item->_direction;
}
_dirtyPaths.remove(item->destination());

if (hasErrorStatus(*item)) {
Expand Down
29 changes: 29 additions & 0 deletions test/testsynccfapi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1486,6 +1486,35 @@ private slots:
QVERIFY(itemInstruction(completeSpy, odtFile, CSYNC_INSTRUCTION_UPDATE_METADATA));
QCOMPARE(*vfs->pinState(odtFile), PinState::Unspecified);
}

void renameOnBothSides()
{
FakeFolder fakeFolder { FileInfo::A12_B12_C12_S12() };
auto vfs = setupVfs(fakeFolder);

// Test that renaming a file within a directory that was renamed on the other side actually do a rename.

// 1) move the folder alphabetically before
fakeFolder.remoteModifier().rename("A/a1", "A/a1m");
fakeFolder.localModifier().rename("A", "_A");
fakeFolder.localModifier().rename("B/b1", "B/b1m");
fakeFolder.remoteModifier().rename("B", "_B");

QVERIFY(fakeFolder.syncOnce());
QCOMPARE(fakeFolder.currentRemoteState(), fakeFolder.currentRemoteState());
QVERIFY(fakeFolder.currentRemoteState().find("_A/a1m"));
QVERIFY(fakeFolder.currentRemoteState().find("_B/b1m"));

// 2) move alphabetically after
fakeFolder.remoteModifier().rename("_A/a2", "_A/a2m");
fakeFolder.localModifier().rename("_B/b2", "_B/b2m");
fakeFolder.localModifier().rename("_A", "S/A");
fakeFolder.remoteModifier().rename("_B", "S/B");
QVERIFY(fakeFolder.syncOnce());
QCOMPARE(fakeFolder.currentRemoteState(), fakeFolder.currentRemoteState());
QVERIFY(fakeFolder.currentRemoteState().find("S/A/a2m"));
QVERIFY(fakeFolder.currentRemoteState().find("S/B/b2m"));
}
};

QTEST_GUILESS_MAIN(TestSyncCfApi)
Expand Down
55 changes: 55 additions & 0 deletions test/testsyncmove.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1317,6 +1317,61 @@ private slots:
QCOMPARE(counter.nMKCOL, 0);
QCOMPARE(fakeFolder.currentLocalState(), fakeFolder.currentRemoteState());
}

void testRenameComplexScenarioNoRecordLeak()
{
FakeFolder fakeFolder{FileInfo{}};

QCOMPARE(fakeFolder.currentLocalState(), fakeFolder.currentRemoteState());

fakeFolder.remoteModifier().mkdir("0");
fakeFolder.remoteModifier().mkdir("0/00 without file");
fakeFolder.remoteModifier().mkdir("0/00 without file/project");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/a");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/a/a with file");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/a/a without file");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/a/aa with file");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/00 with file");
fakeFolder.remoteModifier().mkdir("0/00 without file/project/new without file");
fakeFolder.remoteModifier().insert("0/00 without file/project/00 with file/test.md");
fakeFolder.remoteModifier().insert("0/00 without file/project/a/a with file/test.md");
fakeFolder.remoteModifier().insert("0/00 without file/project/a/aa with file/test.md");

QVERIFY(fakeFolder.syncOnce());

auto itemsCounter = 0;
auto dbResult = fakeFolder.syncJournal().getFilesBelowPath("", [&itemsCounter] (const SyncJournalFileRecord&) -> void { ++itemsCounter; });

QVERIFY(dbResult);
QCOMPARE(itemsCounter, 12);

fakeFolder.remoteModifier().rename("0/00 without file/project", "project tests");
fakeFolder.remoteModifier().rename("project tests/a", "project tests/a empty");
fakeFolder.remoteModifier().rename("project tests/a empty/a with file", "project tests/a with file");
fakeFolder.remoteModifier().rename("project tests/a empty/a without file", "project tests/a without file");
fakeFolder.remoteModifier().rename("project tests/a empty/aa with file", "project tests/aa with file");
fakeFolder.remoteModifier().rename("project tests/new without file", "project tests/new without file");
fakeFolder.remoteModifier().rename("0/00 without file", "project tests/00 without file");
fakeFolder.remoteModifier().rename("0", "project tests/z 0 empty");

connect(&fakeFolder.syncEngine(), &OCC::SyncEngine::itemCompleted, this, [&fakeFolder] () {
auto itemsCounter = 0;
auto dbResult = fakeFolder.syncJournal().getFilesBelowPath("", [&itemsCounter] (const SyncJournalFileRecord&) -> void { ++itemsCounter; });

QVERIFY(dbResult);
if (itemsCounter > 12) {
QVERIFY(itemsCounter <= 12);
}
});

QVERIFY(fakeFolder.syncOnce());

itemsCounter = 0;
dbResult = fakeFolder.syncJournal().getFilesBelowPath("", [&itemsCounter] (const SyncJournalFileRecord&) -> void { ++itemsCounter; });

QVERIFY(dbResult);
QCOMPARE(itemsCounter, 12);
}
};

QTEST_GUILESS_MAIN(TestSyncMove)
Expand Down