Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove ShellDescriptorManager dependency on YesSql.ISession #12906

Merged
merged 5 commits into from
Dec 15, 2022
Merged

Remove ShellDescriptorManager dependency on YesSql.ISession #12906

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4dc194
Fixes #10311 : Remove ShellDescriptorManager dependency on YesSql.ISe…
TFleury Dec 3, 2022
ddc5557
Remove unnecessary CommitAsync
TFleury Dec 4, 2022
653a9b9
Typo : React to reviews
TFleury Dec 9, 2022
e9d5d2b
React to reviews
TFleury Dec 13, 2022
3a63f75
Persist ShellDescriptor immediately
TFleury Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 39 additions & 49 deletions src/OrchardCore/OrchardCore.Infrastructure/Shell/ShellDescriptorManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Dapper;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using OrchardCore.Data.Documents;
using OrchardCore.Environment.Extensions;
using OrchardCore.Environment.Shell.Configuration;
using OrchardCore.Environment.Shell.Descriptor;
using OrchardCore.Environment.Shell.Descriptor.Models;
using OrchardCore.Modules;
using YesSql;

namespace OrchardCore.Environment.Shell.Data.Descriptors
{
Expand All @@ -25,70 +24,67 @@ public class ShellDescriptorManager : IShellDescriptorManager
private readonly IEnumerable<ShellFeature> _alwaysEnabledFeatures;
private readonly IEnumerable<IShellDescriptorManagerEventHandler> _shellDescriptorManagerEventHandlers;
private readonly IExtensionManager _extensionManager;
private readonly ISession _session;
private readonly IDocumentStore _documentStore;
private readonly ILogger _logger;

private ShellDescriptor _shellDescriptor;

public ShellDescriptorManager(
ShellSettings shellSettings,
IShellConfiguration shellConfiguration,
IEnumerable<ShellFeature> shellFeatures,
IEnumerable<IShellDescriptorManagerEventHandler> shellDescriptorManagerEventHandlers,
IExtensionManager extensionManager,
ISession session,
IDocumentStore documentStore,
ILogger<ShellDescriptorManager> logger)
{
_shellSettings = shellSettings;
_shellConfiguration = shellConfiguration;
_alwaysEnabledFeatures = shellFeatures.Where(f => f.AlwaysEnabled).ToArray();
_shellDescriptorManagerEventHandlers = shellDescriptorManagerEventHandlers;
_extensionManager = extensionManager;
_session = session;
_documentStore = documentStore;
_logger = logger;
}

public async Task<ShellDescriptor> GetShellDescriptorAsync()
{
// Prevent multiple queries during the same request
if (_shellDescriptor == null)
(var cacheable, var shellDescriptor) = await _documentStore.GetOrCreateImmutableAsync(ShellDescriptorFactory);
TFleury marked this conversation as resolved.
Show resolved Hide resolved

if (shellDescriptor.SerialNumber== 0)
TFleury marked this conversation as resolved.
Show resolved Hide resolved
{
_shellDescriptor = await _session.Query<ShellDescriptor>().FirstOrDefaultAsync();
return null;
}

if (_shellDescriptor != null)
{
var configuredFeatures = new ConfiguredFeatures();
_shellConfiguration.Bind(configuredFeatures);
if (cacheable)
TFleury marked this conversation as resolved.
Show resolved Hide resolved
{
// Init shell descriptor and load features
var configuredFeatures = new ConfiguredFeatures();
_shellConfiguration.Bind(configuredFeatures);

var features = _alwaysEnabledFeatures
.Concat(configuredFeatures.Features.Select(id => new ShellFeature(id) { AlwaysEnabled = true }))
.Concat(_shellDescriptor.Features)
.Distinct();
var features = _alwaysEnabledFeatures
.Concat(configuredFeatures.Features.Select(id => new ShellFeature(id) { AlwaysEnabled = true }))
.Concat(shellDescriptor.Features)
.Distinct();

var featureIds = features.Select(sf => sf.Id).ToArray();
var featureIds = features.Select(sf => sf.Id).ToArray();

var missingDependencies = (await _extensionManager.LoadFeaturesAsync(featureIds))
.Select(entry => entry.FeatureInfo.Id)
.Except(featureIds)
.Select(id => new ShellFeature(id));
var missingDependencies = (await _extensionManager.LoadFeaturesAsync(featureIds))
.Select(entry => entry.FeatureInfo.Id)
.Except(featureIds)
.Select(id => new ShellFeature(id));

_shellDescriptor.Features = features
.Concat(missingDependencies)
.ToList();
}
shellDescriptor.Features = features
.Concat(missingDependencies)
.ToList();
}

return _shellDescriptor;
return shellDescriptor;
}

public async Task UpdateShellDescriptorAsync(int priorSerialNumber, IEnumerable<ShellFeature> enabledFeatures)
{
var shellDescriptorRecord = await GetShellDescriptorAsync();
var serialNumber = shellDescriptorRecord == null
? 0
: shellDescriptorRecord.SerialNumber;
var shellDescriptor = await _documentStore.GetOrCreateMutableAsync(ShellDescriptorFactory);
TFleury marked this conversation as resolved.
Show resolved Hide resolved

if (priorSerialNumber != serialNumber)
if (priorSerialNumber != shellDescriptor.SerialNumber)
{
throw new InvalidOperationException("Invalid serial number for shell descriptor");
}
Expand All @@ -98,32 +94,26 @@ public async Task UpdateShellDescriptorAsync(int priorSerialNumber, IEnumerable<
_logger.LogInformation("Updating shell descriptor for tenant '{TenantName}' ...", _shellSettings.Name);
}

if (shellDescriptorRecord == null)
{
shellDescriptorRecord = new ShellDescriptor { SerialNumber = 1 };
}
else
{
shellDescriptorRecord.SerialNumber++;
}

shellDescriptorRecord.Features = _alwaysEnabledFeatures.Union(enabledFeatures).ToList();
shellDescriptorRecord.Installed = shellDescriptorRecord.Installed.Union(shellDescriptorRecord.Features).ToList();
shellDescriptor.SerialNumber++;
shellDescriptor.Features = _alwaysEnabledFeatures.Union(enabledFeatures).ToList();
shellDescriptor.Installed = shellDescriptor.Installed.Union(shellDescriptor.Features).ToList();

if (_logger.IsEnabled(LogLevel.Information))
{
_logger.LogInformation("Shell descriptor updated for tenant '{TenantName}'.", _shellSettings.Name);
}

_session.Save(shellDescriptorRecord);
await _documentStore.UpdateAsync(shellDescriptor, _ => Task.CompletedTask);
TFleury marked this conversation as resolved.
Show resolved Hide resolved

// In the 'ChangedAsync()' event the shell will be released so that, on request, a new one will be built.
// So, we commit the session earlier to prevent a new shell from being built from an outdated descriptor.

await _session.SaveChangesAsync();
TFleury marked this conversation as resolved.
Show resolved Hide resolved

await _shellDescriptorManagerEventHandlers.InvokeAsync((handler, shellDescriptorRecord, _shellSettings) =>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So here we could name the delegate parameter shellDescriptor in place of shellDescriptorRecord.

handler.ChangedAsync(shellDescriptorRecord, _shellSettings), shellDescriptorRecord, _shellSettings, _logger);
handler.ChangedAsync(shellDescriptorRecord, _shellSettings), shellDescriptor, _shellSettings, _logger);
}

private static Task<ShellDescriptor> ShellDescriptorFactory()
{
return Task.FromResult(new ShellDescriptor { SerialNumber = 0 });
sebastienros marked this conversation as resolved.
Show resolved Hide resolved
TFleury marked this conversation as resolved.
Show resolved Hide resolved
}

private class ConfiguredFeatures
Expand Down