DYN-8045: Fix hanged node search when the user types faster than search #15733
+250
−34
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| using System; | ||
|
|
||
| namespace Dynamo.Wpf.Utilities | ||
| { | ||
| public static class JobDebouncer | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. Added a class summary description. The PR as currently is already unifies both library (sidebar) and incontext node search into using the debouncer, but I can't find more instances of a debouncer being used in c# code (there are some in html/js webview code though).
chubakueno marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| public class DebounceQueueToken | ||
| { | ||
| public long LastExecutionId = 0; | ||
| public SerialQueue SerialQueue = new(); | ||
| }; | ||
| /// <summary> | ||
| /// Action <paramref name="job"/> is guaranteed to run at most once for every call, and exactly once after the last call. | ||
| /// Execution is sequential, and optional jobs that share a <see cref="DebounceQueueToken"/> with a newer optional job will be ignored. | ||
| /// </summary> | ||
| /// <param name="job"></param> | ||
| /// <param name="token"></param> | ||
| /// <returns></returns> | ||
| public static void EnqueueOptionalJobAsync(Action job, DebounceQueueToken token) | ||
| { | ||
| lock (token) | ||
| { | ||
| token.LastExecutionId++; | ||
| var myExecutionId = token.LastExecutionId; | ||
| token.SerialQueue.DispatchAsync(() => | ||
| { | ||
| if (myExecutionId < token.LastExecutionId) return; | ||
| job(); | ||
| }); | ||
| } | ||
| } | ||
| public static void EnqueueMandatoryJobAsync(Action job, DebounceQueueToken token) | ||
| { | ||
| lock (token) | ||
| { | ||
| token.SerialQueue.DispatchAsync(() => | ||
| { | ||
| job(); | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| //https://github.com/gentlee/SerialQueue/blob/master/SerialQueue/SerialQueue.cs | ||
|
There was a problem hiding this comment. @QilongTang do we need to update the about box for this? |
||
| using System; | ||
| using System.Threading; | ||
|
|
||
| namespace Dynamo.Wpf.Utilities | ||
| { | ||
| public class SerialQueue | ||
chubakueno marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| class LinkedListNode(Action action) | ||
| { | ||
| public readonly Action Action = action; | ||
| public LinkedListNode Next; | ||
| } | ||
|
|
||
| public event Action<Action, Exception> UnhandledException = delegate { }; | ||
|
|
||
| private LinkedListNode _queueFirst; | ||
| private LinkedListNode _queueLast; | ||
| private bool _isRunning = false; | ||
|
|
||
| public void DispatchAsync(Action action) | ||
| { | ||
| var newNode = new LinkedListNode(action); | ||
|
|
||
| lock (this) | ||
| { | ||
| if (_queueFirst == null) | ||
| { | ||
| _queueFirst = newNode; | ||
| _queueLast = newNode; | ||
|
|
||
| if (!_isRunning) | ||
| { | ||
| _isRunning = true; | ||
| ThreadPool.QueueUserWorkItem(Run); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| _queueLast!.Next = newNode; | ||
| _queueLast = newNode; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void Run(object _) | ||
| { | ||
| while (true) | ||
| { | ||
| LinkedListNode firstNode; | ||
|
|
||
| lock (this) | ||
| { | ||
| if (_queueFirst == null) | ||
| { | ||
| _isRunning = false; | ||
| return; | ||
| } | ||
| firstNode = _queueFirst; | ||
| _queueFirst = null; | ||
| _queueLast = null; | ||
| } | ||
|
|
||
| while (firstNode != null) | ||
| { | ||
| var action = firstNode.Action; | ||
| firstNode = firstNode.Next; | ||
| try | ||
| { | ||
| action(); | ||
| } | ||
| catch (Exception error) | ||
| { | ||
| UnhandledException.Invoke(action, error); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this still required in addition to the search operations taking a lock out on the queue token?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The lock is in case Search is used in parallel. As of now that could only happen if the user searches in the library and workspace simultaneously, since both have independent serial queues. We could mandate a unified search queue (for library, inCanvasSearch, and in the future) or have this lock to allow several search queues in parallel.