#1660 Huge logs because of StyleCop.Analyzers warnings #1663

raman-m · 2023-06-01T09:50:25Z

Fixes #1660

A long list of StyleCop.Analyzers warnings in build logs: CircleCI, VS Output Build, VS Error List Warnings.

Proposed Changes

Add StyleCop.Analyzers package to Ocelot.Provider.Kubernetes, Ocelot.Tracing.Butterfly, Ocelot.Tracing.OpenTracing
Fix SA* StyleCop warnings
Fix CA* C# Styling warnings
Fix CS* C# warnings
Fix IDE* C# errors, warnings and info
Upgrade Basic and K8s samples to ASP.NET 7 to fix warnings and apply ASP.NET 7 MVC templates

…tion

…xyz}

… is missing a trailing comma.

…tion, whenever the parameter span across multiple lines

…fier

…umentation header.

This will prevent derived types that introduce a finalizer from needing to re-implement 'IDisposable' to call it.

…nce data and can be marked as static

…tProcess().Id'

Convert to property.

…ipped public API

…Finalize(object).

… case characters

… case characters: AcceptanceTests\WebSocketTests

raman-m · 2023-06-01T09:59:11Z

@RaynaldM Hey Ray!
Could you review my PR please?

RaynaldM · 2023-06-01T13:16:41Z

