Enable nullable on FileProviders and Config.KeyPerFile (#28585)

JamesNK · web-flow · commit 09a036f2f397 · 2020-12-17T14:45:01.000+13:00
diff --git a/src/Configuration.KeyPerFile/src/KeyPerFileConfigurationProvider.cs b/src/Configuration.KeyPerFile/src/KeyPerFileConfigurationProvider.cs
@@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Configuration.KeyPerFile
     /// </summary>
     public class KeyPerFileConfigurationProvider : ConfigurationProvider, IDisposable
     {
-        private readonly IDisposable _changeTokenRegistration;
+        private readonly IDisposable? _changeTokenRegistration;
 
         KeyPerFileConfigurationSource Source { get; set; }
 
@@ -106,7 +106,7 @@ private string GetDirectoryName()
         /// <summary>
         /// Generates a string representing this provider name and relevant details.
         /// </summary>
-        /// <returns> The configuration name. </returns>
+        /// <returns>The configuration name.</returns>
         public override string ToString()
             => $"{GetType().Name} for files in '{GetDirectoryName()}' ({(Source.Optional ? "Optional" : "Required")})";
 
diff --git a/src/Configuration.KeyPerFile/src/KeyPerFileConfigurationSource.cs b/src/Configuration.KeyPerFile/src/KeyPerFileConfigurationSource.cs
@@ -18,7 +18,7 @@ public KeyPerFileConfigurationSource()
         /// <summary>
         /// The FileProvider whos root "/" directory files will be used as configuration data.
         /// </summary>
-        public IFileProvider FileProvider { get; set; }
+        public IFileProvider? FileProvider { get; set; }
 
         /// <summary>
         /// Files that start with this prefix will be excluded.
diff --git a/src/Configuration.KeyPerFile/src/Microsoft.Extensions.Configuration.KeyPerFile.csproj b/src/Configuration.KeyPerFile/src/Microsoft.Extensions.Configuration.KeyPerFile.csproj
@@ -1,4 +1,4 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <Description>Configuration provider that uses files in a directory for Microsoft.Extensions.Configuration.</Description>
@@ -8,6 +8,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>configuration</PackageTags>
     <NoWarn>$(NoWarn);PKG0001</NoWarn>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/Configuration.KeyPerFile/src/PublicAPI.Shipped.txt b/src/Configuration.KeyPerFile/src/PublicAPI.Shipped.txt
@@ -11,16 +11,16 @@ Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Relo
 Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.ReloadOnChange.set -> void
 Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions
 override Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.Load() -> void
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.KeyPerFileConfigurationProvider(Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource source) -> void
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder builder) -> Microsoft.Extensions.Configuration.IConfigurationProvider
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider.get -> Microsoft.Extensions.FileProviders.IFileProvider
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider.set -> void
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition.get -> System.Func<string, bool>
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition.set -> void
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix.get -> string
-~Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix.set -> void
-~override Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.ToString() -> string
-~static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, System.Action<Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource> configureSource) -> Microsoft.Extensions.Configuration.IConfigurationBuilder
-~static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string directoryPath) -> Microsoft.Extensions.Configuration.IConfigurationBuilder
-~static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string directoryPath, bool optional) -> Microsoft.Extensions.Configuration.IConfigurationBuilder
-~static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string directoryPath, bool optional, bool reloadOnChange) -> Microsoft.Extensions.Configuration.IConfigurationBuilder
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.KeyPerFileConfigurationProvider(Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource! source) -> void
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder! builder) -> Microsoft.Extensions.Configuration.IConfigurationProvider!
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider.get -> Microsoft.Extensions.FileProviders.IFileProvider?
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.FileProvider.set -> void
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition.get -> System.Func<string!, bool>!
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnoreCondition.set -> void
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix.get -> string!
+Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource.IgnorePrefix.set -> void
+override Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationProvider.ToString() -> string!
+static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder! builder, System.Action<Microsoft.Extensions.Configuration.KeyPerFile.KeyPerFileConfigurationSource!>! configureSource) -> Microsoft.Extensions.Configuration.IConfigurationBuilder!
+static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder! builder, string! directoryPath) -> Microsoft.Extensions.Configuration.IConfigurationBuilder!
+static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder! builder, string! directoryPath, bool optional) -> Microsoft.Extensions.Configuration.IConfigurationBuilder!
+static Microsoft.Extensions.Configuration.KeyPerFileConfigurationBuilderExtensions.AddKeyPerFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder! builder, string! directoryPath, bool optional, bool reloadOnChange) -> Microsoft.Extensions.Configuration.IConfigurationBuilder!
diff --git a/src/FileProviders/Embedded/src/EmbeddedFileProvider.cs b/src/FileProviders/Embedded/src/EmbeddedFileProvider.cs
@@ -41,7 +41,7 @@ public EmbeddedFileProvider(Assembly assembly)
         /// </summary>
         /// <param name="assembly">The assembly that contains the embedded resources.</param>
         /// <param name="baseNamespace">The base namespace that contains the embedded resources.</param>
