Fix all warnings and update dependencies (#186)

normj · web-flow · commit 1a73f6bf756e · 2024-10-15T09:51:52.000-07:00
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/Amazon.Extensions.Configuration.SystemsManager.csproj b/src/Amazon.Extensions.Configuration.SystemsManager/Amazon.Extensions.Configuration.SystemsManager.csproj
@@ -6,7 +6,7 @@
     <AssemblyName>Amazon.Extensions.Configuration.SystemsManager</AssemblyName>
     <RootNamespace>Amazon.Extensions.Configuration.SystemsManager</RootNamespace>
     <OutputType>Library</OutputType>
-    <VersionPrefix>6.2.1</VersionPrefix>
+    <VersionPrefix>6.2.2</VersionPrefix>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageId>Amazon.Extensions.Configuration.SystemsManager</PackageId>
     <Title>.NET Configuration Extensions for AWS Systems Manager</Title>
@@ -20,7 +20,7 @@
     <PackageIcon>icon.png</PackageIcon>
     <RepositoryUrl>https://github.com/aws/aws-dotnet-extensions-configuration/</RepositoryUrl>
     <Company>Amazon Web Services</Company>
-
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisRuleSet>../ruleset.xml</CodeAnalysisRuleSet>
   </PropertyGroup>
 
@@ -35,11 +35,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="AWSSDK.AppConfigData" Version="3.7.301.35" />
-    <PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.300" />
-    <PackageReference Include="AWSSDK.SimpleSystemsManagement" Version="3.7.303.23" />
+    <PackageReference Include="AWSSDK.AppConfigData" Version="3.7.400.34" />
+    <PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.301" />
+    <PackageReference Include="AWSSDK.SimpleSystemsManagement" Version="3.7.402.13" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="2.0.*" />
-    <PackageReference Include="System.Text.Json" Condition=" '$(TargetFramework)' == 'netstandard2.0' " Version="8.0.4" />
+    <PackageReference Include="System.Text.Json" Condition=" '$(TargetFramework)' == 'netstandard2.0' " Version="8.0.5" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/AppConfig/AppConfigProcessor.cs b/src/Amazon.Extensions.Configuration.SystemsManager/AppConfig/AppConfigProcessor.cs
@@ -25,7 +25,11 @@
 
 namespace Amazon.Extensions.Configuration.SystemsManager.AppConfig
 {
+    // Types that own disposable fields should be disposable. This warning is okay to ignore because
+    // the instance of IAmazonAppConfigData is meant to last for the length of the application.
+#pragma warning disable CA1001
     public class AppConfigProcessor : ISystemsManagerProcessor
+#pragma warning restore CA1001
     {
         private AppConfigConfigurationSource Source { get; }
         private IDictionary<string, string> LastConfig { get; set; }
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/DefaultParameterProcessor.cs b/src/Amazon.Extensions.Configuration.SystemsManager/DefaultParameterProcessor.cs
@@ -38,7 +38,11 @@ public virtual string GetKey(Parameter parameter, string path)
             var name = parameter.Name.StartsWith(path, StringComparison.OrdinalIgnoreCase) 
                 ? parameter.Name.Substring(path.Length) 
                 : parameter.Name;
+#if NETCOREAPP3_1_OR_GREATER
+            return name.TrimStart('/').Replace("/", KeyDelimiter, StringComparison.InvariantCulture);
+#else
             return name.TrimStart('/').Replace("/", KeyDelimiter);
+#endif
         }
 
         public virtual string GetValue(Parameter parameter, string path) => parameter.Value;
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/ISystemsManagerConfigurationSource.cs b/src/Amazon.Extensions.Configuration.SystemsManager/ISystemsManagerConfigurationSource.cs
@@ -27,7 +27,9 @@ public interface ISystemsManagerConfigurationSource : IConfigurationSource
         /// <summary>
         /// Determines if loading configuration data from AWS Systems Manager Parameter Store is optional.
         /// </summary>
+#pragma warning disable CA1716 // Identifiers should not match keywords: This would be a breaking change to change this name now.
         bool Optional { get; set; }
+#pragma warning restore CA1716 // Identifiers should not match keywords
 
         /// <summary>
         /// Parameters will be reloaded from the AWS Systems Manager Parameter Store after the specified time frame
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/Internal/JsonConfigurationParser.cs b/src/Amazon.Extensions.Configuration.SystemsManager/Internal/JsonConfigurationParser.cs
@@ -76,7 +76,7 @@ private void VisitElement(JsonElement element)
                     VisitPrimitive(element);
                     break;
                 case JsonValueKind.Null:
-                    VisitNull(element);
+                    VisitNull();
                     break;
             }
 
@@ -95,7 +95,7 @@ private void VisitArray(JsonElement array)
             }
         }
 
