New constant expected analyzer #5766

wzchua · 2021-12-13T10:44:17Z

Resolves dotnet/runtime#33771
This is still a WIP and I'm using CA1860 and CA1861 as placeholder.
I believe the logic covers most of the general cases.

It is still not fully clear to me the rules for applying this attribute to a generic parameter.
I have added logic to handle some of it but not sure if this is how the team would like them.

Add more tests

@buyaa-n @tannergooding

src/NetAnalyzers/UnitTests/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedTests.cs

codecov · 2021-12-13T11:53:22Z

Codecov Report

Merging #5766 (266fba8) into main (5182a8a) will increase coverage by 0.00%.
The diff coverage is 98.15%.

❗ Current head 266fba8 differs from pull request most recent head ca89072. Consider uploading reports for the commit ca89072 to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##             main    #5766     +/-   ##
=========================================
  Coverage   96.04%   96.05%             
=========================================
  Files        1360     1364      +4     
  Lines      312225   313686   +1461     
  Branches    10047    10125     +78     
=========================================
+ Hits       299890   301324   +1434     
- Misses       9928     9940     +12     
- Partials     2407     2422     +15

deeprobin · 2022-02-23T18:49:16Z

@wzchua Are you still working on this?

wzchua · 2022-02-23T22:48:52Z

Yea, it is effectively done but I'm sure I'm still missing something.

Also, I'm not sure if the team wants the vb analyzer

deeprobin · 2022-02-24T22:18:34Z

Can you please check if the analyzer works also on VB?

dotnet/runtime#33771 (comment)
And we need some VB Tests and then its imo ready to review

wzchua · 2022-02-25T01:19:25Z

It won't work, it depends on language specific syntax since there is no IOperation for attribute

wzchua · 2022-02-25T01:23:19Z

I'll do a rebase and mark it for review later in the day

fix some typo

Add new warning for missing attribute from interface or base class

Fill in missing cases in tests.

wzchua · 2022-02-25T11:40:03Z

The test is still missing a reference assembly with the attribute

...ers/Core/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedAnalyzer.UnmanagedHelper.cs

...etAnalyzers/CSharp/Microsoft.NetCore.Analyzers/Performance/CSharpConstantExpectedAnalyzer.cs

...ers/Core/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedAnalyzer.UnmanagedHelper.cs

src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedAnalyzer.cs

Co-authored-by: Robin Lindner <[email protected]>

deeprobin

LGTM

tannergooding · 2022-03-23T21:39:32Z

This isn't something I have the relevant expertise to review. It only impacts some of the APIs in my area as things that might use the analyzer.

CC> @buyaa-n

wzchua · 2022-03-26T00:18:32Z

@tannergooding. From the test, you can view the behaviour of the analyzer. Let me know if the behaviour does not match what is expected.

buyaa-n · 2022-08-02T02:01:30Z

Thanks @wzchua, looks a few comments still not addressed yet, otherwise looks good

wzchua · 2022-08-27T06:59:43Z

I have resolved the remaining comments

ConstantExpectedContext captures the INamedTypeSymbol and wrap methods related to checking with the ConstantExpected attribute

buyaa-n

LGTM, thanks for your contribution @wzchua, I would simplify the perf test a bit

src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/MicrosoftNetCoreAnalyzersResources.resx

src/PerformanceTests/Tests/Enabled/CSharp_CA1856.cs

src/PerformanceTests/Tests/Enabled/CSharp_CA1857.cs

src/PerformanceTests/Tests/Enabled/CSharp_CA1856.cs

buyaa-n · 2022-09-13T01:35:18Z

FYI: @mavasani @jmarolf it is safe to merge this analyzer in 7.0 as it would not cause any warnings because the ConstantExpected attribute is not yet applied to any APIs in runtime. And we have no plan to apply any attribute within 7.0. If its OK with you and have you have done reviewing we can merge the analyzer

tannergooding · 2022-09-26T18:29:46Z

What's the status of this and is it ready to merge?

buyaa-n · 2022-10-03T23:57:27Z

What's the status of this and is it ready to merge?

This is ready (except it got new merge conflicts), it can be merged into 7.0 if @jmarolf @mavasani OK with merging (It would not cause any warning as no any API attributed with ConstantExpectedAttribute in 7.0). Else I will merge it when the main branch will become for 8.0

src/NetAnalyzers/RulesMissingDocumentation.md

github-actions bot added the Community label Dec 13, 2021

wzchua commented Dec 13, 2021

View reviewed changes

src/NetAnalyzers/UnitTests/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedTests.cs Outdated Show resolved Hide resolved

wzchua commented Dec 13, 2021

View reviewed changes

src/NetAnalyzers/UnitTests/Microsoft.NetCore.Analyzers/Performance/ConstantExpectedTests.cs Outdated Show resolved Hide resolved

wzchua force-pushed the new-analyzer/constant-expected branch from 9ee7606 to c97c002 Compare December 13, 2021 11:21

wzchua force-pushed the new-analyzer/constant-expected branch 2 times, most recently from 3d61e3f to 02c9847 Compare December 13, 2021 14:58

wzchua force-pushed the new-analyzer/constant-expected branch from 38ac251 to 9cf0495 Compare January 8, 2022 04:30

deeprobin mentioned this pull request Feb 24, 2022

Pass constants to parameters marked as [ConstantExpected] dotnet/runtime#33771

Closed

wzchua added 7 commits February 25, 2022 19:20

Add ConstantExpectedAnalyzer

1f4234a

Fix floating point string culture issue

f39fc60

Update tests

74d9533

fix some typo

Fix typos

d13a77e

Rework test cases

8b3d43e

Add new warning for missing attribute from interface or base class

run pack command

d4fe364

Reorganize and combine some rules.

5f8922f

Fill in missing cases in tests.

wzchua force-pushed the new-analyzer/constant-expected branch from 84d6e4d to 5f8922f Compare February 25, 2022 11:36

wzchua marked this pull request as ready for review February 25, 2022 11:41

wzchua requested a review from a team as a code owner February 25, 2022 11:41

deeprobin reviewed Feb 25, 2022

View reviewed changes

Apply suggestions from code review

7b883e0

Co-authored-by: Robin Lindner <[email protected]>

deeprobin approved these changes Feb 25, 2022

View reviewed changes

wzchua added 3 commits August 27, 2022 10:16

Merge branch 'main' into new-analyzer/constant-expected

1196110

Fix RS1032

65de245

Fix IDE0200: Lambda expression can be removed

04ad5b1

wzchua force-pushed the new-analyzer/constant-expected branch from 5369cc6 to 4a752f7 Compare August 27, 2022 07:51

wzchua added 4 commits August 27, 2022 19:00

Rework attribute symbol matching

011d9eb

ConstantExpectedContext captures the INamedTypeSymbol and wrap methods related to checking with the ConstantExpected attribute

Update diagnostic Ids

ec3f1ae

Update test to use ReferenceAssemblies.Net70

59fdd58

Add performance tests

865974c

wzchua force-pushed the new-analyzer/constant-expected branch from 4a752f7 to 865974c Compare August 27, 2022 11:00

buyaa-n approved these changes Sep 13, 2022

View reviewed changes

Apply suggestions from code review

c87ee13

Update localized messages

5f07e36

wzchua and others added 3 commits November 12, 2022 08:33

Merge branch 'main' into new-analyzer/constant-expected

7c8b93b

Run pack

266fba8

Merge branch 'main' into new-analyzer/constant-expected

86dbee4

buyaa-n reviewed Nov 16, 2022

View reviewed changes

src/NetAnalyzers/RulesMissingDocumentation.md Outdated Show resolved Hide resolved

Apply suggestions from code review

774008b

buyaa-n enabled auto-merge (squash) November 16, 2022 05:15

Fix generated file

ca89072

buyaa-n merged commit ebaa318 into dotnet:main Nov 16, 2022

github-actions bot added this to the vNext milestone Nov 16, 2022

Youssef1313 mentioned this pull request Dec 5, 2022

Document CA1856 and CA1857 dotnet/docs#32880

Open

Youssef1313 mentioned this pull request Dec 13, 2022

Constant expected analyzer (CA1856) was approved as "Info" but implemented as **Error** #6342

Closed

dependabot bot mentioned this pull request Jul 29, 2025

Bump coverlet.collector and 14 others MyIntelligenceAgency/semantic-fleet#54

Open

dependabot bot mentioned this pull request Aug 12, 2025

Bump Microsoft.CodeAnalysis.NetAnalyzers from 8.0.0-preview.23472.1 to 9.0.0 MyIntelligenceAgency/semantic-fleet#55

Open

New constant expected analyzer #5766

New constant expected analyzer #5766

Uh oh!

Conversation

wzchua commented Dec 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Dec 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

deeprobin commented Feb 23, 2022

Uh oh!

wzchua commented Feb 23, 2022

Uh oh!

deeprobin commented Feb 24, 2022

Uh oh!

wzchua commented Feb 25, 2022

Uh oh!

wzchua commented Feb 25, 2022

Uh oh!

wzchua commented Feb 25, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deeprobin left a comment

Choose a reason for hiding this comment

Uh oh!

tannergooding commented Mar 23, 2022

Uh oh!

wzchua commented Mar 26, 2022

Uh oh!

buyaa-n commented Aug 2, 2022

Uh oh!

wzchua commented Aug 27, 2022

Uh oh!

buyaa-n left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

buyaa-n commented Sep 13, 2022

Uh oh!

tannergooding commented Sep 26, 2022

Uh oh!

buyaa-n commented Oct 3, 2022

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wzchua commented Dec 13, 2021 •

edited

Loading

codecov bot commented Dec 13, 2021 •

edited

Loading