Fix 95: Ambiguous step reported when definition matches via more than one tag (#96)

* Attempt to create reproduction Spec test by supporting creation of StepDefinitions that have mutliple tags.

* Fix for Issue #95. Changed the discovery ProjectBindingRegistry to only take the first binding of those that match on multiple scopes but resolve to the same Implementation.
Added a unit test and a Spec test.

* Updated CHANGELOG.MD

* Added a new project step method in the Specs to properly create the Stepdefinitions that have multiple scope tags without interfering with how it was being done for other tests.

* Added EqualityComparer<T> for ProjectBindingImplementation so that the semantics are clear when the ProjectBindingRegistry disambiguates possibly ambiguous step definitions that happen to have multiple matching Scopes.

Author: clrudolphi

CHANGELOG.md

@@ -3,8 +3,8 @@
 ## Improvements:
 
 ## Bug fixes:
-
-*Contributors of this release (in alphabetical order):* 
+* Fix: Ambiguous steps reported wehn definition matches via more than one tag (#95)
+*Contributors of this release (in alphabetical order):* @clrudolphi
 
 # v2025.1.256 - 2025-03-07
 

Reqnroll.VisualStudio/Discovery/ProjectBindingImplementationEqualityComparer.cs

@@ -0,0 +1,30 @@
+namespace Reqnroll.VisualStudio.Discovery; 
+public class ProjectBindingImplementationEqualityComparer : IEqualityComparer<ProjectBindingImplementation>
+{
+    public bool Equals(ProjectBindingImplementation x, ProjectBindingImplementation y)
+    {
+        if (ReferenceEquals(x, y)) return true;
+        if (x is null || y is null) return false;
+
+        return x.Method == y.Method &&
+               x.ParameterTypes.SequenceEqual(y.ParameterTypes) &&
+               Equals(x.SourceLocation, y.SourceLocation);
+    }
+
+    public int GetHashCode(ProjectBindingImplementation obj)
+    {
+        if (obj is null) return 0;
+
+        unchecked // Use unchecked to handle potential integer overflow
+        {
+            int hash = 17;
+            hash = hash * 23 + (obj.Method?.GetHashCode() ?? 0);
+
+            foreach (var paramType in obj.ParameterTypes)
+                hash = hash * 23 + (paramType?.GetHashCode() ?? 0);
+
+            hash = hash * 23 + (obj.SourceLocation?.GetHashCode() ?? 0);
+            return hash;
+        }
+    }
+}

Reqnroll.VisualStudio/Discovery/ProjectBindingRegistry.cs

@@ -7,6 +7,7 @@ public record ProjectBindingRegistry
     private const string DocStringDefaultTypeName = TypeShortcuts.StringType;
     public static ProjectBindingRegistry Invalid = new(ImmutableArray<ProjectStepDefinitionBinding>.Empty, ImmutableArray<ProjectHookBinding>.Empty);
 
+    private static ProjectBindingImplementationEqualityComparer _equalityComparerForProjectBindingImplementations = new();
     private static int _versionCounter;
 
     private ProjectBindingRegistry(IEnumerable<ProjectStepDefinitionBinding> stepDefinitions, IEnumerable<ProjectHookBinding> hooks)
@@ -186,7 +187,14 @@ private MatchResultItem[] HandleScopeOverloads(MatchResultItem[] sdMatches)
             var matchesWithScope = sdMatches.Where(m =>
                 m.MatchedStepDefinition.Scope != null).ToArray();
             if (matchesWithScope.Any())
-                sdMatches = matchesWithScope;
+            {
+                // Group matches by everything except the Scope property
+                // and take the first item from each group
+                sdMatches = matchesWithScope
+                    .GroupBy(m => m.MatchedStepDefinition.Implementation, _equalityComparerForProjectBindingImplementations)
+                    .Select(g => g.First())
+                    .ToArray();
+            }
         }
 
         return sdMatches;

Tests/Reqnroll.VisualStudio.Specs/Features/Editor/StepAnalysis.feature

@@ -274,6 +274,33 @@ Scenario: Matches combination scoped step definitions
 		"""
 	And no binding error should be highlighted
 
+Scenario: Matches on multiple tags (without improperly highlighting as Ambiguous)
+	Given there is a Reqnroll project scope
+	And the following step definition with mulitple Tag Scopes in the project:
+		| type | regex                               | tag scope         |
+		| When | I use a step with multiple tags     | @mytag1,@mytag2   |
+	When the following feature file is opened in the editor
+		"""
+		Feature: Addition
+
+		@mytag1
+		@mytag2
+		Scenario: Random scenario
+			When I use a step with multiple tags
+
+		"""
+	And the project is built and the initial binding discovery is performed
+	Then all section of types DefinedStep should be highlighted as
+		"""
+		Feature: Addition
+		
+		@mytag1
+		@mytag2
+		Scenario: Random scenario
+			When {DefinedStep}I use a step with multiple tags{/DefinedStep}
+		"""
+	And no binding error should be highlighted
+
 Scenario: Analyses all scopes of background steps
 	Given there is a Reqnroll project scope
 	And the following step definitions in the project: