WIP: Enable CA1822 for types with internal visibility by xtqqczze · Pull Request #15838 · PowerShell/PowerShell

xtqqczze · 2021-07-28T23:44:36Z

Non-breaking change as fixes are only for types with an effective visibility of internal.

https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1822

Follow-up to: #13897.

xtqqczze · 2021-07-29T02:28:06Z

PowerShell-CI-windows Failing after 4m — Build #PR-15838-20210728.02 failed:

D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs(1019,21): error CA1822: Member 'LookupPerfNameByIndex' does not access instance data and can be marked as static [D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\Microsoft.PowerShell.Commands.Diagnostics.csproj]
D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs(1136,23): error CA1822: Member 'GetCounterSetHelp' does not access instance data and can be marked as static [D:\a\1\s\src\Microsoft.PowerShell.Commands.Diagnostics\Microsoft.PowerShell.Commands.Diagnostics.csproj]

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

It seems diagnostics are still running at build time for PdhHelper.

iSazonov · 2021-07-29T03:04:54Z

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

No, please exclude non-compliling code and frozen code too.

Also 68 files are too many for review. Please split the PR on some parts.

xtqqczze · 2021-07-29T16:15:41Z

I thought src\Microsoft.PowerShell.Commands.Diagnostics\PdhHelper.cs was not compiled (#14491 (comment)), yet we have a code quality diagnostic being reported?

No, please exclude non-compliling code and frozen code too.

Also 68 files are too many for review. Please split the PR on some parts.

PdhHelper.cs is compiled, but only on Windows:

PowerShell/src/Microsoft.PowerShell.Commands.Diagnostics/Microsoft.PowerShell.Commands.Diagnostics.csproj

Lines 24 to 28 in 0f2f23f

    
           <ItemGroup Condition=" '$(IsWindows)' != 'true' "> 
        
             <Compile Remove="GetCounterCommand.cs" /> 
        
             <Compile Remove="CounterSample.cs" /> 
        
             <Compile Remove="CounterSet.cs" /> 
        
             <Compile Remove="PdhHelper.cs" />

ghost · 2021-08-16T20:00:36Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

ghost · 2021-09-07T20:00:41Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

ghost · 2021-11-03T02:00:52Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

pull-request-quantifier-deprecated · 2021-11-24T10:52:10Z

This PR has 553 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Large
Size       : +289 -264
Percentile : 85.1%

Total files changed: 72

Change summary by file extension:
.globalconfig : +1 -1
.cs : +288 -263

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detetcted.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

ghost · 2021-12-09T20:00:44Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

xtqqczze added 7 commits July 28, 2021 22:35

Fix CA1822 for internal visibility

21809a0

Fix CA1000

671ca15

Fix IDE0036

c36099d

Fix CA1822

ee83e60

Fix IDE0036

e638e66

Suppress CA1822 for Dispose method

5c212ae

Fix CA1822

3fb65fd

xtqqczze requested review from adityapatwardhan, anmenaga and daxian-dbw as code owners July 28, 2021 23:44

ghost assigned adityapatwardhan Jul 28, 2021

xtqqczze marked this pull request as draft July 29, 2021 16:17

Remove redundant preprocessor directives

f62ab42

xtqqczze force-pushed the CA1822-p2 branch from f58b810 to 308cb44 Compare July 29, 2021 16:27

Revert and suppress CA1822 due to conditional compilation issue

73f1d1b

xtqqczze force-pushed the CA1822-p2 branch from 308cb44 to 73f1d1b Compare July 29, 2021 17:09

xtqqczze added 3 commits July 29, 2021 18:39

fixup! 73f1d1b

e141d56

Fix IDE0059: Remove unnecessary value assignment

13fe493

fixup! e141d56

bbb82f3

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Aug 1, 2021

ghost added the Stale label Aug 16, 2021

xtqqczze closed this Aug 23, 2021

xtqqczze reopened this Aug 23, 2021

ghost removed the Stale label Aug 23, 2021

ghost added the Stale label Sep 7, 2021

ghost closed this Sep 18, 2021

iSazonov reopened this Sep 18, 2021

ghost closed this Sep 28, 2021

daxian-dbw reopened this Sep 28, 2021

daxian-dbw removed Stale Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Sep 28, 2021

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 2, 2021

ghost added the Stale label Nov 3, 2021

ghost closed this Nov 22, 2021

iSazonov reopened this Nov 24, 2021

pull-request-quantifier-deprecated bot added the Extra Large label Nov 24, 2021

ghost removed the Stale label Nov 24, 2021

ghost added the Stale label Dec 9, 2021

ghost closed this Dec 20, 2021

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

WIP: Enable CA1822 for types with internal visibility#15838

WIP: Enable CA1822 for types with internal visibility#15838
xtqqczze wants to merge 12 commits intoPowerShell:masterfrom
xtqqczze:CA1822-p2

xtqqczze commented Jul 28, 2021

Uh oh!

xtqqczze commented Jul 29, 2021 •

edited

Loading

Uh oh!

iSazonov commented Jul 29, 2021 •

edited

Loading

Uh oh!

xtqqczze commented Jul 29, 2021

Uh oh!

ghost commented Aug 16, 2021

Uh oh!

ghost commented Sep 7, 2021

Uh oh!

ghost commented Nov 3, 2021

Uh oh!

pull-request-quantifier-deprecated bot commented Nov 24, 2021

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Dec 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Conversation

xtqqczze commented Jul 28, 2021

Uh oh!

xtqqczze commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Jul 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Jul 29, 2021

Uh oh!

ghost commented Aug 16, 2021

Uh oh!

ghost commented Sep 7, 2021

Uh oh!

ghost commented Nov 3, 2021

Uh oh!

pull-request-quantifier-deprecated bot commented Nov 24, 2021

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Dec 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

xtqqczze commented Jul 29, 2021 •

edited

Loading

iSazonov commented Jul 29, 2021 •

edited

Loading