• Create ticket/issue

Follow the guide to enable codebase context checks.

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
No audit logs: The new equality, hash code, and PrintMembers changes introduce no logging for critical
actions, but it's unclear whether such logging is applicable for these DTOs without
broader context.

public Task<Subscription> OnNavigationCommittedAsync(Func<NavigationInfo, Task> handler, ContextSubscriptionOptions? options = null)
{
    return BiDi.BrowsingContext.OnNavigationCommittedAsync(handler, options.WithContext(this));
}

public bool Equals(BrowsingContext? other)
{
    return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
}

public override int GetHashCode()
{
    return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
}

// Includes Id only for brevity
private bool PrintMembers(StringBuilder builder)
{
    builder.Append($"Id = {Id}");
    return true;
}

Learn more about managing compliance generic rules or creating your own custom rules

To reduce code duplication, create an abstract base record to centralize the
identical Id-based equality, hash code, and PrintMembers logic currently
repeated across nine different record types.

Examples:

    public bool Equals(UserContext? other)
    {
        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
    }

    public override int GetHashCode()
    {
        return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
    }


 ... (clipped 6 lines)

    public bool Equals(BrowsingContext? other)
    {
        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
    }

    public override int GetHashCode()
    {
        return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
    }


 ... (clipped 6 lines)

Solution Walkthrough:

Before:

// In UserContext.cs, Collector.cs, Intercept.cs, etc.
public sealed record UserContext
{
    internal string Id { get; }
    // ... other properties and methods

    public bool Equals(UserContext? other)
    {
        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
    }

    public override int GetHashCode()
    {
        return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
    }

    private bool PrintMembers(StringBuilder builder)
    {
        builder.Append($"Id = {Id}");
        return true;
    }
}

After:

// New base record
public abstract record BiDiEntity(string Id)
{
    public virtual bool Equals(BiDiEntity? other)
    {
        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
    }

    public override int GetHashCode() => StringComparer.Ordinal.GetHashCode(Id ?? string.Empty);

    protected virtual bool PrintMembers(StringBuilder builder)
    {
        builder.Append($"Id = {Id}");
        return true;
    }
}

// In UserContext.cs, Collector.cs, Intercept.cs, etc.
public sealed record UserContext(string Id) : BiDiEntity(Id);

These equality and PrintMembers implementations are duplicated across multiple
record types; extract a shared helper/base to centralize the logic and prevent
drift.

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContext.cs [234-249]

-public bool Equals(BrowsingContext? other)
-{
-    return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
-}
+// Example: use a shared static helper
+public bool Equals(BrowsingContext? other) => EqualityHelpers.IdEquals(Id, other?.Id);
 
-public override int GetHashCode()
-{
-    return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
-}
+public override int GetHashCode() => EqualityHelpers.IdHashCode(Id);
 
-// Includes Id only for brevity
-private bool PrintMembers(StringBuilder builder)
-{
-    builder.Append($"Id = {Id}");
-    return true;
-}
+private bool PrintMembers(StringBuilder builder) => EqualityHelpers.AppendId(builder, Id);

• Apply / Chat

Simplify the GetHashCode implementation by using the null-coalescing operator
(??) with string.Empty for null Id values, instead of a ternary conditional
check.

dotnet/src/webdriver/BiDi/Browser/UserContext.cs [56-59]

 public override int GetHashCode()
 {
-    return Id is not null ? StringComparer.Ordinal.GetHashCode(Id) : 0;
+    return StringComparer.Ordinal.GetHashCode(Id ?? string.Empty);
 }

• Apply / Chat