[PT Run] Results only for plugin with longest matching activation phrase (#15132)

* first try to fix with new idea

* small changes

* [PT Run] Updated QuryBuilder unit tests

* [PT Run] Updated QueryBuilder test

* [PT Run] Updated QueryBuilder test name

* Improvements

* Improve readability of test

* Improve Query-Tests for spellcheck

* clean expect.txt

Co-authored-by: cyberrex5 <ghassanjad2004@gmail.com>
This commit is contained in:
Heiko
2021-12-27 17:00:07 +01:00
committed by GitHub
parent 7ac7e48e66
commit 979d3c6011
3 changed files with 52 additions and 28 deletions

View File

@@ -1,7 +1,5 @@
aaaa aaaa
abcd
abcdef abcdef
abcdefgh
ABCDEFGHIJKLMNOPQRSTUVWXYZ ABCDEFGHIJKLMNOPQRSTUVWXYZ
abgr abgr
abi abi
@@ -496,7 +494,6 @@ editkeyboardwindow
editorconfig editorconfig
EDITSHORTCUTS EDITSHORTCUTS
editshortcutswindow editshortcutswindow
efgh
EFile EFile
egistry egistry
ekus ekus

View File

@@ -18,20 +18,37 @@ namespace PowerLauncher.Plugin
} }
text = text.Trim(); text = text.Trim();
int longestActionKeywordLength = 0;
// This Dictionary contains the corresponding query for each plugin // This Dictionary contains the corresponding query for each plugin
Dictionary<PluginPair, Query> pluginQueryPair = new Dictionary<PluginPair, Query>(); Dictionary<PluginPair, Query> pluginQueryPair = new Dictionary<PluginPair, Query>();
foreach (var plugin in PluginManager.NonGlobalPlugins) foreach (var nonGlobalPlugin in PluginManager.NonGlobalPlugins)
{ {
var pluginActionKeyword = plugin.Metadata.ActionKeyword; var pluginActionKeyword = nonGlobalPlugin.Metadata.ActionKeyword;
if (plugin.Metadata.Disabled || !text.StartsWith(pluginActionKeyword, StringComparison.Ordinal)) if (nonGlobalPlugin.Metadata.Disabled || !text.StartsWith(pluginActionKeyword, StringComparison.Ordinal))
{ {
continue; continue;
} }
// Save the length of the longest matching keyword for later use
if (pluginActionKeyword.Length > longestActionKeywordLength)
{
longestActionKeywordLength = pluginActionKeyword.Length;
}
// A new query is constructed for each plugin // A new query is constructed for each plugin
var query = new Query(text, pluginActionKeyword); var query = new Query(text, pluginActionKeyword);
pluginQueryPair.TryAdd(plugin, query); pluginQueryPair.TryAdd(nonGlobalPlugin, query);
}
// If we have plugin action keywords that start with the same char we get false positives (Example: ? and ??)
// Here we remove each query pair that has a shorter keyword than the longest matching one
foreach (PluginPair plugin in pluginQueryPair.Keys)
{
if (plugin.Metadata.ActionKeyword.Length < longestActionKeywordLength)
{
pluginQueryPair.Remove(plugin);
}
} }
// If the user has specified a matching action keyword, then do not // If the user has specified a matching action keyword, then do not

View File