-        private void VisitNull(JsonElement data)
+        private void VisitNull()
         {
             var key = _currentPath;
             _data[key] = null;
diff --git a/src/Amazon.Extensions.Configuration.SystemsManager/Internal/ServiceClientAppender.cs b/src/Amazon.Extensions.Configuration.SystemsManager/Internal/ServiceClientAppender.cs
@@ -29,7 +29,13 @@ public static void ServiceClientBeforeRequestEvent(object sender, RequestEventAr
         {
             if (e is WebServiceRequestEventArgs args)
             {
-                if (args.Headers.ContainsKey(UserAgentHeader) && !args.Headers[UserAgentHeader].Contains(UserAgentSuffix))
+                if (args.Headers.ContainsKey(UserAgentHeader) &&
+#if NETCOREAPP3_1_OR_GREATER
+                    !args.Headers[UserAgentHeader].Contains(UserAgentSuffix, System.StringComparison.InvariantCulture)
+#else
+                    !args.Headers[UserAgentHeader].Contains(UserAgentSuffix)
+#endif
+                    )
                 {
                     args.Headers[UserAgentHeader] = args.Headers[UserAgentHeader] + " " + UserAgentSuffix;
                 }
diff --git a/test/Amazon.Extensions.Configuration.SystemsManager.Integ/Amazon.Extensions.Configuration.SystemsManager.Integ.csproj b/test/Amazon.Extensions.Configuration.SystemsManager.Integ/Amazon.Extensions.Configuration.SystemsManager.Integ.csproj
@@ -1,21 +1,20 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0;net8.0</TargetFrameworks>
-
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="AWSSDK.AppConfig" Version="3.7.301.20" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
-    <PackageReference Include="AWSSDK.SecurityToken" Version="3.7.300.75" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="AWSSDK.AppConfig" Version="3.7.401.22" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="AWSSDK.SecurityToken" Version="3.7.400.34" />
+    <PackageReference Include="xunit" Version="2.9.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/test/Amazon.Extensions.Configuration.SystemsManager.Tests/Amazon.Extensions.Configuration.SystemsManager.Tests.csproj b/test/Amazon.Extensions.Configuration.SystemsManager.Tests/Amazon.Extensions.Configuration.SystemsManager.Tests.csproj
@@ -1,8 +1,8 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;net6.0;net8.0</TargetFrameworks>
-
+    <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
@@ -13,14 +13,13 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
-    <PackageReference Include="Moq" Version="4.16.1" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="Moq" Version="4.20.72" />
+    <PackageReference Include="xunit" Version="2.9.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
   </ItemGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,11 @@`
`25`	`25`
`26`	`26`	`namespace Amazon.Extensions.Configuration.SystemsManager.AppConfig`
`27`	`27`	`{`
	`28`	`+ // Types that own disposable fields should be disposable. This warning is okay to ignore because`
	`29`	`+ // the instance of IAmazonAppConfigData is meant to last for the length of the application.`
	`30`	`+#pragma warning disable CA1001`
`28`	`31`	`public class AppConfigProcessor : ISystemsManagerProcessor`
	`32`	`+#pragma warning restore CA1001`
`29`	`33`	`{`
`30`	`34`	`private AppConfigConfigurationSource Source { get; }`
`31`	`35`	`private IDictionary<string, string> LastConfig { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ private void VisitElement(JsonElement element)`
`76`	`76`	`VisitPrimitive(element);`
`77`	`77`	`break;`
`78`	`78`	`case JsonValueKind.Null:`
`79`		`- VisitNull(element);`
	`79`	`+ VisitNull();`
`80`	`80`	`break;`
`81`	`81`	`}`
`82`	`82`
`@@ -95,7 +95,7 @@ private void VisitArray(JsonElement array)`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
`98`		`- private void VisitNull(JsonElement data)`
	`98`	`+ private void VisitNull()`
`99`	`99`	`{`
`100`	`100`	`var key = _currentPath;`
`101`	`101`	`_data[key] = null;`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,13 @@ public static void ServiceClientBeforeRequestEvent(object sender, RequestEventAr`
`29`	`29`	`{`
`30`	`30`	`if (e is WebServiceRequestEventArgs args)`
`31`	`31`	`{`
`32`		`- if (args.Headers.ContainsKey(UserAgentHeader) && !args.Headers[UserAgentHeader].Contains(UserAgentSuffix))`
	`32`	`+ if (args.Headers.ContainsKey(UserAgentHeader) &&`
	`33`	`+#if NETCOREAPP3_1_OR_GREATER`
	`34`	`+ !args.Headers[UserAgentHeader].Contains(UserAgentSuffix, System.StringComparison.InvariantCulture)`
	`35`	`+#else`
	`36`	`+ !args.Headers[UserAgentHeader].Contains(UserAgentSuffix)`
	`37`	`+#endif`
	`38`	`+ )`
`33`	`39`	`{`
`34`	`40`	`args.Headers[UserAgentHeader] = args.Headers[UserAgentHeader] + " " + UserAgentSuffix;`
`35`	`41`	`}`