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

Orchestration Banned APIs Roslyn analyzer #309

Merged
merged 5 commits into from
May 13, 2024

Conversation

allantargino
Copy link
Member

This PR adds 3 analyzers that verify whether orchestrations are using banned APIs through:

  • Task.Run/Thread.Start/TaskFactory (DURABLE0004)
  • Input/Output types (such as HttpClient, etc) (DURABLE0005)
  • Environment Variables (DURABLE0006)

The list of I/O types is by no means comprehensive or complete, but rather an initial set of well-known types used in Azure Functions - we should augment that list soon. I tried to have feature parity with the types covered by our previous analyzer.

@allantargino allantargino requested review from jviau and bachuv May 10, 2024 19:56
Copy link
Member

@jviau jviau left a comment

Choose a reason for hiding this comment

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

Some other types to consider: IConfiguration, IOptions, IOptionsSnapshot, IOptionsMonitor

src/Analyzers/Orchestration/IOOrchestrationAnalyzer.cs Outdated Show resolved Hide resolved
@jviau
Copy link
Member

jviau commented May 10, 2024

I do have a general question: what is the plan for analyzers when we make a feature which invalidates an analyzer? Not saying we have anything planned, but what if we do something that supplies some special idempotent clients? Which are then safe to call from orchestrations?

@allantargino
Copy link
Member Author

allantargino commented May 13, 2024

Regarding the invalidation of released analyzers, I think that depends whether the new feature is in a major or minor release.

  • In a new major release, I think we can just completely erase the analyzer, releasing a new major of the analyzer too.

  • In a new minor release, I researched a bit and there is really neat mechanism called DiagnosticSuppressor which I think we can use:

    Provide an ability for platform/library authors to author simple, context-aware compiler extensions to programmatically suppress specific instances of reported analyzer and/or compiler diagnostics, which are always known to be false positives in the context of the platform/library.

    For instance, I created the following Supressor and DURABLE0001 (DateTime diagnostic) stopped being shown:

    [DiagnosticAnalyzer(LanguageNames.CSharp)]
    public sealed class MySupressor : DiagnosticSuppressor
    {
        static SuppressionDescriptor Rule = new SuppressionDescriptor("SOMETHING123", "DURABLE0001", "no longer make sense");
        public override ImmutableArray<SuppressionDescriptor> SupportedSuppressions => [Rule];
    
        public override void ReportSuppressions(SuppressionAnalysisContext context)
        {
            foreach (var diagnostic in context.ReportedDiagnostics)
            {
                context.ReportSuppression(Suppression.Create(Rule, diagnostic));
            }
        }
    }

I am not sure if that's the best process available @jviau, but could work 👍

For reference: SuppressionAnalysisContext .ReportSuppresion docs.

Copy link
Contributor

@bachuv bachuv left a comment

Choose a reason for hiding this comment

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

Left some questions and comments, but overall looks good! Thanks!

src/Analyzers/KnownTypeSymbols.Net.cs Show resolved Hide resolved
src/Analyzers/RoslynExtensions.cs Show resolved Hide resolved
test/Analyzers.Tests/Wrapper.cs Show resolved Hide resolved
@allantargino allantargino requested a review from bachuv May 13, 2024 18:16
Copy link
Contributor

@bachuv bachuv left a comment

Choose a reason for hiding this comment

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

LGTM!

@allantargino allantargino merged commit 7eef072 into microsoft:main May 13, 2024
2 checks passed
@allantargino allantargino deleted the banned-apis-analyzers branch May 13, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants