Add Dependency Injection Support for ClientResourceManager

[SkyeHoefling]

Description of problem

There is no interface for ClientResourceManager and it does not currently support Dependency Injection

Description of solution

Extract interface and register with Dependency Injection container.

Description of alternatives considered

N/A

Screenshots

N/A

Additional context

This extension point will allow developers to add significant performance improvements to DNN. After modifying my ClientResourceManager with async scripts and adjusting orders I had DNN loading on average 100ms-300ms faster on each request. This performance change is a breaking change to DNN which is why I want to extract an interface instead. If we open up this extension point I can implement my performance changes as a module that can be used in current releases of DNN.

A proper implementation of this change will completely de-couple DNN from the 3rd party Client Resource Management tool used in DNN. It'll give us an opportunity to investigate new ways to handle client scripts that will work in a potential .NET Core solution of DNN.

Affected browser

N/A

I will be submitting a pull request for this, I have implemented this in a fork already and it is working

Required Work

DotNetNuke.Web.Client has a circular dependency with DotNetNuke.Library and the chosen solution at time of implementation was to side-load the dlls into memory using reflection. This is an anti-pattern but was needed to solve the problem at the time. Prior to completing any feature for this we should add Dependency Injection for the following areas of DNN

Feature/Control	Interface	Pull Request ID	Status
Globals.Status	IApplicationInfo & IApplicationStatusInfo	#3988	✅ Completed
HostController	IHostController	#3990	✅ Completed
PortalController	IPortalController
PortalAliasController	IPortalAliasController	#4021	✅ Completed

[david-poindexter]

@ahoefling this honestly sounds amazing! I am looking forward to seeing what this leads to.

[SkyeHoefling]

I created a table on the initial comment of this issue to document the required features needed before work on this can start.

[SkyeHoefling]

Only 2 more items to convert to Dependency Injection and then we can submit a PR for this. Making progress!

[SkyeHoefling]

@bdukes @mitchelsellers The last bit of required work is for the PortalController which is a very large chunk of work. Any idea on how we can break this into more manageable chunks for submit as PRs? I am thinking evaluate all the properties that are used in the PortalController and it's dependencies and extract those to interfaces first. That alone will be touching many files.

Curious if you have any ideas of the path of least resistance here

[mitchelsellers]

I think that makes sense

[bdukes]

Does it make sense to look at what's used by the ClientResourceManager, and see if those make sense to be extracted into their own smaller interface? We don't want to have 100 portal-related interfaces, but it could be nice and clean to have five or ten…

[SkyeHoefling]

When I was working on the ClientResourceManager I had everything ready to go, until I found this code that uses reflection to deal with a circular dependency.

Dnn.Platform/DNN Platform/DotNetNuke.Web.Client/ClientResourceSettings.cs

Lines 34 to 48 in bcf5fb7

	static ClientResourceSettings()
	{
	try
	{
	// all these types are part of the same library, so we don't need a separate catch for each one
	_commonGlobalsType = Type.GetType("DotNetNuke.Common.Globals, DotNetNuke");
	_portalControllerType = Type.GetType("DotNetNuke.Entities.Portals.PortalController, DotNetNuke");
	_portalAliasControllerType = Type.GetType("DotNetNuke.Entities.Portals.PortalAliasController, DotNetNuke");
	_hostControllerType = Type.GetType("DotNetNuke.Entities.Controllers.HostController, DotNetNuke");
	}
	catch (Exception)
	{
	// ignore
	}
	}

It appears that it is only using the GetPortalSettingsDictionary. Maybe we implement an IPortalSettingsService?

[SkyeHoefling]

Do we want to add an API structure similar to IHostSettingsService? This has very simple APIs for ready from the HostSettings table. The PortalSettings APIs on the PortalController seem to be get and update with a very verbose api structure. I think we should make it consistent

[SkyeHoefling]

What if we created a new ISettingsService interface or ISettingsServiceBase and then IHostSettingsService and IPortalSettingsService can both inherit from it.

public interface ISettingsService
{
    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    bool GetBoolean(string key);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="defaultValue">this value will be return if setting's value is empty.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    bool GetBoolean(string key, bool defaultValue);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    double GetDouble(string key);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="defaultValue">this value will be return if setting's value is empty.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    double GetDouble(string key, double defaultValue);

    /// <summary>
    /// takes in a text value, decrypts it with a FIPS compliant algorithm and returns the value.
    /// </summary>
    /// <param name="key">the host setting to read.</param>
    /// <param name="passPhrase">the pass phrase used for encryption/decryption.</param>
    /// <returns>The setting value as a <see cref="string"/>.</returns>
    string GetEncryptedString(string key, string passPhrase);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    int GetInteger(string key);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="defaultValue">this value will be return if setting's value is empty.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    int GetInteger(string key, int defaultValue);

    /// <summary>
    /// Gets all host settings.
    /// </summary>
    /// <returns>host setting.</returns>
    Dictionary<string, IConfigurationSetting> GetSettings();

    /// <summary>
    /// Gets all host settings as dictionary.
    /// </summary>
    /// <returns>host setting's value.</returns>
    Dictionary<string, string> GetSettingsDictionary();

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    string GetString(string key);

    /// <summary>
    /// Gets the setting value by the specific key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="defaultValue">this value will be return if setting's value is empty.</param>
    /// <returns>host setting's value.</returns>
    /// <exception cref="System.ArgumentException">key is empty.</exception>
    string GetString(string key, string defaultValue);

    /// <summary>
    /// Updates the specified config.
    /// </summary>
    /// <param name="config">The config.</param>
    void Update(IConfigurationSetting config);

    /// <summary>
    /// Updates the specified config.
    /// </summary>
    /// <param name="config">The config.</param>
    /// <param name="clearCache">if set to <c>true</c> will clear cache after updating the setting.</param>
    void Update(IConfigurationSetting config, bool clearCache);

    /// <summary>
    /// Updates the specified settings.
    /// </summary>
    /// <param name="settings">The settings.</param>
    void Update(Dictionary<string, string> settings);

    /// <summary>
    /// Updates the setting for a specified key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="value">The value.</param>
    void Update(string key, string value);

    /// <summary>
    /// Updates the specified key.
    /// </summary>
    /// <param name="key">The key.</param>
    /// <param name="value">The value.</param>
    /// <param name="clearCache">if set to <c>true</c> will clear cache after update settings.</param>
    void Update(string key, string value, bool clearCache);

    /// <summary>
    /// Takes in a <see cref="string"/> value, encrypts it with a FIPS compliant algorithm and stores it.
    /// </summary>
    /// <param name="key">host settings key.</param>
    /// <param name="value">host settings value.</param>
    /// <param name="passPhrase">pass phrase to allow encryption/decryption.</param>
    void UpdateEncryptedString(string key, string value, string passPhrase);
}

[bdukes]

I like that. If we can fit both into the same API shape, that'd be great.

The other settings don't support encrypted settings values (at least not right now), so my only concern would be that we create this base interface and then can't use it for future settings services.

I guess where does portal ID come into play with all of this? Would this always be for the current portal? What about tab/module/tabmodule/role/etc.? Do we need a settings service factory that takes the ID and returns an ISettingsService?

[SkyeHoefling]

We could encapsulate the ISettingsService inside the IPortalSettingsService. This could look like the code snippet below

ISettingsService GetPortalSettings(int portalId);

Then the consuming code would have a settings object that can easily manipulate any portal settings. This is going to require some thinking and rapid prototypes to see what works best.