src/Ocelot/Headers/RemoveOutputHeaders.cs

        /// </summary>
        private readonly string[] _unsupportedRequestHeaders =
        {
-            "Transfer-Encoding"
+            "Transfer-Encoding",


comma is useless

This is SA1413 StyleCop rule. See more below!

RaynaldM · 2023-06-01T13:18:29Z

src/Ocelot/Multiplexer/SimpleJsonResponseAggregator.cs

@@ -82,7 +82,7 @@ private static async Task MapAggregateContent(HttpContext originalContext, List<

            var stringContent = new StringContent(contentBuilder.ToString())
            {
-                Headers = { ContentType = new MediaTypeHeaderValue("application/json") }
+                Headers = { ContentType = new MediaTypeHeaderValue("application/json") },


comma is useless

In the previous version (target):

This is SA1413 StyleCop rule.

Cause

The last statement in a multi-line C# initializer or list is missing a trailing comma.

Rationale

This rule is specifically designed to work well with the most widely used source control systems as an aid to long-term
code review. By placing a comma on the last line of a multi-line sequence, developers who append an item to the list or reorder the list at some point in the future will not need to modify any more lines than absolutely necessary for the
change. As a result, the size of the subsequent code review is minimized and focused, and tools like git blame
continue to show the original author and commit for the item that was previously last in the list.

I believe the most importand part of the Rationale is:

and focused, and tools like git blame
continue to show the original author and commit for the item that was previously last in the list.

So, the restriction of git compare/diff tool is tracking changes per line. That's why this rule was introduced in StyleCop Analyzer. The history of the line should not be overridden by absent comma if the next line will be changed in future.
Yeah, now I have overridden the author of this line. But that's how to fix it.
That's why I fixed the violation of SA1413 rule.

Finally,
I believe this is not a major issue to fix, but thank you for your comment!

raman-m · 2023-06-01T15:21:43Z

@RaynaldM Ray,
Thanks for the review!

@TomPallister Tom,
I will appreciate your review with merging to develop, please!
You could focus on "Upgrade XXX to ASP.NET 7" commits, which is the most interesting part of the PR! 😉

* push code coverage for main and develop branches * #1660 Huge logs because of StyleCop.Analyzers warnings (#1663) * Add StyleCop.Analyzers package * Fix SA0001: XML comment analysis is disabled due to project configuration * Fix SA1609: Property documentation should have value * Fix CS1591: Missing XML comment for publicly visible type or member {xyz} * Fix SA1101: Prefix local calls with this * Fix SA1413: The last statement in a multi-line C# initializer or list is missing a trailing comma. * Fix SA1135: A using directive is not qualified. * Fix compiler errors * Fix SA1651: Do not use placeholder elements * Fix compiling error * Fix SA1113: Comma should be on the same line as previous parameter * Fix SA1116: The parameters should begin on the line after the declaration, whenever the parameter span across multiple lines * Fix SA1137: Elements should have the same indentation * Fix SA1200: Using directive should appear within a namespace declaration * Fix SA1316: Tuple element names should use correct casing * Fix SA1503: Braces should not be omitted * Fix SA1505: An opening brace should not be followed by a blank line * Fix SA1507: Code should not contain multiple blank lines in a row * Fix SA1508: A closing brace should not be preceded by a blank line * Fix SA1512, SA1515 * Fix SA1513: Closing brace should be followed by blank line * Fix SA1400: Element 'OpenTracingTracer' should declare an access modifier * Fix SA1515: Single-line comment should be preceded by blank line * Fix SA1518: File is required to end with a single newline character * Add StyleCop * Fix SA1633: A C# code file is missing a standard file header. * Disable SA1602: An item within a C# enumeration is missing an Xml documentation header. * Fix SA1600: Elements should be documented * Fix SA1604: Element documentation should have summary * Fix SA1618: The documentation for type parameter 'T' is missing * Fix SA1629: Documentation text should end with a period. * Fix SA1649: File name should match first type name * Fix SA1600: Elements should be documented * Upgrade K8s sample to ASP.NET 7. Rename project to Ocelot.Samples.OcelotKube.DownstreamService * Upgrade K8s sample to ASP.NET 7. Rename project to Ocelot.Samples.OcelotKube.ApiGateway * Fix CS0169: The field 'xxx' is never used * Fix CS0219: The variable 'baseUrl' is assigned but its value is never used * Fix CS0414: The field 'xxx' is assigned but its value is never used * Fix CS1570: XML comment has badly formed XML * Fix CS0649: Field 'xxx' is never assigned to, and will always have its default value null * Fix CS0618: 'member' is obsolete: 'text' * Fix NU1504: Duplicate 'PackageReference' items found: Microsoft.Data.SQLite 7.0.4, Microsoft.Data.SQLite 7.0.5 * Upgrade sample to ASP.NET 7 * Fix NU5048: The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl * Rewrite a RequestDelegate object definition * Fix CS0618: 'member' is obsolete: 'text' * Fix CA1816: Change Dispose() to call GC.SuppressFinalize(object). This will prevent derived types that introduce a finalizer from needing to re-implement 'IDisposable' to call it. * Fix CA1822: Member 'GivenThereIsAConfiguration' does not access instance data and can be marked as static * Fix CA1837: Use 'Environment.ProcessId' instead of 'Process.GetCurrentProcess().Id' * Fix CA2211: Non-constant fields should not be visible. Convert to property. * Fix IDE0060: Remove unused parameter 'path' if it is not part of a shipped public API * Fix CA1816: Change ConsulWebSocketTests.Dispose() to call GC.SuppressFinalize(object). * Fix IDE1006: Naming rule violation: These words must begin with upper case characters * Fix IDE1006: Naming rule violation: These words must begin with upper case characters: AcceptanceTests\WebSocketTests * Fix last issues * Upgrade basic sample to ASP.NET 7 * fixed up required spacing in README (#1499) Co-authored-by: Justin Middler <[email protected]> * Update README.md --------- Co-authored-by: TomPallister <[email protected]> Co-authored-by: Justin Middler <[email protected]> Co-authored-by: Justin Middler <[email protected]> Co-authored-by: Tom Pallister <[email protected]>

raman-m added 30 commits May 30, 2023 19:14

Add StyleCop.Analyzers package

371d8cf

Fix SA0001: XML comment analysis is disabled due to project configura…

3a76434

…tion

Fix SA1609: Property documentation should have value

4ad5a37

Fix CS1591: Missing XML comment for publicly visible type or member {…

a017a9e

…xyz}

Fix SA1101: Prefix local calls with this

eea5da1

Fix SA1413: The last statement in a multi-line C# initializer or list…

a0e5c33

… is missing a trailing comma.

Fix SA1135: A using directive is not qualified.

b20924c

Fix compiler errors

0da791f

Fix SA1651: Do not use placeholder elements

8b10089

Fix compiling error

cf1ae38

Fix SA1113: Comma should be on the same line as previous parameter

464584c

Fix SA1116: The parameters should begin on the line after the declara…

96a9fc6

…tion, whenever the parameter span across multiple lines

Fix SA1137: Elements should have the same indentation

a2be6d2

Fix SA1200: Using directive should appear within a namespace declaration

6022c17

Fix SA1316: Tuple element names should use correct casing

8e961a4

Fix SA1503: Braces should not be omitted

0442748

Fix SA1505: An opening brace should not be followed by a blank line

9698d4f

Fix SA1507: Code should not contain multiple blank lines in a row

26f5f42

Fix SA1508: A closing brace should not be preceded by a blank line

c57b1d6

Fix SA1512, SA1515

34f486a

Fix SA1513: Closing brace should be followed by blank line

1a4cd7e

Fix SA1400: Element 'OpenTracingTracer' should declare an access modi…

65a4da2

…fier

Fix SA1515: Single-line comment should be preceded by blank line

d26781e

Fix SA1518: File is required to end with a single newline character

75c1973

Add StyleCop

5f90dd7

Fix SA1633: A C# code file is missing a standard file header.

66a948c

Disable SA1602: An item within a C# enumeration is missing an Xml doc…

5193596

…umentation header.

Fix SA1600: Elements should be documented

3fdb703

Fix SA1604: Element documentation should have summary

632f0db

Fix SA1618: The documentation for type parameter 'T' is missing

03f3c80

raman-m added 12 commits May 31, 2023 22:32

Rewrite a RequestDelegate object definition

bdd1073

Fix CS0618: 'member' is obsolete: 'text'

e839937

Fix CA1816: Change Dispose() to call GC.SuppressFinalize(object).

c489744

This will prevent derived types that introduce a finalizer from needing to re-implement 'IDisposable' to call it.

Fix CA1822: Member 'GivenThereIsAConfiguration' does not access insta…

d0269d2

…nce data and can be marked as static

Fix CA1837: Use 'Environment.ProcessId' instead of 'Process.GetCurren…

65d22e8

…tProcess().Id'

Fix CA2211: Non-constant fields should not be visible.

b458514

Convert to property.

Fix IDE0060: Remove unused parameter 'path' if it is not part of a sh…

07e6b77

…ipped public API

Fix CA1816: Change ConsulWebSocketTests.Dispose() to call GC.Suppress…

092aaa8

…Finalize(object).

Fix IDE1006: Naming rule violation: These words must begin with upper…

8ac815b

… case characters

Fix IDE1006: Naming rule violation: These words must begin with upper…

6c98588

… case characters: AcceptanceTests\WebSocketTests

Fix last issues

c320153

Upgrade basic sample to ASP.NET 7

64e815b

raman-m self-assigned this Jun 1, 2023

raman-m added bug Identified as a potential bug feature A new feature accepted Bug or feature would be accepted as a PR or is being worked on in progress Someone is working on the issue. Could be someone on the team or off. labels Jun 1, 2023

raman-m requested a review from RaynaldM June 1, 2023 09:58

RaynaldM approved these changes Jun 1, 2023

View reviewed changes

raman-m requested a review from TomPallister June 1, 2023 15:19

raman-m removed the in progress Someone is working on the issue. Could be someone on the team or off. label Jun 1, 2023

raman-m mentioned this pull request Jun 3, 2023

fix OcelotBasic sample to make it work correctly #1502

Closed

TomPallister merged commit 6ca54fe into develop Jun 4, 2023

TomPallister deleted the bug-1660 branch June 4, 2023 14:13

raman-m added the merged Issue has been merged to dev and is waiting for the next release label Jun 28, 2023

This was referenced Jul 19, 2023

One less warning with async #1208

Closed

Unsorted 'using' statements vs merge conflicts #1681

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1660 Huge logs because of StyleCop.Analyzers warnings #1663

#1660 Huge logs because of StyleCop.Analyzers warnings #1663

raman-m commented Jun 1, 2023 •

edited

Loading

raman-m commented Jun 1, 2023

RaynaldM Jun 1, 2023

raman-m Jun 1, 2023

RaynaldM Jun 1, 2023

raman-m Jun 1, 2023

raman-m commented Jun 1, 2023 •

edited

Loading

#1660 Huge logs because of StyleCop.Analyzers warnings #1663

#1660 Huge logs because of StyleCop.Analyzers warnings #1663

Conversation

raman-m commented Jun 1, 2023 • edited Loading

Fixes #1660

Proposed Changes

raman-m commented Jun 1, 2023

RaynaldM Jun 1, 2023

Choose a reason for hiding this comment

raman-m Jun 1, 2023

Choose a reason for hiding this comment

RaynaldM Jun 1, 2023

Choose a reason for hiding this comment

raman-m Jun 1, 2023

Choose a reason for hiding this comment

Cause

Rationale

raman-m commented Jun 1, 2023 • edited Loading

raman-m commented Jun 1, 2023 •

edited

Loading

raman-m commented Jun 1, 2023 •

edited

Loading