Fixed an issue with settings caching using SettingsRepository #5742
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
One may have a settings class that includes a mix of HostSettings, PortalSettings, ModuleSettings and TabModuleSettings. The previous mechanism had different cache keys for PortalId or TabModuleId, but that brough 2 problems: 1. It is possible to have the same number for a portalId and TabModuleId which would invalidate the wrong cache. 2. When reading settings using the GetSettings method overload that takes moduleInfo, it would get stale settings for all PortalSettings if it was saved also using moduleInfo overload. I am on the fence about this PR, but it caches now using always portalId. PROS: It fixed the issue at hand. CONS: It clears the portal settings cache to be clear, not the whole portal settings cache but only the specifiec settings class type being requested. This is maybe a tiny tiny bit of a performance hit, but it's not like saving settings is something that gets hammerd. So I believe the benifits here outweigh the drawbacks. Closes dnnsoftware#5739 Possibly a different fix for the workaround in dnnsoftware#3756 but I don't have any MVC custom module to test that part...
bdukes
approved these changes
Jul 15, 2023
mitchelsellers
approved these changes
Jul 15, 2023
2 tasks
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One may have a settings class that includes a mix of HostSettings, PortalSettings, ModuleSettings and TabModuleSettings.
The previous mechanism had different cache keys for PortalId or TabModuleId, but that brought 2 problems:
I am on the fence about this PR, but it caches now using always portalId.
PROS: It fixed the issue at hand.
CONS: It clears the portal settings cache to be clear, not the whole portal settings cache but only the specified settings class type being requested. This is maybe a tiny tiny bit of a performance hit, but it's not like saving settings is something that gets hammered.
So I believe the benefits here outweigh the drawbacks.
Closes #5739
Possibly a different fix for the workaround in #3756 but I don't have any MVC custom module to test that part...
Would you like to try removing the previous workaround and test an MVC module to see @donker ?