Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor internal usage analyzer #30767

Merged
7 commits merged into from
Apr 26, 2023
Merged

Refactor internal usage analyzer #30767

7 commits merged into from
Apr 26, 2023

Conversation

DoctorKrolic
Copy link
Contributor

@DoctorKrolic DoctorKrolic commented Apr 26, 2023

  • Removed HACK with target-typed new since the underlying roslyn analyzers issue has been fixed Changed comment to reference new roslyn-analyzers issue 🫤
  • Removed workarounds when in order to reference-compare assembly symbols redundant cast to object was used
  • Instead of comparing to .ctor string use well-known members API to improve readability
  • Simpliy operation switch. Since there is a 1 to 1 relation between operation interfaces and their kinds, we can switch on operation directly instead of checking kinds and then immideatelly casting to proper interface type

These changes are very minor and don't affect any sort of behaviour, therefore I didn't create an issue upfront.

Copy link
Member

@roji roji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this looks good - but see comment about comparing symbols.

src/EFCore.Analyzers/InternalUsageDiagnosticAnalyzer.cs Outdated Show resolved Hide resolved
@DoctorKrolic DoctorKrolic requested a review from roji April 26, 2023 09:23
@ghost
Copy link

ghost commented Apr 26, 2023

Hello @roji!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost
Copy link

ghost commented Apr 26, 2023

Apologies, while this PR appears ready to be merged, I've been configured to only merge when all checks have explicitly passed. The following integrations have not reported any progress on their checks and are blocking auto-merge:

  1. Azure Pipelines

These integrations are possibly never going to report a check, and unblocking auto-merge likely requires a human being to update my configuration to exempt these integrations from requiring a passing check.

Give feedback on this
From the bot dev team

We've tried to tune the bot such that it posts a comment like this only when auto-merge is blocked for exceptional, non-intuitive reasons. When the bot's auto-merge capability is properly configured, auto-merge should operate as you would intuitively expect and you should not see any spurious comments.

Please reach out to us at [email protected] to provide feedback if you believe you're seeing this comment appear spuriously. Please note that we usually are unable to update your bot configuration on your team's behalf, but we're happy to help you identify your bot admin.

@ghost ghost removed the auto-merge label Apr 26, 2023
@DoctorKrolic DoctorKrolic requested a review from roji April 26, 2023 09:32
}
}

private static void AnalyzeMember(OperationAnalysisContext context, ISymbol symbol)
{
// ReSharper disable once RedundantCast
if ((object)symbol.ContainingAssembly == context.Compilation.Assembly)
if (symbol.ContainingAssembly?.Equals(context.Compilation.Assembly, SymbolEqualityComparer.Default) == true)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the null checks? ContainingAssembly is annotated as non-nullable, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI failed without it. See results of previous commit (e.g. https://github.com/dotnet/efcore/runs/13032979328)

ContainingAssembly is annotated as non-nullable, no?

Unfortunately, this part of ISymbol isn't null-annotated: https://github.com/dotnet/roslyn/blob/28f2063999e5e7d91d7159e9089c8c9c0c193b91/src/Compilers/Core/Portable/Symbols/ISymbol.cs#L66-L97

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see... thanks!

src/EFCore.Analyzers/InternalUsageDiagnosticAnalyzer.cs Outdated Show resolved Hide resolved
@DoctorKrolic DoctorKrolic requested a review from roji April 26, 2023 11:58
@ghost
Copy link

ghost commented Apr 26, 2023

Apologies, while this PR appears ready to be merged, I've been configured to only merge when all checks have explicitly passed. The following integrations have not reported any progress on their checks and are blocking auto-merge:

  1. Azure Pipelines

These integrations are possibly never going to report a check, and unblocking auto-merge likely requires a human being to update my configuration to exempt these integrations from requiring a passing check.

Give feedback on this
From the bot dev team

We've tried to tune the bot such that it posts a comment like this only when auto-merge is blocked for exceptional, non-intuitive reasons. When the bot's auto-merge capability is properly configured, auto-merge should operate as you would intuitively expect and you should not see any spurious comments.

Please reach out to us at [email protected] to provide feedback if you believe you're seeing this comment appear spuriously. Please note that we usually are unable to update your bot configuration on your team's behalf, but we're happy to help you identify your bot admin.

1 similar comment
@ghost
Copy link

ghost commented Apr 26, 2023

Apologies, while this PR appears ready to be merged, I've been configured to only merge when all checks have explicitly passed. The following integrations have not reported any progress on their checks and are blocking auto-merge:

  1. Azure Pipelines

These integrations are possibly never going to report a check, and unblocking auto-merge likely requires a human being to update my configuration to exempt these integrations from requiring a passing check.

Give feedback on this
From the bot dev team

We've tried to tune the bot such that it posts a comment like this only when auto-merge is blocked for exceptional, non-intuitive reasons. When the bot's auto-merge capability is properly configured, auto-merge should operate as you would intuitively expect and you should not see any spurious comments.

Please reach out to us at [email protected] to provide feedback if you believe you're seeing this comment appear spuriously. Please note that we usually are unable to update your bot configuration on your team's behalf, but we're happy to help you identify your bot admin.

@ghost ghost merged commit ed8965d into dotnet:main Apr 26, 2023
@DoctorKrolic DoctorKrolic deleted the refactor-internal-usage-analyzer branch April 26, 2023 12:59
@roji
Copy link
Member

roji commented Apr 26, 2023

Thanks for your contribution @DoctorKrolic!

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants