Improve UI responsiveness when doing node search #15773

pinzart90 · 2025-01-22T14:41:22Z

Purpose

Run the canvas search in a separate thread to improve UI responsiveness.
This PR was created as an alternative to #15733

Summary of changes:
Moved the Lucene IndexSearcher initialization. Previously it was recreated on every search. Now it is created only after the index is modified.
Run in canvas search in a separate thread (thread pool)
Introduced a cancellation token throughout the search operations
New searches will cancel old ones and only update the UI if the search was successful(not cancelled)
These changes will be under a new feature flag

Left to do:
Add tests
Add to library view search and others (pm search, autocomplete )?

Declarations

Check these if you believe they are true

The codebase is in a better state after this PR
Is documented according to the standards
The level of testing this PR includes is appropriate
User facing strings, if any, are extracted into *.resx files
All tests pass using the self-service CI.
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning and are documented in the API Changes document.
This PR modifies some build requirements and the readme is updated
This PR contains no files larger than 50 MB

Release Notes

(FILL ME IN) Brief description of the fix / enhancement. Use N/A to indicate that the changes in this pull request do not apply to Release Notes. Mandatory section

Reviewers

(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)

(FILL ME IN, optional) Any additional notes to reviewers or testers.

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

pinzart90 · 2025-01-22T14:44:30Z

src/DynamoCore/Utilities/LuceneSearchUtility.cs

+            dirReader = writer != null ? writer.GetReader(applyAllDeletes: true) : DirectoryReader.Open(indexDir);
+            Searcher = new(dirReader);
+        }
+


@RobertGlobant20
I opted to initialize the Searcher (and dirReader) after every index modification that I could find.
Do you think I got them all ?

yes, I think all of them were covered.

github-actions · 2025-01-22T15:21:27Z

UI Smoke Tests

Test: success. 11 passed, 0 failed.
TestComplete Test Result
Workflow Run: UI Smoke Tests
Check: UI Smoke Tests

RobertGlobant20

LGTM with one comment

RobertGlobant20 · 2025-01-22T17:58:25Z

src/DynamoCore/Utilities/LuceneSearchUtility.cs

@@ -627,6 +641,7 @@ internal void AddNodeTypeToSearchIndex(NodeSearchElement node, Document doc)
            SetDocumentFieldValue(doc, nameof(LuceneConfig.NodeFieldsEnum.Parameters), node.Parameters ?? string.Empty);

            writer?.AddDocument(doc);
+            InitializeIndexSearcher();


Not sure if this specific call is needed due that usually after a node info is indexed (or all the nodes info were indexed ) we call CommitWriterChanges() - and this call is already calling the InitializeIndexSearcher() method.

This call is causing Dynamo startup to balloon to more than a minute.

We should have a perf test for this

RobertGlobant20 · 2025-01-22T18:37:18Z

src/DynamoCore/Utilities/LuceneSearchUtility.cs

+            dirReader = writer != null ? writer.GetReader(applyAllDeletes: true) : DirectoryReader.Open(indexDir);
+            Searcher = new(dirReader);
+        }
+


yes, I think all of them were covered.

RobertGlobant20 · 2025-01-22T18:40:29Z

Coudl you add a GIF showing the behavior of InCanvas Search and Library Search?

src/DynamoCoreWpf/ViewModels/Search/SearchViewModel.cs

pinzart90 · 2025-01-22T22:50:05Z

src/DynamoCore/Utilities/LuceneSearchUtility.cs

+        {
+            dirReader = writer != null ? writer.GetReader(applyAllDeletes: true) : DirectoryReader.Open(indexDir);
+            Searcher = new(dirReader);
+        }


not sure if I should lock this, expecting concurrent access to Searcher
All the indexing changes will probably not happen while a user is actively searching ...

src/DynamoCoreWpf/ViewModels/Search/SearchViewModel.cs

mjkkirschner · 2025-01-22T22:52:31Z

