store index atomically and via shared_ptr

carlos-zamora · carlos-zamora · commit 5da5177f2d27 · 2026-02-17T14:06:09.000-08:00
diff --git a/src/cascadia/TerminalSettingsEditor/SearchIndex.cpp b/src/cascadia/TerminalSettingsEditor/SearchIndex.cpp
@@ -54,13 +54,13 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 
     Editor::FilteredSearchResult FilteredSearchResult::CreateNoResultsItem(const winrt::hstring& query)
     {
-        return winrt::make<FilteredSearchResult>(nullptr, nullptr, hstring{ fmt::format(fmt::runtime(std::wstring{ RS_(L"Search_NoResults") }), query) });
+        return winrt::make<FilteredSearchResult>(nullptr, nullptr, nullptr, hstring{ fmt::format(fmt::runtime(std::wstring{ RS_(L"Search_NoResults") }), query) });
     }
 
     // Creates a FilteredSearchResult with the given search index entry and runtime object.
     // The resulting search result will have a label like "<ProfileName>: <display text>" or "<ProfileName>".
     // This is so that we can reuse the display text from the search index, but also add additional context to which runtime object this search result maps to.
-    Editor::FilteredSearchResult FilteredSearchResult::CreateRuntimeObjectItem(const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj)
+    Editor::FilteredSearchResult FilteredSearchResult::CreateRuntimeObjectItem(std::shared_ptr<const IndexData> indexData, const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj)
     {
         hstring runtimeObjLabel{};
         hstring runtimeObjContext{};
@@ -96,14 +96,14 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
             // - primaryText: <displayText>
             // - secondaryText: <runtimeObjLabel>
             // navigates to setting container
-            return winrt::make<FilteredSearchResult>(searchIndexEntry, runtimeObj, displayText, runtimeObjLabel);
+            return winrt::make<FilteredSearchResult>(indexData, searchIndexEntry, runtimeObj, displayText, runtimeObjLabel);
         }
         // Partial index entry (for runtime object main pages)
         // - primaryText: <runtimeObjLabel>
         // - secondaryText: <runtimeObjContext>
         // "PowerShell" --> navigates to main runtime object page (i.e. Profiles_Base)
         // "SSH" | "Extension" --> navigates to main runtime object page (i.e. Extensions > SSH)
-        return winrt::make<FilteredSearchResult>(searchIndexEntry, runtimeObj, runtimeObjLabel, runtimeObjContext);
+        return winrt::make<FilteredSearchResult>(indexData, searchIndexEntry, runtimeObj, runtimeObjLabel, runtimeObjContext);
     }
 
     winrt::hstring FilteredSearchResult::AccessibleName() const
@@ -277,7 +277,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         indexData.colorSchemeIndexEntry.Entry = &PartialColorSchemeIndexEntry();
         indexData.actionIndexEntry.Entry = &PartialActionIndexEntry();
 
-        _index = std::move(indexData);
+        _index.store(std::make_shared<const IndexData>(std::move(indexData)));
     }
 
     // Method Description:
@@ -301,6 +301,16 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                                                                                                    const IVectorView<Editor::ExtensionPackageViewModel> extensionPkgVMs,
                                                                                                    const IVectorView<Editor::CommandViewModel> commandVMs)
     {
+        // Snapshot the current index so that Reset() can safely swap
+        // it without invalidating pointers used by this search.
+        const auto index = _index.load();
+        wil::hide_name _index;
+        if (!index)
+        {
+            // invalid search; do not return any results
+            co_return single_threaded_observable_vector<Windows::Foundation::IInspectable>();
+        }
+
         co_await winrt::resume_background();
 
         // The search can be cancelled at any time by the caller.
@@ -309,7 +319,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         const auto filter = fzf::matcher::ParsePattern(std::wstring_view{ query });
 
         std::vector<std::pair<int, Editor::FilteredSearchResult>> scoredResults;
-        for (const auto& entry : _index.mainIndex)
+        for (const auto& entry : index->mainIndex)
         {
             if (cancellationToken())
             {
@@ -331,7 +341,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 
             if (bestScore >= MinimumMatchScore)
             {
-                scoredResults.emplace_back(bestScore, winrt::make<FilteredSearchResult>(&entry));
+                scoredResults.emplace_back(bestScore, winrt::make<FilteredSearchResult>(index, &entry));
             }
         }
 
@@ -358,7 +368,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                 {
                     // navigates to runtime object main page (i.e. "PowerShell" Profiles_Base page)
                     scoredResults.emplace_back(objNameMatch->Score * WeightRuntimeObjectMatch,
-                                               FilteredSearchResult::CreateRuntimeObjectItem(&partialSearchIndexEntry, runtimeObj));
+                                               FilteredSearchResult::CreateRuntimeObjectItem(index, &partialSearchIndexEntry, runtimeObj));
                 }
 
                 for (const auto& entry : searchIndex)
@@ -409,15 +419,15 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                     {
                         // navigates to runtime object's setting (i.e. "PowerShell: Command line")
                         scoredResults.emplace_back(bestScore * WeightRuntimeObjectSetting,
-                                                   FilteredSearchResult::CreateRuntimeObjectItem(&entry, runtimeObj));
+                                                   FilteredSearchResult::CreateRuntimeObjectItem(index, &entry, runtimeObj));
                     }
                 }
             }
         };
 
