Merge pull request #34 from umbraco-community/feature/nullable-types

Warren Buckley · web-flow · commit e18c43421d36 · 2022-08-05T11:28:10.000+01:00
Enable &amp; fix up any nullable type issues
diff --git a/Our.Umbraco.TagHelpers/ActiveClassTagHelper.cs b/Our.Umbraco.TagHelpers/ActiveClassTagHelper.cs
@@ -35,7 +35,7 @@ public ActiveClassTagHelper(IUmbracoContextAccessor umbracoContextAccessor)
         /// on an <a> tag when the page is active/selected
         /// </summary>
         [HtmlAttributeName(tagHelperAttributeName)]
-        public string ActiveClassName { get; set; }
+        public string? ActiveClassName { get; set; }
 
 
         /// <summary>
@@ -62,7 +62,7 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
 
             // Try & parse href as URI, as it could be relative or absolute
             // or contain a quersystring we only want the path part
-            if (Uri.TryCreate(href, UriKind.Absolute, out Uri link) || Uri.TryCreate(ctx.PublishedRequest.Uri, href, out link))
+            if (Uri.TryCreate(href, UriKind.Absolute, out Uri? link) || Uri.TryCreate(ctx.PublishedRequest.Uri, href, out link))
             {
                 // Get the node based of the value in the HREF
                 var nodeOfLink = ctx.Content.GetByRoute(link.AbsolutePath);
diff --git a/Our.Umbraco.TagHelpers/Composing/PackageManifestComposer.cs b/Our.Umbraco.TagHelpers/Composing/PackageManifestComposer.cs
@@ -17,7 +17,7 @@ public class TagHelperManifestFilter : IManifestFilter
     {
         public void Filter(List<PackageManifest> manifests)
         {
-            var version = typeof(TagHelperManifestFilter).Assembly.GetName().Version.ToString();
+            var version = typeof(TagHelperManifestFilter).Assembly.GetName()?.Version?.ToString() ?? "Unknown";
 
             manifests.Add(new PackageManifest
             {
diff --git a/Our.Umbraco.TagHelpers/DictionaryTagHelper.cs b/Our.Umbraco.TagHelpers/DictionaryTagHelper.cs
@@ -23,14 +23,14 @@ public DictionaryTagHelper(ILocalizationService localizationService)
         /// The dictionary key to translate
         /// </summary>
         [HtmlAttributeName("key")]
-        public string Key { get; set; }
+        public string? Key { get; set; }
 
         /// <summary>
         /// An optional attribute to set a fallback language to use
         /// If the current language does not contain a translation for the key
         /// </summary>
         [HtmlAttributeName("fallback-lang")]
-        public string FallbackLang { get; set; }
+        public string? FallbackLang { get; set; }
 
         public override void Process(TagHelperContext context, TagHelperOutput output)
         {
diff --git a/Our.Umbraco.TagHelpers/InlineSvgTagHelper.cs b/Our.Umbraco.TagHelpers/InlineSvgTagHelper.cs
@@ -30,14 +30,14 @@ public InlineSvgTagHelper(MediaFileManager mediaFileManager, IWebHostEnvironment
         /// NOTE: You cannot use this in conjuction with the media-item attribute
         /// </summary>
         [HtmlAttributeName("src")]
-        public string FileSource { get; set; }
+        public string? FileSource { get; set; }
 
         /// <summary>
         /// An IPublishedContent Umbraco Media Item that has an .svg file extension
         /// NOTE: You cannot use this in conjuction with the src attribute
         /// </summary>
         [HtmlAttributeName("media-item")]
-        public IPublishedContent MediaItem { get; set; }
+        public IPublishedContent? MediaItem { get; set; }
 
         public override void Process(TagHelperContext context, TagHelperOutput output)
         {
diff --git a/Our.Umbraco.TagHelpers/LanguageSwitcherTagHelper.cs b/Our.Umbraco.TagHelpers/LanguageSwitcherTagHelper.cs
@@ -52,7 +52,7 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu
                 var allDomains = umbracoContext.Domains.GetAll(false);
                 var allDomainsFiltered = allDomains?.GroupBy(d => d.Culture).Select(g => g.First()).ToList();
 
-                if (allDomainsFiltered.Count() > 0)
+                if (allDomainsFiltered?.Count() > 0)
                 {
                     // List of languages/model to use with
                     var data = new Dictionary<string, object>();
@@ -99,11 +99,11 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu
 
     public class LanguageSwitcherLang
     {
-        public string Culture { get; set; }
+        public string? Culture { get; set; }
 
-        public string Name { get; set; }
+        public string? Name { get; set; }
 
-        public string Url { get; set; }
+        public string? Url { get; set; }
 
         public bool IsCurrentLang { get; set; }
     }
diff --git a/Our.Umbraco.TagHelpers/MacroTagHelper.cs b/Our.Umbraco.TagHelpers/MacroTagHelper.cs
@@ -21,21 +21,21 @@ public class MacroTagHelper : TagHelper
         /// The alias of the Macro to execute
         /// </summary>
         [HtmlAttributeName("alias")]
-        public string MacroAlias { get; set; }
+        public string? MacroAlias { get; set; }
 
         /// <summary>
         /// An optional attribute to set the context of the Content that the Macro will use
         /// Without it set it will use the current page
         /// </summary>
         [HtmlAttributeName("content")]
-        public IPublishedContent ContentNode { get; set; }
+        public IPublishedContent? ContentNode { get; set; }
 
         /// <summary>
         /// An optional list of attributes that will map to Macro Parameters
         /// bind:myMacroParam="" bind:startNodeId="" etc...
         /// </summary>
         [HtmlAttributeName(DictionaryAttributePrefix = "bind:")]
-        public IDictionary<string, string> MacroParameters { get; set; } = new Dictionary<string, string>();
+        public IDictionary<string, string>? MacroParameters { get; set; } = new Dictionary<string, string>();
 
         public MacroTagHelper(IUmbracoComponentRenderer umbracoComponentRenderer, IUmbracoContextAccessor umbracoContextAccessor)
         {
@@ -59,7 +59,7 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu
             // TagHelpers dont seem to like HTMLAttributes as <string, object> dictionary
             // Hence us trying to convert it here
             IDictionary<string, object> macroParams = new Dictionary<string, object>();
-            if (MacroParameters.Any())
+            if (MacroParameters != null && MacroParameters.Any())
             {
                 macroParams = MacroParameters.ToDictionary(p => p.Key, p => (object)p.Value);
             }
diff --git a/Our.Umbraco.TagHelpers/MemberTagHelper.cs b/Our.Umbraco.TagHelpers/MemberTagHelper.cs
@@ -23,15 +23,15 @@ public class MemberTagHelper : TagHelper
         /// * = All authenticated users
         /// </summary>
         [HtmlAttributeName("our-member-exclude")]
-        public string ExcludeRoles { get; set; }
+        public string? ExcludeRoles { get; set; }
 
         /// <summary>
         /// A comma separated list of Member Groups to include
         /// ? = All anonymous users
         /// * = All authenticated users
         /// </summary>
         [HtmlAttributeName("our-member-include")]
-        public string IncludeRoles { get; set; }
+        public string? IncludeRoles { get; set; }
 
         public MemberTagHelper(IMemberManager memberManager)
         {
@@ -62,29 +62,30 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu
             }
         }
 
-        private bool IsUserInRole(string roleString, List<string> currentMemberRoles)
+        private bool IsUserInRole(string? roleString, List<string> currentMemberRoles)
         {
             // roles is a CSV of member groups they need to have access to
-            var roles = roleString.Split(',').Select(x => x.Trim());
-            foreach (var role in roles)
-            {
-                // Role ? == all anonymous users (User not logged in)
-                if (role == "?" && _memberManager.IsLoggedIn() == false)
+            var roles = roleString?.Split(',').Select(x => x.Trim());
+            if (roles != null)
+                foreach (var role in roles)
                 {
-                    return true;
-                }
+                    // Role ? == all anonymous users (User not logged in)
+                    if (role == "?" && _memberManager.IsLoggedIn() == false)
+                    {
+                        return true;
+                    }
 
-                // Role * == all authenticated users
-                if (role == "*" && _memberManager.IsLoggedIn())
-                {
-                    return true;
-                }
+                    // Role * == all authenticated users
+                    if (role == "*" && _memberManager.IsLoggedIn())
+                    {
+                        return true;
+                    }
 
-                if (currentMemberRoles.InvariantContains(role))
-                {
-                    return true;
+                    if (currentMemberRoles.InvariantContains(role))
+                    {
+                        return true;
+                    }
                 }
-            }
 
             return false;
         }
diff --git a/Our.Umbraco.TagHelpers/Our.Umbraco.TagHelpers.csproj b/Our.Umbraco.TagHelpers/Our.Umbraco.TagHelpers.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>net5.0;net6.0</TargetFrameworks>
+		<TargetFrameworks>net5.0;net6.0;</TargetFrameworks>
 	</PropertyGroup>
 
 	<PropertyGroup>
@@ -29,6 +29,7 @@
 		<PackageIcon>TagHelperLogo.png</PackageIcon>
 		<PackageTags>Umbraco;TagHelper;TagHelpers;UmbracoCMS</PackageTags>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
+		<Nullable>enable</Nullable>
 	</PropertyGroup>
 
 	<ItemGroup>
diff --git a/Our.Umbraco.TagHelpers/OurFallbackTagHelper.cs b/Our.Umbraco.TagHelpers/OurFallbackTagHelper.cs
@@ -17,7 +17,7 @@ public class OurFallbackTagHelper : TagHelper
         /// Would just be Header
         /// </summary>
         [HtmlAttributeName("property")]
-        public ModelExpression ModelProperty { get; set; }
+        public ModelExpression? ModelProperty { get; set; }
 
         [HtmlAttributeName("mode")]
         public Fallback Mode { get; set; }
@@ -26,17 +26,17 @@ public class OurFallbackTagHelper : TagHelper
         /// If using the fallback mode as Language then you can specify the culture to fallback to
         /// </summary>
         [HtmlAttributeName("culture")]
-        public string CultureCode { get; set; } = null;
+        public string? CultureCode { get; set; } = null;
 
         [HtmlAttributeNotBound]
         [ViewContext]
-        public ViewContext ViewContext { get; set; }
+        public ViewContext? ViewContext { get; set; }
 
         public override void Process(TagHelperContext context, TagHelperOutput output)
         {
             // Check to see that the Model Property is NOT a complex type or a collection of things
-            var isComplexType = ModelProperty.ModelExplorer.Metadata.IsComplexType;
-            var isEnumerableType = ModelProperty.ModelExplorer.Metadata.IsEnumerableType;
+            var isComplexType = ModelProperty != null && ModelProperty.ModelExplorer.Metadata.IsComplexType;
+            var isEnumerableType = ModelProperty != null && ModelProperty.ModelExplorer.Metadata.IsEnumerableType;
 
             // Only can support simpler things such as strings (as if collection)
             // We have no way of knowing how they want to iterate and display that HTML etc
@@ -47,7 +47,7 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
             }
 
             // Attempt to fetch/cast the Model as IPublishedContent
-            var contentNode = ViewContext.ViewData.Model as IPublishedContent;
+            var contentNode = ViewContext?.ViewData.Model as IPublishedContent;
             if(contentNode == null)
             {
                 output.SuppressOutput();
@@ -57,7 +57,7 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
             output.TagName = ""; // Remove the outer <our-fallback>
 
             // Get the Model property with fallback mode
-            var result = contentNode.Value(ModelProperty.Name, fallback: Mode, culture: CultureCode);
+            var result = contentNode.Value(ModelProperty?.Name, fallback: Mode, culture: CultureCode);
 
             // If we have a value that can be
             if (string.IsNullOrWhiteSpace($"{result}") == false)
diff --git a/Our.Umbraco.TagHelpers/Services/BackofficeUserAccessor.cs b/Our.Umbraco.TagHelpers/Services/BackofficeUserAccessor.cs
@@ -36,12 +36,12 @@ public ClaimsIdentity BackofficeUser
                     return new ClaimsIdentity();
 
                 CookieAuthenticationOptions cookieOptions = _cookieOptionsSnapshot.Get(global::Umbraco.Cms.Core.Constants.Security.BackOfficeAuthenticationType);
-                string backOfficeCookie = httpContext.Request.Cookies[cookieOptions.Cookie.Name!];
+                string? backOfficeCookie = httpContext.Request.Cookies[cookieOptions.Cookie.Name!];
 
                 if (string.IsNullOrEmpty(backOfficeCookie))
                     return new ClaimsIdentity();
 
-                AuthenticationTicket unprotected = cookieOptions.TicketDataFormat.Unprotect(backOfficeCookie!);
+                AuthenticationTicket? unprotected = cookieOptions.TicketDataFormat.Unprotect(backOfficeCookie!);
                 ClaimsIdentity backOfficeIdentity = unprotected!.Principal.GetUmbracoIdentity();
 
                 return backOfficeIdentity;
diff --git a/Our.Umbraco.TagHelpers/SurfaceControllerFormTagHelper.cs b/Our.Umbraco.TagHelpers/SurfaceControllerFormTagHelper.cs
@@ -16,19 +16,19 @@ namespace Our.Umbraco.TagHelpers
     public class SurfaceControllerFormTagHelper : TagHelper
     {
         private readonly IDataProtectionProvider _dataProtectionProvider;
-        private IDictionary<string, string> _routeValues;
+        private IDictionary<string, string>? _routeValues;
 
         /// <summary>
         /// The name of the action method.
         /// </summary>
         [HtmlAttributeName("our-action")]
-        public string ControllerAction { get; set; }
+        public string? ControllerAction { get; set; }
 
         /// <summary>
         /// The name of the Umbraco controller minus the 'Controller' suffix.
         /// </summary>
         [HtmlAttributeName("our-controller")]
-        public string ControllerName { get; set; }
+        public string? ControllerName { get; set; }
 
         /// <summary>
         /// The name of the area.
@@ -40,7 +40,7 @@ public class SurfaceControllerFormTagHelper : TagHelper
         /// Additional parameters for the route.
         /// </summary>
         [HtmlAttributeName("our-route-vals", DictionaryAttributePrefix = "our-route-val")]
-        public IDictionary<string, string> RouteValues
+        public IDictionary<string, string>? RouteValues
         {
             get
             {
@@ -62,7 +62,7 @@ public IDictionary<string, string> RouteValues
         /// </summary>
         [HtmlAttributeNotBound]
         [ViewContext]
-        public ViewContext ViewContext { get; set; }
+        public ViewContext? ViewContext { get; set; }
 
         public SurfaceControllerFormTagHelper(IDataProtectionProvider dataProtectionProvider)
         {
diff --git a/Our.Umbraco.TagHelpers/UserTagHelper.cs b/Our.Umbraco.TagHelpers/UserTagHelper.cs
@@ -24,15 +24,15 @@ public class UserTagHelper : TagHelper
         /// * = All authenticated users
         /// </summary>
         [HtmlAttributeName("our-user-exclude")]
-        public string ExcludeGroups { get; set; }
+        public string? ExcludeGroups { get; set; }
 
         /// <summary>
         /// A comma separated list of User Groups to include
         /// ? = All anonymous users
         /// * = All authenticated users
         /// </summary>
         [HtmlAttributeName("our-user-include")]
-        public string IncludeGroups { get; set; }
+        public string? IncludeGroups { get; set; }
 
         public UserTagHelper(IBackofficeUserAccessor backofficeUserAccessor)
         {
@@ -47,21 +47,21 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
             {
                 var groups = currentUser.GetRoles();
                 currentUserGroups.AddRange(groups);
-            }
 
-            // Process excluded roles
-            if (!string.IsNullOrWhiteSpace(this.ExcludeGroups) && IsUserInRole(currentUser, ExcludeGroups, currentUserGroups) == true)
-            {
-                output.SuppressOutput();
-                return;
-            }
+                // Process excluded roles
+                if (!string.IsNullOrWhiteSpace(this.ExcludeGroups) && IsUserInRole(currentUser, ExcludeGroups, currentUserGroups) == true)
+                {
+                    output.SuppressOutput();
+                    return;
+                }
 
-            // Process included roles
-            else if (!string.IsNullOrWhiteSpace(this.IncludeGroups) && IsUserInRole(currentUser, IncludeGroups, currentUserGroups) == false)
-            {
-                output.SuppressOutput();
-                return;
-            }
+                // Process included roles
+                else if (!string.IsNullOrWhiteSpace(this.IncludeGroups) && IsUserInRole(currentUser, IncludeGroups, currentUserGroups) == false)
+                {
+                    output.SuppressOutput();
+                    return;
+                }
+            }            
         }
 
         private bool IsUserInRole(ClaimsIdentity currentUser, string roleString, List<string> currentMemberRoles)
diff --git a/Our.Umbraco.TagHelpers/VersionTagHelper.cs b/Our.Umbraco.TagHelpers/VersionTagHelper.cs
@@ -28,8 +28,8 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
             if (string.IsNullOrEmpty(AssemblyName))
             {
                 var siteAssembly = Assembly.GetEntryAssembly();
-                var version = siteAssembly?.GetName().Version;
-                output.Content.SetHtmlContent(version.ToString());
+                var version = siteAssembly?.GetName()?.Version;
+                output.Content.SetHtmlContent(version?.ToString());
                 return;
             }
 
@@ -40,7 +40,7 @@ public override void Process(TagHelperContext context, TagHelperOutput output)
                 output.SuppressOutput();
                 return;
             }
-            output.Content.SetHtmlContent(findAssembly.GetName().Version.ToString());
+            output.Content.SetHtmlContent(findAssembly.GetName()?.Version?.ToString());
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public class TagHelperManifestFilter : IManifestFilter`
`17`	`17`	`{`
`18`	`18`	`public void Filter(List<PackageManifest> manifests)`
`19`	`19`	`{`
`20`		`- var version = typeof(TagHelperManifestFilter).Assembly.GetName().Version.ToString();`
	`20`	`+ var version = typeof(TagHelperManifestFilter).Assembly.GetName()?.Version?.ToString() ?? "Unknown";`
`21`	`21`
`22`	`22`	`manifests.Add(new PackageManifest`
`23`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu`
`52`	`52`	`var allDomains = umbracoContext.Domains.GetAll(false);`
`53`	`53`	`var allDomainsFiltered = allDomains?.GroupBy(d => d.Culture).Select(g => g.First()).ToList();`
`54`	`54`
`55`		`- if (allDomainsFiltered.Count() > 0)`
	`55`	`+ if (allDomainsFiltered?.Count() > 0)`
`56`	`56`	`{`
`57`	`57`	`// List of languages/model to use with`
`58`	`58`	`var data = new Dictionary<string, object>();`
`@@ -99,11 +99,11 @@ public override async Task ProcessAsync(TagHelperContext context, TagHelperOutpu`
`99`	`99`
`100`	`100`	`public class LanguageSwitcherLang`
`101`	`101`	`{`
`102`		`- public string Culture { get; set; }`
	`102`	`+ public string? Culture { get; set; }`
`103`	`103`
`104`		`- public string Name { get; set; }`
	`104`	`+ public string? Name { get; set; }`
`105`	`105`
`106`		`- public string Url { get; set; }`
	`106`	`+ public string? Url { get; set; }`
`107`	`107`
`108`	`108`	`public bool IsCurrentLang { get; set; }`
`109`	`109`	`}`