-        public EmbeddedFileProvider(Assembly assembly, string baseNamespace)
+        public EmbeddedFileProvider(Assembly assembly, string? baseNamespace)
         {
             if (assembly == null)
             {
diff --git a/src/FileProviders/Embedded/src/EmbeddedResourceFileInfo.cs b/src/FileProviders/Embedded/src/EmbeddedResourceFileInfo.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -50,10 +50,8 @@ public long Length
             {
                 if (!_length.HasValue)
                 {
-                    using (var stream = _assembly.GetManifestResourceStream(_resourcePath))
-                    {
-                        _length = stream.Length;
-                    }
+                    using var stream = GetManifestResourceStream();
+                    _length = stream.Length;
                 }
                 return _length.Value;
             }
@@ -62,7 +60,7 @@ public long Length
         /// <summary>
         /// Always null.
         /// </summary>
-        public string PhysicalPath => null;
+        public string? PhysicalPath => null;
 
         /// <summary>
         /// The name of embedded file
@@ -82,13 +80,24 @@ public long Length
         /// <inheritdoc />
         public Stream CreateReadStream()
         {
-            var stream = _assembly.GetManifestResourceStream(_resourcePath);
+            var stream = GetManifestResourceStream();
             if (!_length.HasValue)
             {
                 _length = stream.Length;
             }
 
             return stream;
         }
+
+        private Stream GetManifestResourceStream()
+        {
+            var stream = _assembly.GetManifestResourceStream(_resourcePath);
+            if (stream == null)
+            {
+                throw new InvalidOperationException($"Couldn't get resource at '{_resourcePath}'.");
+            }
+
+            return stream;
+        }
     }
 }
diff --git a/src/FileProviders/Embedded/src/Manifest/EmbeddedFilesManifest.cs b/src/FileProviders/Embedded/src/Manifest/EmbeddedFilesManifest.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -28,7 +28,7 @@ internal EmbeddedFilesManifest(ManifestDirectory rootDirectory)
             _rootDirectory = rootDirectory;
         }
 