-        appendRuntimeObjectResults(profileVMs, _index.profileIndex, _index.profileIndexEntry);
-        appendRuntimeObjectResults(ntmFolderVMs, _index.ntmFolderIndex, _index.ntmFolderIndexEntry);
-        appendRuntimeObjectResults(colorSchemeVMs, _index.colorSchemeIndex, _index.colorSchemeIndexEntry);
+        appendRuntimeObjectResults(profileVMs, index->profileIndex, index->profileIndexEntry);
+        appendRuntimeObjectResults(ntmFolderVMs, index->ntmFolderIndex, index->ntmFolderIndexEntry);
+        appendRuntimeObjectResults(colorSchemeVMs, index->colorSchemeIndex, index->colorSchemeIndexEntry);
 
         // Simple runtime object matching (no associated search index, just match by display name)
         auto appendSimpleRuntimeObjectResults = [&](const auto& runtimeObjectList, const LocalizedIndexEntry& indexEntry, auto getDisplayName) {
@@ -432,13 +442,13 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
                 {
                     // navigates to runtime object page (i.e. "Copy Text" --> Actions > EditAction page)
                     scoredResults.emplace_back(match->Score * WeightRuntimeObjectMatch,
-                                               FilteredSearchResult::CreateRuntimeObjectItem(&indexEntry, runtimeObj));
+                                               FilteredSearchResult::CreateRuntimeObjectItem(index, &indexEntry, runtimeObj));
                 }
             }
         };
 
-        appendSimpleRuntimeObjectResults(extensionPkgVMs, _index.extensionIndexEntry, [](const auto& ext) { return ext.DisplayName(); });
-        appendSimpleRuntimeObjectResults(commandVMs, _index.actionIndexEntry, [](const auto& cmd) { return cmd.DisplayName(); });
+        appendSimpleRuntimeObjectResults(extensionPkgVMs, index->extensionIndexEntry, [](const auto& ext) { return ext.DisplayName(); });
+        appendSimpleRuntimeObjectResults(commandVMs, index->actionIndexEntry, [](const auto& cmd) { return cmd.DisplayName(); });
 
         // must be IInspectable to be used as ItemsSource in XAML
         std::vector<Windows::Foundation::IInspectable> results;
diff --git a/src/cascadia/TerminalSettingsEditor/SearchIndex.h b/src/cascadia/TerminalSettingsEditor/SearchIndex.h
@@ -24,17 +24,38 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         std::array<std::pair<std::optional<winrt::hstring>, int>, 2> GetSearchableFields() const;
     };
 
