QmlDesigner: Parameterize project storage watcher updater test

Using parameters allows for generating more test combinations. This
reduces the amount of test code needed while increasing coverage.
However, it can also make the test logic more complex.

Fixes: QDS-15280
Change-Id: Iccc018903be4baf0e8e40581c8ae166a529be730
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>

src/plugins/qmldesigner/libs/designercore/projectstorage/projectstorageupdater.cpp

@@ -413,6 +413,7 @@ std::string_view directoryName(std::string_view directoryPath)
 
 void ProjectStorageUpdater::updateDirectoryChanged(Utils::SmallStringView directoryPath,
                                                    Utils::SmallStringView annotationDirectoryPath,
+                                                   FileState directoryState,
                                                    FileState qmldirState,
                                                    FileState annotationDirectoryState,
                                                    SourcePath qmldirSourcePath,
@@ -466,6 +467,7 @@ void ProjectStorageUpdater::updateDirectoryChanged(Utils::SmallStringView direct
                        toImportNames(imports),
                        directoryId,
                        directoryPathAsQString,
+                       directoryState,
                        cppModuleId,
                        package,
                        notUpdatedSourceIds,
@@ -481,11 +483,13 @@ void ProjectStorageUpdater::updateDirectoryChanged(Utils::SmallStringView direct
                        package,
                        notUpdatedSourceIds,
                        WatchedSourceIds,
+                       directoryState,
                        qmldirState,
                        qmldirSourceId,
                        isInsideProject);
     tracer.tick("append updated directory source id", keyValue("module id", moduleId));
-    package.updatedDirectoryInfoDirectoryIds.push_back(directoryId);
+    if (isChanged(directoryState))
+        package.updatedDirectoryInfoDirectoryIds.push_back(directoryId);
 
     if (isInsideProject == IsInsideProject::Yes) {
         if (isExisting(annotationDirectoryState)) {
@@ -689,6 +693,7 @@ void ProjectStorageUpdater::updateDirectory(const Utils::PathString &directoryPa
         tracer.tick("update directory changed");
         updateDirectoryChanged(directoryPath,
                                annotationDirectoryPath,
+                               directoryState,
                                qmldirState,
                                annotationDirectoryState,
                                qmldirPath,
@@ -1027,107 +1032,106 @@ void ProjectStorageUpdater::pathsWithIdsChanged(const std::vector<IdPaths> &chan
                                category(),
                                keyValue("id paths", changedIdPaths)};
 
-    m_changedIdPaths.insert(m_changedIdPaths.end(), changedIdPaths.begin(), changedIdPaths.end());
+    try {
+        m_changedIdPaths.insert(m_changedIdPaths.end(), changedIdPaths.begin(), changedIdPaths.end());
 
-    Storage::Synchronization::SynchronizationPackage package;
+        Storage::Synchronization::SynchronizationPackage package;
 
-    WatchedSourceIds watchedQtSourceIds{10};
+        WatchedSourceIds watchedQtSourceIds{10};
-    WatchedSourceIds watchedProjectSourceIds{10};
+        WatchedSourceIds watchedProjectSourceIds{10};
-    NotUpdatedSourceIds notUpdatedSourceIds{10};
+        NotUpdatedSourceIds notUpdatedSourceIds{10};
-    std::vector<IdPaths> idPaths;
+        std::vector<IdPaths> idPaths;
-    idPaths.reserve(4);
+        idPaths.reserve(4);
 
-    ProjectChunkSourceIds project;
+        ProjectChunkSourceIds project;
-    ProjectChunkSourceIds qt;
+        ProjectChunkSourceIds qt;
 
-    for (const auto &[projectChunkId, sourceIds] : m_changedIdPaths) {
+        for (const auto &[projectChunkId, sourceIds] : m_changedIdPaths) {
-        if (projectChunkId.id == m_projectPartId)
+            if (projectChunkId.id == m_projectPartId)
-            appendProjectChunkSourceIds(project, projectChunkId, sourceIds);
+                appendProjectChunkSourceIds(project, projectChunkId, sourceIds);
-        else if (projectChunkId.id == m_qtPartId)
+            else if (projectChunkId.id == m_qtPartId)
-            appendProjectChunkSourceIds(qt, projectChunkId, sourceIds);
+                appendProjectChunkSourceIds(qt, projectChunkId, sourceIds);
-    }
-
-    auto updateDirectory = [&](const SourceIds &directorySourceIds,
-                               WatchedSourceIds &watchedSourceIds) {
-        auto directoryIds = filterUniqueDirectoryPathIds(directorySourceIds);
-        for (auto directoryId : directoryIds) {
-            Utils::PathString directory = m_pathCache.directoryPath(directoryId);
-            this->updateDirectory(directory,
-                                  directoryIds,
-                                  package,
-                                  notUpdatedSourceIds,
-                                  watchedSourceIds,
-                                  IsInsideProject::No);
         }
 
-        return directoryIds;
+        auto updateDirectory = [&](const SourceIds &directorySourceIds,
-    };
+                                   WatchedSourceIds &watchedSourceIds,
+                                   IsInsideProject isInsideProject) {
+            auto directoryIds = filterUniqueDirectoryPathIds(directorySourceIds);
+            for (auto directoryId : directoryIds) {
+                Utils::PathString directory = m_pathCache.directoryPath(directoryId);
+                this->updateDirectory(directory,
+                                      directoryIds,
+                                      package,
+                                      notUpdatedSourceIds,
+                                      watchedSourceIds,
+                                      isInsideProject);
+            }
 
-    auto qtDirectoryIds = updateDirectory(qt.directory, watchedQtSourceIds);
+            return directoryIds;
-    auto projectDirectoryIds = updateDirectory(project.directory, watchedProjectSourceIds);
+        };
 
-    auto parseQmlComponent = [&](SourceIds qmlDocumentSourceIds,
+        auto qtDirectoryIds = updateDirectory(qt.directory, watchedQtSourceIds, IsInsideProject::No);
+        auto projectDirectoryIds = updateDirectory(project.directory,
+                                                   watchedProjectSourceIds,
+                                                   IsInsideProject::Yes);
+
+        auto parseQmlComponent = [&](SourceIds qmlDocumentSourceIds,
+                                     const DirectoryPathIds &directoryIds,
+                                     IsInsideProject isInsideProject) {
+            for (SourceId sourceId : filterUniqueSourceIds(std::move(qmlDocumentSourceIds))) {
+                if (!contains(directoryIds, sourceId.directoryPathId()))
+                    this->parseQmlComponent(sourceId, package, notUpdatedSourceIds, isInsideProject);
+            }
+        };
+
+        parseQmlComponent(std::move(qt.qmlDocument), qtDirectoryIds, IsInsideProject::No);
+        parseQmlComponent(std::move(project.qmlDocument), projectDirectoryIds, IsInsideProject::Yes);
+
+        auto parseTypeInfo = [&](SourceIds qmltypesSourceIds,
                                  const DirectoryPathIds &directoryIds,
                                  IsInsideProject isInsideProject) {
-        for (SourceId sourceId : filterUniqueSourceIds(std::move(qmlDocumentSourceIds))) {
+            for (SourceId sourceId : filterUniqueSourceIds(std::move(qmltypesSourceIds))) {
-            if (!contains(directoryIds, sourceId.directoryPathId()))
+                if (!contains(directoryIds, sourceId.directoryPathId())) {
-                this->parseQmlComponent(sourceId, package, notUpdatedSourceIds, isInsideProject);
+                    QString qmltypesPath{m_pathCache.sourcePath(sourceId)};
-        }
+                    auto directoryInfo = m_projectStorage.fetchDirectoryInfo(sourceId);
-    };
+                    if (directoryInfo)
-
+                        this->parseTypeInfo(*directoryInfo,
-    parseQmlComponent(std::move(qt.qmlDocument), qtDirectoryIds, IsInsideProject::No);
+                                            qmltypesPath,
-    parseQmlComponent(std::move(project.qmlDocument), projectDirectoryIds, IsInsideProject::Yes);
+                                            package,
-
+                                            notUpdatedSourceIds,
-    auto parseTypeInfo = [&](SourceIds qmltypesSourceIds,
+                                            isInsideProject);
-                             const DirectoryPathIds &directoryIds,
+                }
-                             IsInsideProject isInsideProject) {
-        for (SourceId sourceId : filterUniqueSourceIds(std::move(qmltypesSourceIds))) {
-            if (!contains(directoryIds, sourceId.directoryPathId())) {
-                QString qmltypesPath{m_pathCache.sourcePath(sourceId)};
-                auto directoryInfo = m_projectStorage.fetchDirectoryInfo(sourceId);
-                if (directoryInfo)
-                    this->parseTypeInfo(*directoryInfo,
-                                        qmltypesPath,
-                                        package,
-                                        notUpdatedSourceIds,
-                                        isInsideProject);
             }
-        }
+        };
-    };
 
-    try {
         parseTypeInfo(std::move(qt.qmltypes), qtDirectoryIds, IsInsideProject::No);
         parseTypeInfo(std::move(project.qmltypes), projectDirectoryIds, IsInsideProject::Yes);
-    } catch (const QmlDesigner::CannotParseQmlTypesFile &) {
-        return;
-    }
 
-    package.updatedSourceIds = filterNotUpdatedSourceIds(std::move(package.updatedSourceIds),
+        package.updatedSourceIds = filterNotUpdatedSourceIds(std::move(package.updatedSourceIds),
-                                                         std::move(notUpdatedSourceIds.sourceIds));
+                                                             std::move(notUpdatedSourceIds.sourceIds));
-    package.updatedFileStatusSourceIds = filterNotUpdatedSourceIds(
+        package.updatedFileStatusSourceIds = filterNotUpdatedSourceIds(
-        std::move(package.updatedFileStatusSourceIds),
+            std::move(package.updatedFileStatusSourceIds),
-        std::move(notUpdatedSourceIds.fileStatusSourceIds));
+            std::move(notUpdatedSourceIds.fileStatusSourceIds));
 
-    try {
         m_projectStorage.synchronize(std::move(package));
-    } catch (const ProjectStorageError &) {
+
-        return;
+        auto directoryIdsSize = projectDirectoryIds.size() + qtDirectoryIds.size();
+        if (directoryIdsSize > 0) {
+            DirectoryPathIds directoryIds;
+            std::vector<IdPaths> newIdPaths;
+            idPaths.reserve(8);
+            appendIdPaths(std::move(watchedQtSourceIds), m_qtPartId, newIdPaths);
+            appendIdPaths(std::move(watchedProjectSourceIds), m_projectPartId, newIdPaths);
+
+            directoryIds.reserve(directoryIdsSize);
+            std::ranges::merge(projectDirectoryIds, qtDirectoryIds, std::back_inserter(directoryIds));
+            m_pathWatcher.updateContextIdPaths(newIdPaths, directoryIds);
+        }
+
+        m_changedIdPaths.clear();
+
+    } catch (...) {
     }
-
-    auto directoryIdsSize = projectDirectoryIds.size() + qtDirectoryIds.size();
-    if (directoryIdsSize > 0) {
-        DirectoryPathIds directoryIds;
-        std::vector<IdPaths> newIdPaths;
-        idPaths.reserve(8);
-        appendIdPaths(std::move(watchedQtSourceIds), m_qtPartId, newIdPaths);
-        appendIdPaths(std::move(watchedProjectSourceIds), m_projectPartId, newIdPaths);
-
-        directoryIds.reserve(directoryIdsSize);
-        std::ranges::merge(projectDirectoryIds, qtDirectoryIds, std::back_inserter(directoryIds));
-        m_pathWatcher.updateContextIdPaths(newIdPaths, directoryIds);
-    }
-
-    m_changedIdPaths.clear();
 }
 
 void ProjectStorageUpdater::pathsChanged(const SourceIds &) {}
@@ -1137,6 +1141,7 @@ void ProjectStorageUpdater::parseTypeInfos(const QStringList &typeInfos,
                                            const std::vector<Utils::PathString> &qmldirImports,
                                            DirectoryPathId directoryId,
                                            const QString &directoryPath,
+                                           FileState directoryState,
                                            ModuleId moduleId,
                                            Storage::Synchronization::SynchronizationPackage &package,
                                            NotUpdatedSourceIds &notUpdatedSourceIds,
@@ -1179,7 +1184,7 @@ void ProjectStorageUpdater::parseTypeInfos(const QStringList &typeInfos,
                                    notUpdatedSourceIds,
                                    isInsideProject);
 
-        if (isExisting(state)) {
+        if (isExisting(state) && isChanged(directoryState)) {
             package.directoryInfos.push_back(directoryInfo);
             tracer.tick("append directory info", keyValue("source id", directoryInfo.sourceId));
         }
@@ -1262,6 +1267,7 @@ void ProjectStorageUpdater::parseQmlComponent(Utils::SmallStringView relativeFil
                                               Storage::Synchronization::SynchronizationPackage &package,
                                               NotUpdatedSourceIds &notUpdatedSourceIds,
                                               WatchedSourceIds &watchedSourceIds,
+                                              FileState directoryState,
                                               FileState qmldirState,
                                               SourceId qmldirSourceId,
                                               IsInsideProject isInsideProject)
@@ -1319,9 +1325,11 @@ void ProjectStorageUpdater::parseQmlComponent(Utils::SmallStringView relativeFil
         break;
     }
 
-    const auto &directoryInfo = package.directoryInfos.emplace_back(
+    if (isChanged(directoryState)) {
-        directoryId, sourceId, ModuleId{}, Storage::Synchronization::FileType::QmlDocument);
+        const auto &directoryInfo = package.directoryInfos.emplace_back(
-    tracer.tick("append directory info", keyValue("project data", directoryInfo));
+            directoryId, sourceId, ModuleId{}, Storage::Synchronization::FileType::QmlDocument);
+        tracer.tick("append directory info", keyValue("project data", directoryInfo));
+    }
 
     tracer.tick("append updated source id", keyValue("source id", sourceId));
     package.updatedSourceIds.push_back(sourceId);
@@ -1430,6 +1438,7 @@ void ProjectStorageUpdater::parseQmlComponents(Components components,
                                                Storage::Synchronization::SynchronizationPackage &package,
                                                NotUpdatedSourceIds &notUpdatedSourceIds,
                                                WatchedSourceIds &WatchedSourceIds,
+                                               FileState directoryState,
                                                FileState qmldirState,
                                                SourceId qmldirSourceId,
                                                IsInsideProject isInsideProject)
@@ -1454,6 +1463,7 @@ void ProjectStorageUpdater::parseQmlComponents(Components components,
                           package,
                           notUpdatedSourceIds,
                           WatchedSourceIds,
+                          directoryState,
                           qmldirState,
                           qmldirSourceId,
                           isInsideProject);

src/plugins/qmldesigner/libs/designercore/projectstorage/projectstorageupdater.h

@@ -157,6 +157,7 @@ private:
                               IsInsideProject isInsideProject);
     void updateDirectoryChanged(Utils::SmallStringView directoryPath,
                                 Utils::SmallStringView annotationDirectoryPath,
+                                FileState directoryState,
                                 FileState qmldirState,
                                 FileState annotationDirectoryState,
                                 SourcePath qmldirSourcePath,
@@ -213,6 +214,7 @@ private:
                         const std::vector<Utils::PathString> &qmldirImports,
                         DirectoryPathId directoryId,
                         const QString &directoryPath,
+                        FileState directoryState,
                         ModuleId moduleId,
                         Storage::Synchronization::SynchronizationPackage &package,
                         NotUpdatedSourceIds &notUpdatedSourceIds,
@@ -233,6 +235,7 @@ private:
                             Storage::Synchronization::SynchronizationPackage &package,
                             NotUpdatedSourceIds &notUpdatedSourceIds,
                             WatchedSourceIds &WatchedSourceIds,
+                            FileState directoryState,
                             FileState qmldirState,
                             SourceId qmldirSourceId,
                             IsInsideProject isInsideProject);
@@ -243,6 +246,7 @@ private:
                            Storage::Synchronization::SynchronizationPackage &package,
                            NotUpdatedSourceIds &notUpdatedSourceIds,
                            WatchedSourceIds &WatchedSourceIds,
+                           FileState directoryState,
                            FileState qmldirState,
                            SourceId qmldirSourceId,
                            IsInsideProject isInsideProject);

tests/unit/tests/printers/gtest-creator-printing.cpp

@@ -878,7 +878,7 @@ std::ostream &operator<<(std::ostream &out, const SynchronizationPackage &packag
                << package.updatedPropertyEditorQmlPathDirectoryIds
                << ",\n\t\ttypeAnnotations: " << package.typeAnnotations
                << ",\n\t\tupdatedTypeAnnotationSourceIds: " << package.updatedTypeAnnotationSourceIds
-               << ",\n\t\ttmoduleDependencies: " << package.moduleDependencies
+               << ",\n\t\tmoduleDependencies: " << package.moduleDependencies
                << ",\n\t\tupdatedTypeAnnotationSourceIds: " << package.updatedModuleDependencySourceIds
                << ",\n\t\tmoduleExportedImports: " << package.moduleExportedImports
                << ",\n\t\tupdatedModuleIds: " << package.updatedModuleIds << "\n)";

tests/unit/tests/utils/google-using-declarations.h

@@ -18,6 +18,7 @@ using testing::AtMost;
 using testing::Between;
 using testing::ByMove;
 using testing::ByRef;
+using testing::Combine;
 using testing::Conditional;
 using testing::ContainerEq;
 using testing::Contains;
@@ -62,5 +63,6 @@ using testing::Throw;
 using testing::TypedEq;
 using testing::UnorderedElementsAre;
 using testing::UnorderedElementsAreArray;
+using testing::Values;
 using testing::VariantWith;
 using testing::WithArg;