-        internal ManifestEntry ResolveEntry(string path)
+        internal ManifestEntry? ResolveEntry(string path)
         {
             if (string.IsNullOrEmpty(path) || HasInvalidPathChars(path))
             {
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestDirectory.cs b/src/FileProviders/Embedded/src/Manifest/ManifestDirectory.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -31,7 +31,7 @@ public override ManifestEntry Traverse(StringSegment segment)
 
             if (segment.Equals("..", StringComparison.Ordinal))
             {
-                return Parent;
+                return Parent ?? UnknownPath;
             }
 
             foreach (var child in Children)
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestDirectoryContents.cs b/src/FileProviders/Embedded/src/Manifest/ManifestDirectoryContents.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -12,7 +12,7 @@ namespace Microsoft.Extensions.FileProviders.Embedded.Manifest
     internal class ManifestDirectoryContents : IDirectoryContents
     {
         private readonly DateTimeOffset _lastModified;
-        private IFileInfo[] _entries;
+        private IFileInfo[]? _entries;
 
         public ManifestDirectoryContents(Assembly assembly, ManifestDirectory directory, DateTimeOffset lastModified)
         {
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestDirectoryInfo.cs b/src/FileProviders/Embedded/src/Manifest/ManifestDirectoryInfo.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -23,9 +23,9 @@ public ManifestDirectoryInfo(ManifestDirectory directory, DateTimeOffset lastMod
 
         public long Length => -1;
 
-        public string PhysicalPath => null;
+        public string? PhysicalPath => null;
 
-        public string Name => Directory.Name;
+        public string? Name => Directory.Name;
 
         public DateTimeOffset LastModified { get; }
 
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestEntry.cs b/src/FileProviders/Embedded/src/Manifest/ManifestEntry.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -13,7 +13,7 @@ public ManifestEntry(string name)
             Name = name;
         }
 
-        public ManifestEntry Parent { get; private set; }
+        public ManifestEntry? Parent { get; private set; }
 
         public string Name { get; }
 
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestFileInfo.cs b/src/FileProviders/Embedded/src/Manifest/ManifestFileInfo.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -36,9 +36,9 @@ public ManifestFileInfo(Assembly assembly, ManifestFile file, DateTimeOffset las
 
         public long Length => EnsureLength();
 
-        public string PhysicalPath => null;
+        public string? PhysicalPath => null;
 
-        public string Name => ManifestFile.Name;
+        public string? Name => ManifestFile.Name;
 
         public DateTimeOffset LastModified { get; }
 
@@ -48,24 +48,33 @@ private long EnsureLength()
         {
             if (_length == null)
             {
-                using (var stream = Assembly.GetManifestResourceStream(ManifestFile.ResourcePath))
-                {
-                    _length = stream.Length;
-                }
+                using var stream = GetManifestResourceStream();
+                _length = stream.Length;
             }
 
             return _length.Value;
         }
 
         public Stream CreateReadStream()
         {
-            var stream = Assembly.GetManifestResourceStream(ManifestFile.ResourcePath);
+            var stream = GetManifestResourceStream();
             if (!_length.HasValue)
             {
                 _length = stream.Length;
             }
 
             return stream;
         }
+
+        private Stream GetManifestResourceStream()
+        {
+            var stream = Assembly.GetManifestResourceStream(ManifestFile.ResourcePath);
+            if (stream == null)
+            {
+                throw new InvalidOperationException($"Couldn't get resource at '{ManifestFile.ResourcePath}'.");
+            }
+
+            return stream;
+        }
     }
 }
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestParser.cs b/src/FileProviders/Embedded/src/Manifest/ManifestParser.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -146,7 +146,7 @@ private static string EnsureText(XElement element)
             if (element.Elements().Count() == 0 &&
                 !element.IsEmpty &&
                 element.Nodes().Count() == 1 &&
-                element.FirstNode.NodeType == XmlNodeType.Text)
+                element.FirstNode?.NodeType == XmlNodeType.Text)
             {
                 return element.Value;
             }
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestRootDirectory.cs b/src/FileProviders/Embedded/src/Manifest/ManifestRootDirectory.cs
@@ -1,12 +1,12 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 namespace Microsoft.Extensions.FileProviders.Embedded.Manifest
 {
     internal class ManifestRootDirectory : ManifestDirectory
     {
         public ManifestRootDirectory(ManifestEntry[] children)
-            : base(name: null, children: children)
+            : base(name: string.Empty, children: children)
         {
             SetParent(ManifestSinkDirectory.Instance);
         }
diff --git a/src/FileProviders/Embedded/src/Manifest/ManifestSinkDirectory.cs b/src/FileProviders/Embedded/src/Manifest/ManifestSinkDirectory.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -9,7 +9,7 @@ namespace Microsoft.Extensions.FileProviders.Embedded.Manifest
     internal class ManifestSinkDirectory : ManifestDirectory
     {
         private ManifestSinkDirectory()
-            : base(name: null, children: Array.Empty<ManifestEntry>())
+            : base(name: string.Empty, children: Array.Empty<ManifestEntry>())
         {
             SetParent(this);
             Children = new[] { this };
diff --git a/src/FileProviders/Embedded/src/Microsoft.Extensions.FileProviders.Embedded.csproj b/src/FileProviders/Embedded/src/Microsoft.Extensions.FileProviders.Embedded.csproj
@@ -1,4 +1,4 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <RootNamespace>Microsoft.Extensions.FileProviders</RootNamespace>
@@ -11,6 +11,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>files;filesystem</PackageTags>
     <NoPackageAnalysis>true</NoPackageAnalysis>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/FileProviders/Embedded/src/PublicAPI.Shipped.txt b/src/FileProviders/Embedded/src/PublicAPI.Shipped.txt
diff --git a/src/FileProviders/Manifest.MSBuildTask/src/Microsoft.Extensions.FileProviders.Embedded.Manifest.Task.csproj b/src/FileProviders/Manifest.MSBuildTask/src/Microsoft.Extensions.FileProviders.Embedded.Manifest.Task.csproj

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public EmbeddedFileProvider(Assembly assembly)`
`41`	`41`	`/// </summary>`
`42`	`42`	`/// <param name="assembly">The assembly that contains the embedded resources.</param>`
`43`	`43`	`/// <param name="baseNamespace">The base namespace that contains the embedded resources.</param>`
`44`		`- public EmbeddedFileProvider(Assembly assembly, string baseNamespace)`
	`44`	`+ public EmbeddedFileProvider(Assembly assembly, string? baseNamespace)`
`45`	`45`	`{`
`46`	`46`	`if (assembly == null)`
`47`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) .NET Foundation. All rights reserved.`
	`1`	`+// Copyright (c) .NET Foundation. All rights reserved.`
`2`	`2`	`// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.`
`3`	`3`
`4`	`4`	`using System;`
`@@ -50,10 +50,8 @@ public long Length`
`50`	`50`	`{`
`51`	`51`	`if (!_length.HasValue)`
`52`	`52`	`{`
`53`		`- using (var stream = _assembly.GetManifestResourceStream(_resourcePath))`
`54`		`- {`
`55`		`- _length = stream.Length;`
`56`		`- }`
	`53`	`+ using var stream = GetManifestResourceStream();`
	`54`	`+ _length = stream.Length;`
`57`	`55`	`}`
`58`	`56`	`return _length.Value;`
`59`	`57`	`}`
`@@ -62,7 +60,7 @@ public long Length`
`62`	`60`	`/// <summary>`
`63`	`61`	`/// Always null.`
`64`	`62`	`/// </summary>`
`65`		`- public string PhysicalPath => null;`
	`63`	`+ public string? PhysicalPath => null;`
`66`	`64`
`67`	`65`	`/// <summary>`
`68`	`66`	`/// The name of embedded file`
`@@ -82,13 +80,24 @@ public long Length`
`82`	`80`	`/// <inheritdoc />`
`83`	`81`	`public Stream CreateReadStream()`
`84`	`82`	`{`
`85`		`- var stream = _assembly.GetManifestResourceStream(_resourcePath);`
	`83`	`+ var stream = GetManifestResourceStream();`
`86`	`84`	`if (!_length.HasValue)`
`87`	`85`	`{`
`88`	`86`	`_length = stream.Length;`
`89`	`87`	`}`
`90`	`88`
`91`	`89`	`return stream;`
`92`	`90`	`}`
	`91`	`+`
	`92`	`+ private Stream GetManifestResourceStream()`
	`93`	`+ {`
	`94`	`+ var stream = _assembly.GetManifestResourceStream(_resourcePath);`
	`95`	`+ if (stream == null)`
	`96`	`+ {`
	`97`	`+ throw new InvalidOperationException($"Couldn't get resource at '{_resourcePath}'.");`
	`98`	`+ }`
	`99`	`+`
	`100`	`+ return stream;`
	`101`	`+ }`
`93`	`102`	`}`
`94`	`103`	`}`