Created IApplicationInfo and IApplicationStatusInfo for Dependency Injection #3988

SkyeHoefling · 2020-08-16T06:08:51Z

Related to #3985

Summary

This does not close the linked work item, but is required before I can submit a pull request.

While working on changes to the Client Resource Manager I noticed circular dependency between DotNetNuke.Libary and DotNetNuke.Web.Client. The ClientDependencySetting utilizes reflection to workaround the circular dependency. Dynamically loading types like this is considered an anti-pattern, especially when we can use depenency injection to extract an interface.

This Pull Request extracts 2 interfaces from the Globals.cs

IApplicationInfo
IApplicationStatusInfo

SkyeHoefling · 2020-08-16T17:00:12Z

DNN Platform/Library/Application/AssemblyStatusAttribute.cs

@@ -26,27 +26,27 @@ public enum ReleaseMode
        /// <summary>
        /// Not asssigned
        /// </summary>
-        None,
+        None = 0,


I Added explicit numbers here to ensure this enum interops correctly with the new DotNetNuke.Abstractions enum. This will prevent any accidental breaking changes if the enums are ever re-ordered or changed. When we are converting the enums it is a simple cast as the int value matches, there is no need for a complex conversion method.

SkyeHoefling · 2020-08-16T17:01:52Z

DNN Platform/Library/Application/AssemblyStatusAttribute.cs


        /// <summary>
        /// Alpha release
        /// </summary>
-        Alpha,
+        Alpha = 1,


See above comment - https://github.com/dnnsoftware/Dnn.Platform/pull/3988/files#r471134926

SkyeHoefling · 2020-08-16T17:05:23Z

DNN Platform/Library/Application/DotNetNukeContext.cs

                {
-                    _current = new DotNetNukeContext();
+                    current = Globals.DependencyProvider.GetRequiredService<IDnnContext>();


Should we deprecate this function and ask consumers to use Dependency Injection? I decided not to deprecate this function because I didn't add the remaining members to the new IDnnContext. I think once we add the remaining members we can deprecate this method and recommend Dependency Injection.

If reviewers are in agreement I can create a work item

SkyeHoefling · 2020-08-16T17:06:37Z

DNN Platform/Library/Application/DotNetNukeContext.cs

-                return this._application;
-            }
-        }
+        public Application Application { get => this.applicationInfo is Application app ? app : new Application(); }


If the class is instantiated without Dependency Injection for some reason such as unit tests, I updated a default Application instantiation. Maybe we should update this to the DependencyProvider

SkyeHoefling · 2020-08-16T17:07:32Z

DNN Platform/Library/Common/Globals.cs

@@ -316,28 +316,28 @@ public enum UpgradeStatus
            /// <summary>
            /// The application need update to a higher version.
            /// </summary>
-            Upgrade,
+            Upgrade = 0,


See above comment about enums - https://github.com/dnnsoftware/Dnn.Platform/pull/3988/files#r471134926

SkyeHoefling · 2020-08-16T17:09:56Z

DNN Platform/Tests/DotNetNuke.Tests.Core/Controllers/Search/SearchControllerTests.cs

@@ -139,6 +141,10 @@ public void SetUp()
            ComponentFactory.Container = new SimpleContainer();
            MockComponentProvider.ResetContainer();

+            var serviceCollection = new ServiceCollection();
+            serviceCollection.AddTransient<IApplicationStatusInfo>(container => new DotNetNuke.Application.ApplicationStatusInfo(Mock.Of<IApplicationInfo>()));


Many of the unit tests depend on File Operations that are generated from the MapApplicationPath function. It was difficult to mock this out and it was easier to use an actual implementation of IApplicationStatusInfo instead of a mock.

SkyeHoefling · 2020-08-16T19:36:14Z

DNN Platform/Library/Common/Globals.cs

+        /// </summary>
+        private static void OnDependencyProviderChanged(object sender, PropertyChangedEventArgs eventArguments)
+        {
+            applicationStatusInfo = DependencyProvider.GetRequiredService<IApplicationStatusInfo>();


Creating a method to register dependencies once the provider has been configured is needed since the DependencyProvider uses our custom LazyServiceProvider. It is critical that the Global.cs resolves only ONE instance of a dependency, as it can generate too many sql connections that causes DNN to stop functioning.

This finding has been documented - #3989

SkyeHoefling · 2020-08-16T20:12:29Z

DNN Platform/DotNetNuke.Web/Common/LazyServiceProvider.cs

        }

        internal void SetProvider(IServiceProvider serviceProvider)
        {
-            this._serviceProvider = serviceProvider;
+            this.serviceProvider = serviceProvider;
+            this.PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(serviceProvider)));


I added INotifyPropertyChanged here to allow the Globals.cs to listen for an event when the Service Provider is ready for us. Since the Globals.cs is wrapping several Dependency Injection calls as we deprecate methods it is important that it can resolve dependencies once they are available. This is critical when using Globals.cs at startup.

I decided on INotifyPropertyChanged as it is a .NET Standard type and is used in the desktop/mobile space a lot for notifying objects when something has changed. If there is a better option, I am more than happy to change this

SkyeHoefling · 2020-08-16T23:48:19Z

This is ready for review

I added single line comments around sections of the code that needed extra explanation of why I made some changes. All unit tests are passing. I downloaded the build artifacts and validated that it does install DNN correctly for a new installation.

SkyeHoefling · 2020-08-17T13:33:06Z

I'm not sure why it shows the build is still in progress. I just checked the build server and the build for this PR is showed success

https://dev.azure.com/dotnet/DNN/_build/results?buildId=37348&view=results

DNN Platform/Library/Application/DotNetNukeContext.cs

bdukes

Looks great, thanks @ahoefling!

bdukes · 2020-08-18T19:06:33Z

/azp run

azure-pipelines · 2020-08-18T19:06:39Z

No pipelines are associated with this pull request.

…rked related global apis as deprecated

…ection

…lobal methods that needed to use new way of handling application status via IApplicationStatusInfo

…obals to listen for when the provider is set and update any dependencies in the Globals class

…ement INotifyPropertyChanged (useful for unit testing). Updated unit tests to mock out IApplicationStatusInfo

…sinfo and resolve it only once

…rtup now

DNN Platform/Library/Common/Globals.cs

…xt and deprecated it. This will prevent a breaking change

DNN Platform/Library/Application/DotNetNukeContext.cs

Co-authored-by: Brian Dukes <bdukes@engagesoftware.com>

…cy Injection

SkyeHoefling · 2020-08-19T14:16:49Z

@bdukes I believe I have addressed all of your concerns in the latest update. Let me know if there is anything else I need to do to get this PR ready to merge

mitchelsellers · 2020-08-19T15:39:41Z

@bdukes We good for this to be merged for 9.7.1? I don't think it will be a big/breaking issue.

bdukes · 2020-08-19T15:47:27Z

valadas · 2020-08-24T04:25:31Z

Amazing work!

SkyeHoefling commented Aug 16, 2020

View reviewed changes

SkyeHoefling mentioned this pull request Aug 17, 2020

Created IHostSettingsService for Dependency Injection #3990

Merged

bdukes reviewed Aug 17, 2020

View reviewed changes

DNN Platform/Library/Application/DotNetNukeContext.cs Show resolved Hide resolved

bdukes approved these changes Aug 17, 2020

View reviewed changes

bdukes added the Type: Enhancement label Aug 18, 2020

SkyeHoefling added 14 commits August 18, 2020 20:10

Created IApplicationInfo and IApplicationStatusInfo interfaces and ma…

a5f14fe

…rked related global apis as deprecated

Fixed failing tests

04513f6

Fixed more unit tests

a733773

Fixed unit tests

90b64f9

Fixed last set of failing tests

a81dd60

Added public default constructor which is required for dependency inj…

e9dc8a6

…ection

Added missing dependency injection registration of IDnnContext

a3b51b8

Fixed up deprecation message to match doc recommendations; Adjusted g…

dd68762

…lobal methods that needed to use new way of handling application status via IApplicationStatusInfo

Added INotifyPropertyChanged to the LazyServiceProvider this allow Gl…

f7ec93f

…obals to listen for when the provider is set and update any dependencies in the Globals class

Updated global to immediately resolve dependencies if it doesn't impl…

6136fa4

…ement INotifyPropertyChanged (useful for unit testing). Updated unit tests to mock out IApplicationStatusInfo

Added mocks for DependencyProvider

a72aecb

Fixed failing unit tests

dd3453a

Updated navigation manager to follow same pattern as applicationstatu…

0180aee

…sinfo and resolve it only once

Added mocks for INavigationManager since it needs to be loaded onts a…

95ebc7a

…rtup now

SkyeHoefling added 2 commits August 18, 2020 20:10

Added missing .csproj

044bf40

Updated dependency registration

477b875

SkyeHoefling commented Aug 19, 2020

View reviewed changes

DNN Platform/Library/Common/Globals.cs Outdated Show resolved Hide resolved

Added the default protected constructor back into the DotNetNukeConte…

1632371

…xt and deprecated it. This will prevent a breaking change

SkyeHoefling force-pushed the application_info branch from 46e521d to 1632371 Compare August 19, 2020 00:39

bdukes reviewed Aug 19, 2020

View reviewed changes

DNN Platform/Library/Application/DotNetNukeContext.cs Show resolved Hide resolved

SkyeHoefling and others added 2 commits August 19, 2020 10:10

Updated deprecation notice on protected constructor

d27bb3e

Co-authored-by: Brian Dukes <bdukes@engagesoftware.com>

Updated deprecation notice in Globals.cs to explain on using Dependen…

d1353db

…cy Injection

bdukes approved these changes Aug 19, 2020

View reviewed changes

bdukes modified the milestones: 9.8.0, 9.7.1 Aug 19, 2020

mitchelsellers approved these changes Aug 19, 2020

View reviewed changes

bdukes merged commit a2317ae into dnnsoftware:develop Aug 19, 2020

SkyeHoefling mentioned this pull request Aug 20, 2020

Add Dependency Injection Support for ClientResourceManager #3985

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created IApplicationInfo and IApplicationStatusInfo for Dependency Injection #3988

Created IApplicationInfo and IApplicationStatusInfo for Dependency Injection #3988

SkyeHoefling commented Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling Aug 16, 2020

SkyeHoefling commented Aug 16, 2020

SkyeHoefling commented Aug 17, 2020

bdukes left a comment

bdukes commented Aug 18, 2020

azure-pipelines bot commented Aug 18, 2020

SkyeHoefling commented Aug 19, 2020

mitchelsellers commented Aug 19, 2020

bdukes commented Aug 19, 2020

valadas commented Aug 24, 2020

Created IApplicationInfo and IApplicationStatusInfo for Dependency Injection #3988

Created IApplicationInfo and IApplicationStatusInfo for Dependency Injection #3988

Conversation

SkyeHoefling commented Aug 16, 2020

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SkyeHoefling commented Aug 16, 2020

SkyeHoefling commented Aug 17, 2020

bdukes left a comment

Choose a reason for hiding this comment

bdukes commented Aug 18, 2020

azure-pipelines bot commented Aug 18, 2020

SkyeHoefling commented Aug 19, 2020

mitchelsellers commented Aug 19, 2020

bdukes commented Aug 19, 2020

valadas commented Aug 24, 2020