+    // Data backing the search index. Shared via shared_ptr so that
+    // in-flight search results keep their snapshot alive even after
+    // the index is rebuilt by Reset().
+    struct IndexData
+    {
+        // Basic index data loaded from GeneratedSettingsIndex.g.h and wrapped as LocalizedIndexEntry objects.
+        // Non-main indices are duplicated at runtime when searching for runtime objects.
+        std::vector<LocalizedIndexEntry> mainIndex;
+        std::vector<LocalizedIndexEntry> profileIndex;
+        std::vector<LocalizedIndexEntry> ntmFolderIndex;
+        std::vector<LocalizedIndexEntry> colorSchemeIndex;
+
+        // Links to main page; used when searching runtime objects
+        LocalizedIndexEntry profileIndexEntry;
+        LocalizedIndexEntry ntmFolderIndexEntry;
+        LocalizedIndexEntry colorSchemeIndexEntry;
+        LocalizedIndexEntry extensionIndexEntry;
+        LocalizedIndexEntry actionIndexEntry;
+    };
+
     // WinRT object representing a single filtered search result
     struct FilteredSearchResult : FilteredSearchResultT<FilteredSearchResult>
     {
-        FilteredSearchResult(const LocalizedIndexEntry* entry, const Windows::Foundation::IInspectable& navigationArgOverride = nullptr, const std::optional<hstring>& label = std::nullopt, const hstring secondaryLabel = {}) :
+        FilteredSearchResult(std::shared_ptr<const IndexData> indexData, const LocalizedIndexEntry* entry, const Windows::Foundation::IInspectable& navigationArgOverride = nullptr, const std::optional<hstring>& label = std::nullopt, const hstring secondaryLabel = {}) :
+            _indexData{ std::move(indexData) },
             _SearchIndexEntry{ entry },
             _NavigationArgOverride{ navigationArgOverride },
             _overrideLabel{ label },
             _secondaryLabel{ secondaryLabel } {}
 
         static Editor::FilteredSearchResult CreateNoResultsItem(const winrt::hstring& query);
-        static Editor::FilteredSearchResult CreateRuntimeObjectItem(const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj);
+        static Editor::FilteredSearchResult CreateRuntimeObjectItem(std::shared_ptr<const IndexData> indexData, const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj);
 
         hstring ToString() { return AccessibleName(); }
         winrt::hstring AccessibleName() const;
@@ -46,6 +67,9 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
         Windows::UI::Xaml::Controls::IconElement Icon() const;
 
     private:
+        // Prevent the IndexData (and the LocalizedIndexEntry objects within)
+        // from being freed while this search result is still alive.
+        const std::shared_ptr<const IndexData> _indexData;
         const std::optional<winrt::hstring> _overrideLabel{ std::nullopt };
         const winrt::hstring _secondaryLabel{};
         const Windows::Foundation::IInspectable _NavigationArgOverride{ nullptr };
@@ -79,23 +103,6 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 
     private:
         SearchIndex() = default;
-        struct IndexData
-        {
-            IndexData& operator=(const IndexData& other) = default;
-
-            // Basic index data loaded from GeneratedSettingsIndex.g.h and wrapped as LocalizedIndexEntry objects.
-            // Non-main indices are duplicated at runtime when searching for runtime objects.
-            std::vector<LocalizedIndexEntry> mainIndex;
-            std::vector<LocalizedIndexEntry> profileIndex;
-            std::vector<LocalizedIndexEntry> ntmFolderIndex;
-            std::vector<LocalizedIndexEntry> colorSchemeIndex;
-
-            // Links to main page; used when searching runtime objects
-            LocalizedIndexEntry profileIndexEntry;
-            LocalizedIndexEntry ntmFolderIndexEntry;
-            LocalizedIndexEntry colorSchemeIndexEntry;
-            LocalizedIndexEntry extensionIndexEntry;
-            LocalizedIndexEntry actionIndexEntry;
-        } _index;
+        std::atomic<std::shared_ptr<const IndexData>> _index;
     };
 }