@@ -16,6 +16,11 @@ namespace Wox.Test
{ {
private static bool AreEqual(Query firstQuery, Query secondQuery) private static bool AreEqual(Query firstQuery, Query secondQuery)
{ {
if (firstQuery is null && secondQuery is null)
{
return true;
}
// Using Ordinal since this is used internally // Using Ordinal since this is used internally
return firstQuery.ActionKeyword.Equals(secondQuery.ActionKeyword, StringComparison.Ordinal) return firstQuery.ActionKeyword.Equals(secondQuery.ActionKeyword, StringComparison.Ordinal)
&& firstQuery.Search.Equals(secondQuery.Search, StringComparison.Ordinal) && firstQuery.Search.Equals(secondQuery.Search, StringComparison.Ordinal)
@@ -69,8 +74,8 @@ namespace Wox.Test
plugin, plugin,
}); });
var firstQueryText = "asearch"; var firstQueryText = "aSearch";
var secondQueryText = "a search"; var secondQueryText = "a Search";
// Act // Act
var firstPluginQueryPair = QueryBuilder.Build(firstQueryText); var firstPluginQueryPair = QueryBuilder.Build(firstQueryText);
@@ -86,12 +91,13 @@ namespace Wox.Test
} }
[TestMethod] [TestMethod]
public void QueryBuildShouldGenerateCorrectQueryForPluginsWhoseActionKeywordsHaveSamePrefix() public void QueryBuildShouldGenerateQueriesOnlyForPluginsWhoseActionKeywordsAreLongestIfMultipleMatch()
{ {
// Arrange // Arrange
string searchQuery = "abcdefgh"; string firstSearchQuery = "MyKeyword";
var firstPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "ab", ID = "plugin1" }); string secondSearchQuery = "My Keyword";
var secondPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "abcd", ID = "plugin2" }); var firstPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "My", ID = "plugin1" });
var secondPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "MyKey", ID = "plugin2" });
PluginManager.SetAllPlugins(new List<PluginPair>() PluginManager.SetAllPlugins(new List<PluginPair>()
{ {
firstPlugin, firstPlugin,
@@ -99,46 +105,50 @@ namespace Wox.Test
}); });
// Act // Act
var pluginQueryPairs = QueryBuilder.Build(searchQuery); var firstSearchQueryPluginPair = QueryBuilder.Build(firstSearchQuery);
var firstSearchQueryFirstPlugin = firstSearchQueryPluginPair.GetValueOrDefault(firstPlugin);
var firstSearchQuerySecondPlugin = firstSearchQueryPluginPair.GetValueOrDefault(secondPlugin);
var firstQuery = pluginQueryPairs.GetValueOrDefault(firstPlugin); var secondSearchQueryPluginPair = QueryBuilder.Build(secondSearchQuery);
var secondQuery = pluginQueryPairs.GetValueOrDefault(secondPlugin); var secondSearchQueryFirstPlugin = secondSearchQueryPluginPair.GetValueOrDefault(firstPlugin);
var secondSearchQuerySecondPlugin = secondSearchQueryPluginPair.GetValueOrDefault(secondPlugin);
// Assert // Assert
Assert.IsTrue(AreEqual(firstQuery, new Query(searchQuery, firstPlugin.Metadata.ActionKeyword))); Assert.IsTrue(AreEqual(firstSearchQueryFirstPlugin, null));
Assert.IsTrue(AreEqual(secondQuery, new Query(searchQuery, secondPlugin.Metadata.ActionKeyword))); Assert.IsTrue(AreEqual(firstSearchQuerySecondPlugin, new Query(firstSearchQuery, secondPlugin.Metadata.ActionKeyword)));
Assert.IsTrue(AreEqual(secondSearchQueryFirstPlugin, new Query(secondSearchQuery, firstPlugin.Metadata.ActionKeyword)));
Assert.IsTrue(AreEqual(secondSearchQuerySecondPlugin, null));
} }
[TestMethod] [TestMethod]
public void QueryBuilderShouldSetTermsCorrectlyWhenCalled() public void QueryBuilderShouldSetTermsCorrectlyWhenCalled()
{ {
// Arrange // Arrange
string searchQuery = "abcd efgh"; string searchQuery = "MyTest search term";
var firstPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "ab", ID = "plugin1" }); var plugin = new PluginPair(new PluginMetadata { ActionKeyword = "My", ID = "plugin1" });
var secondPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "abcd", ID = "plugin2" });
PluginManager.SetAllPlugins(new List<PluginPair>() PluginManager.SetAllPlugins(new List<PluginPair>()
{ {
firstPlugin, plugin,
secondPlugin,
}); });
// Act // Act
var pluginQueryPairs = QueryBuilder.Build(searchQuery); var pluginQueryPairs = QueryBuilder.Build(searchQuery);
var firstQuery = pluginQueryPairs.GetValueOrDefault(firstPlugin); var builtQuery = pluginQueryPairs.GetValueOrDefault(plugin);
var secondQuery = pluginQueryPairs.GetValueOrDefault(secondPlugin);
// Assert // Assert
// Using Ordinal since this is used internally // Using Ordinal since this is used internally
Assert.IsTrue(firstQuery.Terms[0].Equals("cd", StringComparison.Ordinal) && firstQuery.Terms[1].Equals("efgh", StringComparison.Ordinal) && firstQuery.Terms.Count == 2); Assert.IsTrue(builtQuery.Terms.Count == 3
Assert.IsTrue(secondQuery.Terms[0].Equals("efgh", StringComparison.Ordinal) && secondQuery.Terms.Count == 1); && builtQuery.Terms[0].Equals("Test", StringComparison.Ordinal)
&& builtQuery.Terms[1].Equals("search", StringComparison.Ordinal)
&& builtQuery.Terms[2].Equals("term", StringComparison.Ordinal));
} }
[TestMethod] [TestMethod]
public void QueryBuilderShouldReturnAllPluginsWithTheActionWord() public void QueryBuilderShouldReturnAllPluginsWithTheActionWord()
{ {
// Arrange // Arrange
string searchQuery = "!efgh"; string searchQuery = "!Query";
var firstPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "!", ID = "plugin1" }); var firstPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "!", ID = "plugin1" });
var secondPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "!", ID = "plugin2" }); var secondPlugin = new PluginPair(new PluginMetadata { ActionKeyword = "!", ID = "plugin2" });
PluginManager.SetAllPlugins(new List<PluginPair>() PluginManager.SetAllPlugins(new List<PluginPair>()