mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2026-02-09 09:16:41 +08:00
Simplified distributed locking implementation and did the following:
- Added Support for re-entry - Made TryAcquireLock method thread-safe. - Changed the way locks are released by decreasing their ref count. A lock is expired if: a) ref count == 0 or b) ExpiredUtc lies in the past. It is no longer necessary to delete a lock record (but would be fine, maybe as a background task).
This commit is contained in:
@@ -292,7 +292,7 @@
|
|||||||
<Compile Include="Stubs\StubVirtualPathMonitor.cs" />
|
<Compile Include="Stubs\StubVirtualPathMonitor.cs" />
|
||||||
<Compile Include="Stubs\StubCacheManager.cs" />
|
<Compile Include="Stubs\StubCacheManager.cs" />
|
||||||
<Compile Include="Stubs\StubWebSiteFolder.cs" />
|
<Compile Include="Stubs\StubWebSiteFolder.cs" />
|
||||||
<Compile Include="Tasks\DatabaseLockTests.cs" />
|
<Compile Include="Tasks\LockTests.cs" />
|
||||||
<Compile Include="Tasks\DistributedLockServiceTests.cs" />
|
<Compile Include="Tasks\DistributedLockServiceTests.cs" />
|
||||||
<Compile Include="Time\TimeZoneSelectorTests.cs" />
|
<Compile Include="Time\TimeZoneSelectorTests.cs" />
|
||||||
<Compile Include="UI\Resources\ResourceManagerTests.cs" />
|
<Compile Include="UI\Resources\ResourceManagerTests.cs" />
|
||||||
|
|||||||
@@ -3,25 +3,13 @@ using Orchard.Tasks.Locking.Services;
|
|||||||
|
|
||||||
namespace Orchard.Tests.Stubs {
|
namespace Orchard.Tests.Stubs {
|
||||||
public class StubDistributedLock : IDistributedLock {
|
public class StubDistributedLock : IDistributedLock {
|
||||||
public static bool IsAcquired { get; private set; }
|
|
||||||
public static string AcquiredByMachineName { get; private set; }
|
|
||||||
|
|
||||||
public bool IsDisposed { get; private set; }
|
public bool IsDisposed { get; private set; }
|
||||||
|
|
||||||
public bool TryAcquire(string name, string machineName, TimeSpan maxLifetime) {
|
|
||||||
if (IsAcquired && machineName != AcquiredByMachineName)
|
|
||||||
return false;
|
|
||||||
|
|
||||||
IsAcquired = true;
|
|
||||||
AcquiredByMachineName = machineName;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public void Dispose() {
|
public void Dispose() {
|
||||||
IsDisposed = true;
|
IsDisposed = true;
|
||||||
IsAcquired = false;
|
|
||||||
AcquiredByMachineName = null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public int Id { get; set; }
|
||||||
|
public string Name { get; set; }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Collections.Generic;
|
|
||||||
using System.Linq;
|
|
||||||
using Autofac;
|
|
||||||
using NUnit.Framework;
|
|
||||||
using Orchard.Data;
|
|
||||||
using Orchard.Tasks.Locking.Providers;
|
|
||||||
using Orchard.Tasks.Locking.Records;
|
|
||||||
|
|
||||||
namespace Orchard.Tests.Tasks {
|
|
||||||
[TestFixture]
|
|
||||||
public class DatabaseLockTests : DatabaseEnabledTestsBase {
|
|
||||||
private const string MachineName1 = "Orchard Testing Machine 1";
|
|
||||||
private const string MachineName2 = "Orchard Testing Machine 2";
|
|
||||||
private const string LockName = "Orchard Test Lock";
|
|
||||||
private IRepository<DatabaseLockRecord> _databaseLockRepository;
|
|
||||||
private DatabaseLock _lock;
|
|
||||||
|
|
||||||
protected override IEnumerable<Type> DatabaseTypes {
|
|
||||||
get {
|
|
||||||
yield return typeof(DatabaseLockRecord);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public override void Register(ContainerBuilder builder) {
|
|
||||||
builder.RegisterType<DatabaseLock>().AsSelf();
|
|
||||||
}
|
|
||||||
|
|
||||||
public override void Init() {
|
|
||||||
base.Init();
|
|
||||||
|
|
||||||
_databaseLockRepository = _container.Resolve<IRepository<DatabaseLockRecord>>();
|
|
||||||
_lock = _container.Resolve<DatabaseLock>();
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void AcquiringLockSucceeds() {
|
|
||||||
var lockAcquired = _lock.TryAcquire(LockName, MachineName1, TimeSpan.FromSeconds(60));
|
|
||||||
|
|
||||||
Assert.That(lockAcquired, Is.True);
|
|
||||||
Assert.That(_databaseLockRepository.Table.Count(), Is.EqualTo(1));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void DisposingRemovesLockRecord() {
|
|
||||||
_lock.TryAcquire(LockName, MachineName1, TimeSpan.FromSeconds(60));
|
|
||||||
_lock.Dispose();
|
|
||||||
Assert.That(_databaseLockRepository.Table.Count(), Is.EqualTo(0));
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void AcquiringLockTwiceFails() {
|
|
||||||
var attempt1 = _lock.TryAcquire(LockName, MachineName1, TimeSpan.FromSeconds(60));
|
|
||||||
var attempt2 = _lock.TryAcquire(LockName, MachineName2, TimeSpan.FromSeconds(60));
|
|
||||||
|
|
||||||
Assert.That(attempt1, Is.True);
|
|
||||||
Assert.That(attempt2, Is.False);
|
|
||||||
}
|
|
||||||
|
|
||||||
[Test]
|
|
||||||
public void AcquiringExpiredLockSucceeds() {
|
|
||||||
var attempt1 = _lock.TryAcquire(LockName, MachineName1, TimeSpan.FromSeconds(60));
|
|
||||||
var attempt2 = _lock.TryAcquire(LockName, MachineName2, TimeSpan.FromSeconds(-1)); // Treat the previosuly stored lock as immediately expired.
|
|
||||||
|
|
||||||
Assert.That(attempt1, Is.True);
|
|
||||||
Assert.That(attempt2, Is.True);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -4,28 +4,40 @@ using System.Linq;
|
|||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using Autofac;
|
using Autofac;
|
||||||
using NUnit.Framework;
|
using NUnit.Framework;
|
||||||
|
using Orchard.Data;
|
||||||
using Orchard.Environment;
|
using Orchard.Environment;
|
||||||
|
using Orchard.Services;
|
||||||
|
using Orchard.Tasks.Locking.Records;
|
||||||
using Orchard.Tasks.Locking.Services;
|
using Orchard.Tasks.Locking.Services;
|
||||||
using Orchard.Tests.Stubs;
|
using Orchard.Tests.Stubs;
|
||||||
|
|
||||||
namespace Orchard.Tests.Tasks {
|
namespace Orchard.Tests.Tasks {
|
||||||
[TestFixture]
|
[TestFixture]
|
||||||
public class DistributedLockServiceTests : ContainerTestBase {
|
public class DistributedLockServiceTests : DatabaseEnabledTestsBase {
|
||||||
private const string LockName = "Orchard Test Lock";
|
private const string LockName = "Orchard Test Lock";
|
||||||
private DistributedLockService _distributedLockService;
|
private DistributedLockService _distributedLockService;
|
||||||
private StubMachineNameProvider _stubMachineNameProvider;
|
private StubMachineNameProvider _stubMachineNameProvider;
|
||||||
|
private IRepository<LockRecord> _lockRepository;
|
||||||
|
|
||||||
protected override void Register(ContainerBuilder builder) {
|
protected override IEnumerable<Type> DatabaseTypes
|
||||||
builder.RegisterType<StubWorkContextAccessor>().As<IWorkContextAccessor>();
|
{
|
||||||
|
get { yield return typeof (LockRecord); }
|
||||||
|
}
|
||||||
|
|
||||||
|
public override void Register(ContainerBuilder builder) {
|
||||||
|
builder.RegisterType<StubClock>().As<IClock>();
|
||||||
|
//builder.RegisterType<StubWorkContextAccessor>().As<IWorkContextAccessor>();
|
||||||
builder.RegisterType<StubMachineNameProvider>().As<IMachineNameProvider>().SingleInstance();
|
builder.RegisterType<StubMachineNameProvider>().As<IMachineNameProvider>().SingleInstance();
|
||||||
builder.RegisterType<StubDistributedLock>().As<IDistributedLock>();
|
builder.RegisterType<StubDistributedLock>().As<IDistributedLock>();
|
||||||
builder.RegisterType<DistributedLockService>().AsSelf();
|
builder.RegisterType<DistributedLockService>().AsSelf();
|
||||||
builder.RegisterInstance(new Work<IDistributedLock>(resolve => _container.Resolve<IDistributedLock>())).AsSelf();
|
builder.RegisterInstance(new Work<IDistributedLock>(resolve => _container.Resolve<IDistributedLock>())).AsSelf();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected override void Resolve(ILifetimeScope container) {
|
public override void Init() {
|
||||||
_distributedLockService = container.Resolve<DistributedLockService>();
|
base.Init();
|
||||||
_stubMachineNameProvider = (StubMachineNameProvider)container.Resolve<IMachineNameProvider>();
|
_distributedLockService = _container.Resolve<DistributedLockService>();
|
||||||
|
_stubMachineNameProvider = (StubMachineNameProvider)_container.Resolve<IMachineNameProvider>();
|
||||||
|
_lockRepository = _container.Resolve<IRepository<LockRecord>>();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -47,6 +59,30 @@ namespace Orchard.Tests.Tasks {
|
|||||||
Assert.That(attempt2, Is.True);
|
Assert.That(attempt2, Is.True);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void AcquiringLockTwiceOnSameMachineIncreasesRefCountTwice() {
|
||||||
|
IDistributedLock @lock;
|
||||||
|
_distributedLockService.TryAcquireLock(LockName, TimeSpan.FromSeconds(60), TimeSpan.Zero, out @lock);
|
||||||
|
_distributedLockService.TryAcquireLock(LockName, TimeSpan.FromSeconds(60), TimeSpan.Zero, out @lock);
|
||||||
|
|
||||||
|
var lockRecord = _lockRepository.Get(@lock.Id);
|
||||||
|
Assert.That(lockRecord.ReferenceCount, Is.EqualTo(2));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void DisposingLockWillDecreaseRefCount() {
|
||||||
|
IDistributedLock @lock;
|
||||||
|
_distributedLockService.TryAcquireLock(LockName, TimeSpan.FromSeconds(60), TimeSpan.Zero, out @lock);
|
||||||
|
_distributedLockService.TryAcquireLock(LockName, TimeSpan.FromSeconds(60), TimeSpan.Zero, out @lock);
|
||||||
|
var lockRecord = _lockRepository.Get(@lock.Id);
|
||||||
|
|
||||||
|
_distributedLockService.DisposeLock(@lock);
|
||||||
|
Assert.That(lockRecord.ReferenceCount, Is.EqualTo(1));
|
||||||
|
|
||||||
|
_distributedLockService.DisposeLock(@lock);
|
||||||
|
Assert.That(lockRecord.ReferenceCount, Is.EqualTo(0));
|
||||||
|
}
|
||||||
|
|
||||||
[Test]
|
[Test]
|
||||||
public void AcquiringLockTwiceFails() {
|
public void AcquiringLockTwiceFails() {
|
||||||
IDistributedLock @lock;
|
IDistributedLock @lock;
|
||||||
@@ -64,7 +100,7 @@ namespace Orchard.Tests.Tasks {
|
|||||||
var attempts = new List<bool>();
|
var attempts = new List<bool>();
|
||||||
var tasks = new List<Task>();
|
var tasks = new List<Task>();
|
||||||
|
|
||||||
foreach (var index in Enumerable.Range(0, 10).AsParallel()) {
|
foreach (var index in Enumerable.Range(0, 20)) {
|
||||||
var task = Task.Factory.StartNew(() => {
|
var task = Task.Factory.StartNew(() => {
|
||||||
IDistributedLock @lock;
|
IDistributedLock @lock;
|
||||||
_stubMachineNameProvider.MachineName = "Orchard Test Machine " + (index + 1);
|
_stubMachineNameProvider.MachineName = "Orchard Test Machine " + (index + 1);
|
||||||
|
|||||||
40
src/Orchard.Tests/Tasks/LockTests.cs
Normal file
40
src/Orchard.Tests/Tasks/LockTests.cs
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
using System;
|
||||||
|
using Autofac;
|
||||||
|
using Moq;
|
||||||
|
using NUnit.Framework;
|
||||||
|
using Orchard.Tasks.Locking.Services;
|
||||||
|
|
||||||
|
namespace Orchard.Tests.Tasks {
|
||||||
|
[TestFixture]
|
||||||
|
public class LockTests : ContainerTestBase {
|
||||||
|
private const string LockName = "Orchard Test Lock";
|
||||||
|
private const int LockId = 1;
|
||||||
|
private Mock<IDistributedLockService> _distributedLockServiceMock;
|
||||||
|
private Lock _lock;
|
||||||
|
|
||||||
|
protected override void Register(ContainerBuilder builder) {
|
||||||
|
_distributedLockServiceMock = new Mock<IDistributedLockService>();
|
||||||
|
builder.RegisterInstance(_distributedLockServiceMock.Object);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected override void Resolve(ILifetimeScope container) {
|
||||||
|
_lock = new Lock(_distributedLockServiceMock.Object, LockName, LockId);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void DisposeInvokesDistributedLockServiceDisposeLock() {
|
||||||
|
_lock.Dispose();
|
||||||
|
|
||||||
|
_distributedLockServiceMock.Verify(service => service.DisposeLock(_lock), Times.Exactly(1));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void DisposingMultipleTimesInvokesDistributedLockServiceDisposeLockOnce() {
|
||||||
|
_lock.Dispose();
|
||||||
|
_lock.Dispose();
|
||||||
|
_lock.Dispose();
|
||||||
|
|
||||||
|
_distributedLockServiceMock.Verify(service => service.DisposeLock(_lock), Times.Exactly(1));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -29,34 +29,34 @@ namespace Orchard.Data.Migration {
|
|||||||
public ILogger Logger { get; set; }
|
public ILogger Logger { get; set; }
|
||||||
|
|
||||||
public void Activated() {
|
public void Activated() {
|
||||||
IDistributedLock @lock;
|
using(var @lock = _distributedLockService.AcquireLock(GetType().FullName, TimeSpan.FromMinutes(30), TimeSpan.FromMilliseconds(250))) {
|
||||||
if (_distributedLockService.TryAcquireLock(GetType().FullName, TimeSpan.FromMinutes(30), TimeSpan.FromMilliseconds(250), out @lock)) {
|
if (@lock == null)
|
||||||
using (@lock) {
|
return;
|
||||||
// Let's make sure that the basic set of features is enabled. If there are any that are not enabled, then let's enable them first.
|
|
||||||
var theseFeaturesShouldAlwaysBeActive = new[] {
|
|
||||||
"Common", "Containers", "Contents", "Dashboard", "Feeds", "Navigation", "Scheduling", "Settings", "Shapes", "Title"
|
|
||||||
};
|
|
||||||
|
|
||||||
var enabledFeatures = _featureManager.GetEnabledFeatures().Select(f => f.Id).ToList();
|
// Let's make sure that the basic set of features is enabled. If there are any that are not enabled, then let's enable them first.
|
||||||
var featuresToEnable = theseFeaturesShouldAlwaysBeActive.Where(shouldBeActive => !enabledFeatures.Contains(shouldBeActive)).ToList();
|
var theseFeaturesShouldAlwaysBeActive = new[] {
|
||||||
if (featuresToEnable.Any()) {
|
"Common", "Containers", "Contents", "Dashboard", "Feeds", "Navigation", "Scheduling", "Settings", "Shapes", "Title"
|
||||||
_featureManager.EnableFeatures(featuresToEnable, true);
|
};
|
||||||
|
|
||||||
|
var enabledFeatures = _featureManager.GetEnabledFeatures().Select(f => f.Id).ToList();
|
||||||
|
var featuresToEnable = theseFeaturesShouldAlwaysBeActive.Where(shouldBeActive => !enabledFeatures.Contains(shouldBeActive)).ToList();
|
||||||
|
if (featuresToEnable.Any()) {
|
||||||
|
_featureManager.EnableFeatures(featuresToEnable, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var feature in _dataMigrationManager.GetFeaturesThatNeedUpdate()) {
|
||||||
|
try {
|
||||||
|
_dataMigrationManager.Update(feature);
|
||||||
}
|
}
|
||||||
|
catch (Exception e) {
|
||||||
foreach (var feature in _dataMigrationManager.GetFeaturesThatNeedUpdate()) {
|
Logger.Error("Could not run migrations automatically on " + feature, e);
|
||||||
try {
|
|
||||||
_dataMigrationManager.Update(feature);
|
|
||||||
}
|
|
||||||
catch (Exception e) {
|
|
||||||
Logger.Error("Could not run migrations automatically on " + feature, e);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public void Terminating() {
|
public void Terminating() {
|
||||||
|
// No-op.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -398,11 +398,11 @@
|
|||||||
<Compile Include="Settings\CurrentSiteWorkContext.cs" />
|
<Compile Include="Settings\CurrentSiteWorkContext.cs" />
|
||||||
<Compile Include="Settings\ResourceDebugMode.cs" />
|
<Compile Include="Settings\ResourceDebugMode.cs" />
|
||||||
<Compile Include="Tasks\Locking\Migrations\FrameworkMigrations.cs" />
|
<Compile Include="Tasks\Locking\Migrations\FrameworkMigrations.cs" />
|
||||||
<Compile Include="Tasks\Locking\Providers\DatabaseLock.cs" />
|
<Compile Include="Tasks\Locking\Services\Lock.cs" />
|
||||||
<Compile Include="Tasks\Locking\Services\IDistributedLockService.cs" />
|
<Compile Include="Tasks\Locking\Services\IDistributedLockService.cs" />
|
||||||
<Compile Include="Tasks\Locking\Services\IDistributedLock.cs" />
|
<Compile Include="Tasks\Locking\Services\IDistributedLock.cs" />
|
||||||
<Compile Include="Tasks\Locking\Services\DistributedLockService.cs" />
|
<Compile Include="Tasks\Locking\Services\DistributedLockService.cs" />
|
||||||
<Compile Include="Tasks\Locking\Records\DatabaseLockRecord.cs" />
|
<Compile Include="Tasks\Locking\Records\LockRecord.cs" />
|
||||||
<Compile Include="Themes\CurrentThemeWorkContext.cs" />
|
<Compile Include="Themes\CurrentThemeWorkContext.cs" />
|
||||||
<Compile Include="Themes\ThemeManager.cs" />
|
<Compile Include="Themes\ThemeManager.cs" />
|
||||||
<Compile Include="Time\CurrentTimeZoneWorkContext.cs" />
|
<Compile Include="Time\CurrentTimeZoneWorkContext.cs" />
|
||||||
|
|||||||
@@ -5,11 +5,13 @@ namespace Orchard.Tasks.Locking.Migrations {
|
|||||||
public class FrameworkMigrations : DataMigrationImpl {
|
public class FrameworkMigrations : DataMigrationImpl {
|
||||||
|
|
||||||
public int Create() {
|
public int Create() {
|
||||||
SchemaBuilder.CreateTable("DatabaseLockRecord", table => table
|
SchemaBuilder.CreateTable("LockRecord", table => table
|
||||||
.Column<int>("Id", column => column.PrimaryKey().Identity())
|
.Column<int>("Id", column => column.PrimaryKey().Identity())
|
||||||
.Column<string>("Name", column => column.NotNull().WithLength(256))
|
.Column<string>("Name", column => column.NotNull().WithLength(256))
|
||||||
.Column<string>("MachineName", column => column.WithLength(256))
|
.Column<string>("Owner", column => column.WithLength(256))
|
||||||
.Column<DateTime>("AcquiredUtc"));
|
.Column<int>("ReferenceCount")
|
||||||
|
.Column<DateTime>("CreatedUtc")
|
||||||
|
.Column<DateTime>("ValidUntilUtc"));
|
||||||
|
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,125 +0,0 @@
|
|||||||
using System;
|
|
||||||
using System.Data;
|
|
||||||
using System.Linq;
|
|
||||||
using Autofac;
|
|
||||||
using Orchard.Data;
|
|
||||||
using Orchard.Exceptions;
|
|
||||||
using Orchard.Logging;
|
|
||||||
using Orchard.Services;
|
|
||||||
using Orchard.Tasks.Locking.Records;
|
|
||||||
using Orchard.Tasks.Locking.Services;
|
|
||||||
using Orchard.Validation;
|
|
||||||
|
|
||||||
namespace Orchard.Tasks.Locking.Providers {
|
|
||||||
|
|
||||||
/// <summary>
|
|
||||||
/// Provides a database driven implementation of <see cref="IDistributedLock" />
|
|
||||||
/// </summary>
|
|
||||||
public class DatabaseLock : IDistributedLock {
|
|
||||||
private readonly ILifetimeScope _lifetimeScope;
|
|
||||||
private readonly IClock _clock;
|
|
||||||
private string _name;
|
|
||||||
private bool _isAcquired;
|
|
||||||
private int _id;
|
|
||||||
private bool _isDisposed;
|
|
||||||
private ILifetimeScope _scope;
|
|
||||||
|
|
||||||
public DatabaseLock(ILifetimeScope lifetimeScope, IClock clock) {
|
|
||||||
_lifetimeScope = lifetimeScope;
|
|
||||||
_clock = clock;
|
|
||||||
Logger = NullLogger.Instance;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ILogger Logger { get; set; }
|
|
||||||
|
|
||||||
public bool TryAcquire(string name, string machineName, TimeSpan maxLifetime) {
|
|
||||||
if(_isDisposed)
|
|
||||||
throw new ObjectDisposedException("DatabaseLock");
|
|
||||||
|
|
||||||
Argument.ThrowIfNullOrEmpty(name, "name");
|
|
||||||
|
|
||||||
if (name.Length > 256)
|
|
||||||
throw new ArgumentException("The lock's name can't be longer than 256 characters.");
|
|
||||||
|
|
||||||
try {
|
|
||||||
var scope = EnsureLifetimeScope(name);
|
|
||||||
scope.Resolve<ITransactionManager>().RequireNew(IsolationLevel.ReadCommitted);
|
|
||||||
|
|
||||||
// This way we can create a nested transaction scope instead of having the unwanted effect
|
|
||||||
// of manipulating the transaction of the caller.
|
|
||||||
var repository = scope.Resolve<IRepository<DatabaseLockRecord>>();
|
|
||||||
var record = repository.Table.FirstOrDefault(x => x.Name == name);
|
|
||||||
|
|
||||||
if (record != null) {
|
|
||||||
// There is an existing lock, but check if it has expired or if the current machine is requesting the lock.
|
|
||||||
var isExpired = record.AcquiredUtc + maxLifetime < _clock.UtcNow;
|
|
||||||
var isCurrentMachine = record.MachineName == machineName;
|
|
||||||
if (isExpired || isCurrentMachine) {
|
|
||||||
repository.Delete(record);
|
|
||||||
record = null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var canAcquire = record == null;
|
|
||||||
|
|
||||||
if (canAcquire) {
|
|
||||||
record = new DatabaseLockRecord {
|
|
||||||
Name = name,
|
|
||||||
MachineName = machineName,
|
|
||||||
AcquiredUtc = _clock.UtcNow
|
|
||||||
};
|
|
||||||
repository.Create(record);
|
|
||||||
repository.Flush();
|
|
||||||
|
|
||||||
_name = name;
|
|
||||||
_isAcquired = true;
|
|
||||||
_id = record.Id;
|
|
||||||
}
|
|
||||||
|
|
||||||
return canAcquire;
|
|
||||||
}
|
|
||||||
catch (Exception ex) {
|
|
||||||
Logger.Error(ex, "An error occurred while trying to acquire a lock.");
|
|
||||||
DisposeLifetimeScope();
|
|
||||||
throw;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// This will be called at least and at the latest by the IoC container when the request ends.
|
|
||||||
public void Dispose() {
|
|
||||||
if (_scope == null)
|
|
||||||
return;
|
|
||||||
|
|
||||||
if (!_isDisposed) {
|
|
||||||
_isDisposed = true;
|
|
||||||
|
|
||||||
if (_isAcquired) {
|
|
||||||
try {
|
|
||||||
var repository = _scope.Resolve<IRepository<DatabaseLockRecord>>();
|
|
||||||
var record = repository.Get(_id);
|
|
||||||
|
|
||||||
if (record != null) {
|
|
||||||
repository.Delete(record);
|
|
||||||
repository.Flush();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
catch (Exception ex) {
|
|
||||||
if (ex.IsFatal()) throw;
|
|
||||||
Logger.Error(ex, "An non-fatal error occurred while trying to dispose the database lock.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
_scope.Dispose();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private ILifetimeScope EnsureLifetimeScope(string name) {
|
|
||||||
return _scope ?? (_scope = _lifetimeScope.BeginLifetimeScope("Orchard.Tasks.Locking.Database." + name));
|
|
||||||
}
|
|
||||||
|
|
||||||
private void DisposeLifetimeScope() {
|
|
||||||
if (_scope != null)
|
|
||||||
_scope.Dispose();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
using System;
|
|
||||||
|
|
||||||
namespace Orchard.Tasks.Locking.Records {
|
|
||||||
public class DatabaseLockRecord {
|
|
||||||
public virtual int Id { get; set; }
|
|
||||||
public virtual string Name { get; set; }
|
|
||||||
public virtual string MachineName { get; set; }
|
|
||||||
public virtual DateTime? AcquiredUtc { get; set; }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
12
src/Orchard/Tasks/Locking/Records/LockRecord.cs
Normal file
12
src/Orchard/Tasks/Locking/Records/LockRecord.cs
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
using System;
|
||||||
|
|
||||||
|
namespace Orchard.Tasks.Locking.Records {
|
||||||
|
public class LockRecord {
|
||||||
|
public virtual int Id { get; set; }
|
||||||
|
public virtual string Name { get; set; }
|
||||||
|
public virtual string Owner { get; set; }
|
||||||
|
public virtual int ReferenceCount { get; set; }
|
||||||
|
public virtual DateTime CreatedUtc { get; set; }
|
||||||
|
public virtual DateTime ValidUntilUtc { get; set; }
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,59 +1,153 @@
|
|||||||
using System;
|
using System;
|
||||||
|
using System.Data;
|
||||||
|
using System.Linq;
|
||||||
using System.Threading;
|
using System.Threading;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
|
using Autofac;
|
||||||
|
using Orchard.Data;
|
||||||
using Orchard.Environment;
|
using Orchard.Environment;
|
||||||
|
using Orchard.Exceptions;
|
||||||
using Orchard.Logging;
|
using Orchard.Logging;
|
||||||
|
using Orchard.Services;
|
||||||
|
using Orchard.Tasks.Locking.Records;
|
||||||
|
|
||||||
namespace Orchard.Tasks.Locking.Services {
|
namespace Orchard.Tasks.Locking.Services {
|
||||||
public class DistributedLockService : IDistributedLockService {
|
|
||||||
private readonly IWorkContextAccessor _wca;
|
|
||||||
private readonly IMachineNameProvider _machineNameProvider;
|
|
||||||
|
|
||||||
public DistributedLockService(IWorkContextAccessor wca, IMachineNameProvider machineNameProvider) {
|
public class DistributedLockService : IDistributedLockService {
|
||||||
_wca = wca;
|
private readonly IMachineNameProvider _machineNameProvider;
|
||||||
|
private readonly ILifetimeScope _lifetimeScope;
|
||||||
|
private readonly IClock _clock;
|
||||||
|
private readonly object _semaphore = new object();
|
||||||
|
|
||||||
|
public DistributedLockService(IMachineNameProvider machineNameProvider, ILifetimeScope lifetimeScope, IClock clock) {
|
||||||
_machineNameProvider = machineNameProvider;
|
_machineNameProvider = machineNameProvider;
|
||||||
|
_lifetimeScope = lifetimeScope;
|
||||||
|
_clock = clock;
|
||||||
Logger = NullLogger.Instance;
|
Logger = NullLogger.Instance;
|
||||||
}
|
}
|
||||||
|
|
||||||
public ILogger Logger { get; set; }
|
public ILogger Logger { get; set; }
|
||||||
|
|
||||||
public bool TryAcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout, out IDistributedLock @lock) {
|
public bool TryAcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout, out IDistributedLock @lock) {
|
||||||
var machineName = _machineNameProvider.GetMachineName();
|
lock (_semaphore) {
|
||||||
@lock = Resolve<IDistributedLock>();
|
@lock = default(IDistributedLock);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
var waitedTime = TimeSpan.Zero;
|
var waitedTime = TimeSpan.Zero;
|
||||||
var waitTime = TimeSpan.FromMilliseconds(timeout.TotalMilliseconds / 10);
|
var waitTime = TimeSpan.FromMilliseconds(timeout.TotalMilliseconds / 10);
|
||||||
bool acquired;
|
bool acquired;
|
||||||
|
|
||||||
while (!(acquired = @lock.TryAcquire(name, machineName, maxLifetime)) && waitedTime < timeout) {
|
while (!(acquired = TryAcquireLockRecord(name, maxLifetime, out @lock)) && waitedTime < timeout) {
|
||||||
Task.Delay(timeout).ContinueWith(t => {
|
Task.Delay(timeout).ContinueWith(t => {
|
||||||
waitedTime += waitTime;
|
waitedTime += waitTime;
|
||||||
}).Wait();
|
}).Wait();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (acquired) {
|
||||||
|
Logger.Debug("Successfully acquired a lock named {0}.", name);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception ex) {
|
||||||
|
Logger.Error(ex, "Error while trying to acquire a lock named {0}.", name);
|
||||||
|
throw;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (acquired) {
|
Logger.Debug("Could not acquire a lock named {0}.", name);
|
||||||
Logger.Debug("Successfully acquired a lock named {0} on machine {1}.", name, machineName);
|
return false;
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
catch (Exception ex) {
|
|
||||||
Logger.Error(ex, "Error while trying to acquire a lock named {0} on machine {1}.", name, machineName);
|
|
||||||
throw;
|
|
||||||
}
|
|
||||||
|
|
||||||
Logger.Debug("Could not acquire a lock named {0} on machine {1}.", name, machineName);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
private T Resolve<T>() {
|
|
||||||
var workContext = _wca.GetContext() ?? _wca.CreateWorkContextScope().WorkContext; // In case this is invoked at the end of the request.
|
|
||||||
return workContext.Resolve<T>();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public IDistributedLock AcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout) {
|
public IDistributedLock AcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout) {
|
||||||
IDistributedLock lockResult;
|
IDistributedLock lockResult;
|
||||||
return TryAcquireLock(name, maxLifetime, timeout, out lockResult) ? lockResult : null;
|
return TryAcquireLock(name, maxLifetime, timeout, out lockResult) ? lockResult : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void DisposeLock(IDistributedLock @lock) {
|
||||||
|
var childLifetimeScope = CreateChildLifetimeScope(@lock.Name);
|
||||||
|
|
||||||
|
try {
|
||||||
|
var repository = childLifetimeScope.Resolve<IRepository<LockRecord>>();
|
||||||
|
var transactionManager = childLifetimeScope.Resolve<ITransactionManager>();
|
||||||
|
transactionManager.RequireNew(IsolationLevel.ReadCommitted);
|
||||||
|
var record = repository.Get(@lock.Id);
|
||||||
|
|
||||||
|
if (record != null) {
|
||||||
|
if (record.ReferenceCount > 0)
|
||||||
|
record.ReferenceCount--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (Exception ex) {
|
||||||
|
if (ex.IsFatal()) throw;
|
||||||
|
Logger.Error(ex, "An non-fatal error occurred while trying to dispose a distributed lock with name {0} and ID {1}.", @lock.Name, @lock.Id);
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
childLifetimeScope.Dispose();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected virtual bool TryAcquireLockRecord(string name, TimeSpan maxLifetime, out IDistributedLock @lock) {
|
||||||
|
@lock = null;
|
||||||
|
var childLifetimeScope = CreateChildLifetimeScope(name);
|
||||||
|
|
||||||
|
try {
|
||||||
|
var transactionManager = childLifetimeScope.Resolve<ITransactionManager>();
|
||||||
|
transactionManager.RequireNew(IsolationLevel.ReadCommitted);
|
||||||
|
|
||||||
|
// This way we can create a nested transaction scope instead of having the unwanted effect
|
||||||
|
// of manipulating the transaction of the caller.
|
||||||
|
var repository = childLifetimeScope.Resolve<IRepository<LockRecord>>();
|
||||||
|
|
||||||
|
// Find an existing, active lock, if any.
|
||||||
|
var record = repository.Table.FirstOrDefault(x => x.Name == name && (x.ValidUntilUtc >= _clock.UtcNow || x.ReferenceCount > 0));
|
||||||
|
|
||||||
|
// The current owner name (based on machine name and current thread ID).
|
||||||
|
var currentOwnerName = GetOwnerName();
|
||||||
|
var canAcquireLock = false;
|
||||||
|
|
||||||
|
// Check if there's already an active lock.
|
||||||
|
if (record != null) {
|
||||||
|
// Check if the owner of the lock is the one trying to acquire the lock.
|
||||||
|
if (record.Owner == currentOwnerName) {
|
||||||
|
record.ReferenceCount++;
|
||||||
|
canAcquireLock = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// No one has an active lock yet, so good to go.
|
||||||
|
record = new LockRecord {
|
||||||
|
Name = name,
|
||||||
|
Owner = currentOwnerName,
|
||||||
|
ReferenceCount = 1,
|
||||||
|
CreatedUtc = _clock.UtcNow,
|
||||||
|
ValidUntilUtc = _clock.UtcNow + maxLifetime
|
||||||
|
};
|
||||||
|
repository.Create(record);
|
||||||
|
repository.Flush();
|
||||||
|
canAcquireLock = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!canAcquireLock)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
@lock = new Lock(this, name, record.Id);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
catch (Exception ex) {
|
||||||
|
Logger.Error(ex, "An error occurred while trying to acquire a lock.");
|
||||||
|
throw;
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
childLifetimeScope.Dispose();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private string GetOwnerName() {
|
||||||
|
return String.Format("{0}_{1}", _machineNameProvider.GetMachineName(), Thread.CurrentThread.ManagedThreadId);
|
||||||
|
}
|
||||||
|
|
||||||
|
private ILifetimeScope CreateChildLifetimeScope(string name) {
|
||||||
|
return _lifetimeScope.BeginLifetimeScope("Orchard.Tasks.Locking." + name);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -2,16 +2,10 @@
|
|||||||
|
|
||||||
namespace Orchard.Tasks.Locking.Services {
|
namespace Orchard.Tasks.Locking.Services {
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Provides a lock on a provided name.
|
/// Represents a distributed lock.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
public interface IDistributedLock : ITransientDependency, IDisposable {
|
public interface IDistributedLock : IDisposable {
|
||||||
/// <summary>
|
int Id { get; }
|
||||||
/// Tries to acquire a lock on the specified name.
|
string Name { get; }
|
||||||
/// </summary>
|
|
||||||
/// <param name="name">The name to use for the lock.</param>
|
|
||||||
/// <param name="machineName">The machine name trying to acquire a lock.</param>
|
|
||||||
/// <param name="maxLifetime">The maximum amount of time the lock is allowed. This is a safety net in case the caller fails to release the lock.</param>
|
|
||||||
/// <returns>Returns true if a lock was acquired, false otherwise.</returns>
|
|
||||||
bool TryAcquire(string name, string machineName, TimeSpan maxLifetime);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -23,5 +23,10 @@ namespace Orchard.Tasks.Locking.Services {
|
|||||||
/// <param name="timeout">The amount of time to wait for the lock to be acquired before timing out.</param>
|
/// <param name="timeout">The amount of time to wait for the lock to be acquired before timing out.</param>
|
||||||
/// <returns>Returns a lock if one was successfully acquired, null otherwise.</returns>
|
/// <returns>Returns a lock if one was successfully acquired, null otherwise.</returns>
|
||||||
IDistributedLock AcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout);
|
IDistributedLock AcquireLock(string name, TimeSpan maxLifetime, TimeSpan timeout);
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Disposes the specified lock.
|
||||||
|
/// </summary>
|
||||||
|
void DisposeLock(IDistributedLock @lock);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
31
src/Orchard/Tasks/Locking/Services/Lock.cs
Normal file
31
src/Orchard/Tasks/Locking/Services/Lock.cs
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
using Orchard.Logging;
|
||||||
|
|
||||||
|
namespace Orchard.Tasks.Locking.Services {
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// Provides a database driven implementation of <see cref="IDistributedLock" />
|
||||||
|
/// </summary>
|
||||||
|
public class Lock : IDistributedLock {
|
||||||
|
private readonly IDistributedLockService _distributedLockService;
|
||||||
|
public string Name { get; set; }
|
||||||
|
private bool _isDisposed;
|
||||||
|
|
||||||
|
public Lock(IDistributedLockService distributedLockService, string name, int id) {
|
||||||
|
_distributedLockService = distributedLockService;
|
||||||
|
Name = name;
|
||||||
|
Id = id;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ILogger Logger { get; set; }
|
||||||
|
public int Id { get; set; }
|
||||||
|
|
||||||
|
// This will be called at least and at the latest by the IoC container when the request ends.
|
||||||
|
public void Dispose() {
|
||||||
|
if (!_isDisposed) {
|
||||||
|
_isDisposed = true;
|
||||||
|
|
||||||
|
_distributedLockService.DisposeLock(this);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user