Original file line number	Diff line number	Diff line change
`@@ -54,13 +54,13 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`54`	`54`
`55`	`55`	`Editor::FilteredSearchResult FilteredSearchResult::CreateNoResultsItem(const winrt::hstring& query)`
`56`	`56`	`{`
`57`		`- return winrt::make<FilteredSearchResult>(nullptr, nullptr, hstring{ fmt::format(fmt::runtime(std::wstring{ RS_(L"Search_NoResults") }), query) });`
	`57`	`+ return winrt::make<FilteredSearchResult>(nullptr, nullptr, nullptr, hstring{ fmt::format(fmt::runtime(std::wstring{ RS_(L"Search_NoResults") }), query) });`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`// Creates a FilteredSearchResult with the given search index entry and runtime object.`
`61`	`61`	`// The resulting search result will have a label like "<ProfileName>: <display text>" or "<ProfileName>".`
`62`	`62`	`// This is so that we can reuse the display text from the search index, but also add additional context to which runtime object this search result maps to.`
`63`		`- Editor::FilteredSearchResult FilteredSearchResult::CreateRuntimeObjectItem(const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj)`
	`63`	`+ Editor::FilteredSearchResult FilteredSearchResult::CreateRuntimeObjectItem(std::shared_ptr<const IndexData> indexData, const LocalizedIndexEntry* searchIndexEntry, const Windows::Foundation::IInspectable& runtimeObj)`
`64`	`64`	`{`
`65`	`65`	`hstring runtimeObjLabel{};`
`66`	`66`	`hstring runtimeObjContext{};`
`@@ -96,14 +96,14 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`96`	`96`	`// - primaryText: <displayText>`
`97`	`97`	`// - secondaryText: <runtimeObjLabel>`
`98`	`98`	`// navigates to setting container`
`99`		`- return winrt::make<FilteredSearchResult>(searchIndexEntry, runtimeObj, displayText, runtimeObjLabel);`
	`99`	`+ return winrt::make<FilteredSearchResult>(indexData, searchIndexEntry, runtimeObj, displayText, runtimeObjLabel);`
`100`	`100`	`}`
`101`	`101`	`// Partial index entry (for runtime object main pages)`
`102`	`102`	`// - primaryText: <runtimeObjLabel>`
`103`	`103`	`// - secondaryText: <runtimeObjContext>`
`104`	`104`	`// "PowerShell" --> navigates to main runtime object page (i.e. Profiles_Base)`
`105`	`105`	`// "SSH" \| "Extension" --> navigates to main runtime object page (i.e. Extensions > SSH)`
`106`		`- return winrt::make<FilteredSearchResult>(searchIndexEntry, runtimeObj, runtimeObjLabel, runtimeObjContext);`
	`106`	`+ return winrt::make<FilteredSearchResult>(indexData, searchIndexEntry, runtimeObj, runtimeObjLabel, runtimeObjContext);`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`winrt::hstring FilteredSearchResult::AccessibleName() const`
`@@ -277,7 +277,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`277`	`277`	`indexData.colorSchemeIndexEntry.Entry = &PartialColorSchemeIndexEntry();`
`278`	`278`	`indexData.actionIndexEntry.Entry = &PartialActionIndexEntry();`
`279`	`279`
`280`		`- _index = std::move(indexData);`
	`280`	`+ _index.store(std::make_shared<const IndexData>(std::move(indexData)));`
`281`	`281`	`}`
`282`	`282`
`283`	`283`	`// Method Description:`
`@@ -301,6 +301,16 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`301`	`301`	`const IVectorView<Editor::ExtensionPackageViewModel> extensionPkgVMs,`
`302`	`302`	`const IVectorView<Editor::CommandViewModel> commandVMs)`
`303`	`303`	`{`
	`304`	`+ // Snapshot the current index so that Reset() can safely swap`
	`305`	`+ // it without invalidating pointers used by this search.`
	`306`	`+ const auto index = _index.load();`
	`307`	`+ wil::hide_name _index;`
	`308`	`+ if (!index)`
	`309`	`+ {`
	`310`	`+ // invalid search; do not return any results`
	`311`	`+ co_return single_threaded_observable_vector<Windows::Foundation::IInspectable>();`
	`312`	`+ }`
	`313`	`+`
`304`	`314`	`co_await winrt::resume_background();`
`305`	`315`
`306`	`316`	`// The search can be cancelled at any time by the caller.`
`@@ -309,7 +319,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`309`	`319`	`const auto filter = fzf::matcher::ParsePattern(std::wstring_view{ query });`
`310`	`320`
`311`	`321`	`std::vector<std::pair<int, Editor::FilteredSearchResult>> scoredResults;`
`312`		`- for (const auto& entry : _index.mainIndex)`
	`322`	`+ for (const auto& entry : index->mainIndex)`
`313`	`323`	`{`
`314`	`324`	`if (cancellationToken())`
`315`	`325`	`{`
`@@ -331,7 +341,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`331`	`341`
`332`	`342`	`if (bestScore >= MinimumMatchScore)`
`333`	`343`	`{`
`334`		`- scoredResults.emplace_back(bestScore, winrt::make<FilteredSearchResult>(&entry));`
	`344`	`+ scoredResults.emplace_back(bestScore, winrt::make<FilteredSearchResult>(index, &entry));`
`335`	`345`	`}`
`336`	`346`	`}`
`337`	`347`
`@@ -358,7 +368,7 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`358`	`368`	`{`
`359`	`369`	`// navigates to runtime object main page (i.e. "PowerShell" Profiles_Base page)`
`360`	`370`	`scoredResults.emplace_back(objNameMatch->Score * WeightRuntimeObjectMatch,`
`361`		`- FilteredSearchResult::CreateRuntimeObjectItem(&partialSearchIndexEntry, runtimeObj));`
	`371`	`+ FilteredSearchResult::CreateRuntimeObjectItem(index, &partialSearchIndexEntry, runtimeObj));`
`362`	`372`	`}`
`363`	`373`
`364`	`374`	`for (const auto& entry : searchIndex)`
`@@ -409,15 +419,15 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`409`	`419`	`{`
`410`	`420`	`// navigates to runtime object's setting (i.e. "PowerShell: Command line")`
`411`	`421`	`scoredResults.emplace_back(bestScore * WeightRuntimeObjectSetting,`
`412`		`- FilteredSearchResult::CreateRuntimeObjectItem(&entry, runtimeObj));`
	`422`	`+ FilteredSearchResult::CreateRuntimeObjectItem(index, &entry, runtimeObj));`
`413`	`423`	`}`
`414`	`424`	`}`
`415`	`425`	`}`
`416`	`426`	`};`
`417`	`427`
`418`		`- appendRuntimeObjectResults(profileVMs, _index.profileIndex, _index.profileIndexEntry);`
`419`		`- appendRuntimeObjectResults(ntmFolderVMs, _index.ntmFolderIndex, _index.ntmFolderIndexEntry);`
`420`		`- appendRuntimeObjectResults(colorSchemeVMs, _index.colorSchemeIndex, _index.colorSchemeIndexEntry);`
	`428`	`+ appendRuntimeObjectResults(profileVMs, index->profileIndex, index->profileIndexEntry);`
	`429`	`+ appendRuntimeObjectResults(ntmFolderVMs, index->ntmFolderIndex, index->ntmFolderIndexEntry);`
	`430`	`+ appendRuntimeObjectResults(colorSchemeVMs, index->colorSchemeIndex, index->colorSchemeIndexEntry);`
`421`	`431`
`422`	`432`	`// Simple runtime object matching (no associated search index, just match by display name)`
`423`	`433`	`auto appendSimpleRuntimeObjectResults = [&](const auto& runtimeObjectList, const LocalizedIndexEntry& indexEntry, auto getDisplayName) {`
`@@ -432,13 +442,13 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation`
`432`	`442`	`{`
`433`	`443`	`// navigates to runtime object page (i.e. "Copy Text" --> Actions > EditAction page)`
`434`	`444`	`scoredResults.emplace_back(match->Score * WeightRuntimeObjectMatch,`
`435`		`- FilteredSearchResult::CreateRuntimeObjectItem(&indexEntry, runtimeObj));`
	`445`	`+ FilteredSearchResult::CreateRuntimeObjectItem(index, &indexEntry, runtimeObj));`
`436`	`446`	`}`
`437`	`447`	`}`
`438`	`448`	`};`
`439`	`449`
`440`		`- appendSimpleRuntimeObjectResults(extensionPkgVMs, _index.extensionIndexEntry, [](const auto& ext) { return ext.DisplayName(); });`
`441`		`- appendSimpleRuntimeObjectResults(commandVMs, _index.actionIndexEntry, [](const auto& cmd) { return cmd.DisplayName(); });`
	`450`	`+ appendSimpleRuntimeObjectResults(extensionPkgVMs, index->extensionIndexEntry, [](const auto& ext) { return ext.DisplayName(); });`
	`451`	`+ appendSimpleRuntimeObjectResults(commandVMs, index->actionIndexEntry, [](const auto& cmd) { return cmd.DisplayName(); });`
`442`	`452`
`443`	`453`	`// must be IInspectable to be used as ItemsSource in XAML`
`444`	`454`	`std::vector<Windows::Foundation::IInspectable> results;`