src/DynamoCore/Search/NodeSearchModel.cs

        {
-
+            ctk.ThrowIfCancellationRequested();


where do all these get caught?

These get caught by the Task object that wraps the parent caller

Task.Run(() => { return Search(query, searchCancelToken.Token); }

mjkkirschner · 2025-01-22T23:02:04Z

this seems like a pretty good change, not too hard to reason about.
Any idea if concurrent tests are going to cause issues, I remember some kind of past problem with locked index files.

Do you know if Lucene is itself spinning up new threads or using the thread pool, or touts itself as thread safe, or at least not requiring the main thread?

Also, it just makes me think there's probably something interesting we can do with anticipating searches and performing them in parallel using autocomplete info in the future.

aparajit-pratap · 2025-01-23T03:02:11Z

src/DynamoCore/Search/NodeSearchModel.cs

        {
            var result = Entries.Where(e => {
                if (e.Name.Replace(" ", string.Empty).Equals(nodeName) && e.FullCategoryName.Equals(nodeCategory))
                {
+                    ctk.ThrowIfCancellationRequested();


Where is this caught? Why can't the throw be at the start of the FindModel function?

I wanted to short circuit the Where operation as well.
I will actually move it above the if, just to make the operation finish faster in case the if condition is not met

I will put on at the beginning too

src/DynamoCoreWpf/ViewModels/Search/SearchViewModel.cs

src/Tools/DynamoFeatureFlags/FeatureFlagsClient.cs

pinzart90 · 2025-01-30T20:46:52Z

this seems like a pretty good change, not too hard to reason about. Any idea if concurrent tests are going to cause issues, I remember some kind of past problem with locked index files.

Do you know if Lucene is itself spinning up new threads or using the thread pool, or touts itself as thread safe, or at least not requiring the main thread?

Also, it just makes me think there's probably something interesting we can do with anticipating searches and performing them in parallel using autocomplete info in the future.

Thread safety

/// <para/><a name="thread-safety"></a><p><b>NOTE</b>: 
/// <see cref="IndexSearcher"/> instances are completely
/// thread safe, meaning multiple threads can call any of its
/// methods, concurrently.  If your application requires
/// external synchronization, you should <b>not</b>
/// synchronize on the <see cref="IndexSearcher"/> instance;
/// use your own (non-Lucene) objects instead.</p>

chubakueno

Please check the InitializeIndexSearcher call

chubakueno · 2025-02-03T07:25:03Z

src/DynamoCore/Utilities/LuceneSearchUtility.cs

@@ -627,6 +641,7 @@ internal void AddNodeTypeToSearchIndex(NodeSearchElement node, Document doc)
            SetDocumentFieldValue(doc, nameof(LuceneConfig.NodeFieldsEnum.Parameters), node.Parameters ?? string.Empty);

            writer?.AddDocument(doc);
+            InitializeIndexSearcher();


This call is causing Dynamo startup to balloon to more than a minute.

pinzart90 · 2025-02-03T08:02:16Z

Please check the InitializeIndexSearcher call

Yeah, I am going to revert that part of the changes. It seems the indexing is affected even when doing searches (or weights of results, or something similar)

chubakueno · 2025-02-03T08:37:02Z

Please check the InitializeIndexSearcher call

Yeah, I am going to revert that part of the changes. It seems the indexing is affected even when doing searches (or weights of results, or something similar)

Wrote up a quick fix #15797 . Normally i'd send it to the PR author's repo but this is in DynamoDS's so sent it another PR.

Looks great. I'll check if it makes all the tests pass

into searchbar_threading

pinzart90 · 2025-02-03T16:45:04Z

Please check the InitializeIndexSearcher call

Yeah, I am going to revert that part of the changes. It seems the indexing is affected even when doing searches (or weights of results, or something similar)

Wrote up a quick fix #15797 . Normally i'd send it to the PR author's repo but this is in DynamoDS's so sent it another PR.

THanks, that fixed the leftover failures

chubakueno · 2025-02-03T16:57:26Z

Happy to hear that, should we include the ticket number into this PR? DYN-8045. Closed the other PR #15733 .

Please check the InitializeIndexSearcher call

Yeah, I am going to revert that part of the changes. It seems the indexing is affected even when doing searches (or weights of results, or something similar)

Wrote up a quick fix #15797 . Normally i'd send it to the PR author's repo but this is in DynamoDS's so sent it another PR.

THanks, that fixed the leftover failures

pinzart90 · 2025-02-03T20:20:15Z

Performance tests passed https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoPerformance-CI/job/master/2236/

* Bring back search performance improvement (DynamoDS#15789) * Stabilize tests pt2 (DynamoDS#15779) * DYN-7268 Improve UX when IDSDK is not installed on system running Dynamo (DynamoDS#15790) * Improve UI responsiveness when doing node search (DynamoDS#15773) Co-authored-by: chubakueno <[email protected]> --------- Co-authored-by: pinzart90 <[email protected]> Co-authored-by: Ashish Aggarwal <[email protected]> Co-authored-by: chubakueno <[email protected]>

pinzart90 added 3 commits January 21, 2025 13:47

update

ba85860

update

37ba109

update

f731c5f

pinzart90 requested review from RobertGlobant20, mjkkirschner and QilongTang January 22, 2025 14:41

pinzart90 commented Jan 22, 2025

View reviewed changes

RobertGlobant20 approved these changes Jan 22, 2025

View reviewed changes