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

Fix issue with SqlMainDomLock that cannot use implicit lock timeouts … #9973

Merged
merged 2 commits into from
Mar 12, 2021
Merged

Fix issue with SqlMainDomLock that cannot use implicit lock timeouts … #9973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5adae8b
Fix issue with SqlMainDomLock that cannot use implicit lock timeouts …
bergmania Mar 12, 2021
677c82f
Inject logger
bergmania Mar 12, 2021
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
40 changes: 24 additions & 16 deletions src/Umbraco.Core/Configuration/GlobalSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,26 +409,34 @@ public int SqlWriteLockTimeOut
{
if (_sqlWriteLockTimeOut != default) return _sqlWriteLockTimeOut;

var timeOut = 5000; // 5 seconds
var appSettingSqlWriteLockTimeOut = ConfigurationManager.AppSettings[Constants.AppSettings.SqlWriteLockTimeOut];
if(int.TryParse(appSettingSqlWriteLockTimeOut, out var configuredTimeOut))
{
// Only apply this setting if it's not excessively high or low
const int minimumTimeOut = 100;
const int maximumTimeOut = 20000;
if (configuredTimeOut >= minimumTimeOut && configuredTimeOut <= maximumTimeOut) // between 0.1 and 20 seconds
{
timeOut = configuredTimeOut;
}
else
{
Current.Logger.Warn<GlobalSettings>($"The `{Constants.AppSettings.SqlWriteLockTimeOut}` setting in web.config is not between the minimum of {minimumTimeOut} ms and maximum of {maximumTimeOut} ms, defaulting back to {timeOut}");
}
}
var timeOut = GetSqlWriteLockTimeoutFromConfigFile(Current.Logger);

_sqlWriteLockTimeOut = timeOut;
return _sqlWriteLockTimeOut;
}
}

internal static int GetSqlWriteLockTimeoutFromConfigFile(ILogger logger)
{
var timeOut = 5000; // 5 seconds
var appSettingSqlWriteLockTimeOut = ConfigurationManager.AppSettings[Constants.AppSettings.SqlWriteLockTimeOut];
if (int.TryParse(appSettingSqlWriteLockTimeOut, out var configuredTimeOut))
{
// Only apply this setting if it's not excessively high or low
const int minimumTimeOut = 100;
const int maximumTimeOut = 20000;
if (configuredTimeOut >= minimumTimeOut && configuredTimeOut <= maximumTimeOut) // between 0.1 and 20 seconds
{
timeOut = configuredTimeOut;
}
else
{
logger.Warn<GlobalSettings>(
$"The `{Constants.AppSettings.SqlWriteLockTimeOut}` setting in web.config is not between the minimum of {minimumTimeOut} ms and maximum of {maximumTimeOut} ms, defaulting back to {timeOut}");
bergmania marked this conversation as resolved.
Show resolved Hide resolved
}
}

return timeOut;
}
}
}
15 changes: 10 additions & 5 deletions src/Umbraco.Core/Runtime/SqlMainDomLock.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
using NPoco;
using System;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;
using System.Diagnostics;
using System.Linq;
using System.Security.Cryptography;
using System.Threading;
using System.Threading.Tasks;
using Umbraco.Core.Configuration;
using Umbraco.Core.Logging;
using Umbraco.Core.Persistence;
using Umbraco.Core.Persistence.Dtos;
Expand All @@ -18,6 +20,7 @@ namespace Umbraco.Core.Runtime
{
internal class SqlMainDomLock : IMainDomLock
{
private readonly TimeSpan _lockTimeout;
private string _lockId;
private const string MainDomKeyPrefix = "Umbraco.Core.Runtime.SqlMainDom";
private const string UpdatedSuffix = "_updated";
Expand All @@ -40,6 +43,8 @@ public SqlMainDomLock(ILogger logger)
Constants.System.UmbracoConnectionName,
_logger,
new Lazy<IMapperCollection>(() => new MapperCollection(Enumerable.Empty<BaseMapper>())));

_lockTimeout = TimeSpan.FromMilliseconds(GlobalSettings.GetSqlWriteLockTimeoutFromConfigFile(logger));
}

public async Task<bool> AcquireLockAsync(int millisecondsTimeout)
Expand Down Expand Up @@ -198,7 +203,7 @@ private void ListeningLoop()

db.BeginTransaction(IsolationLevel.ReadCommitted);
// get a read lock
_sqlServerSyntax.ReadLock(db, Constants.Locks.MainDom);
_sqlServerSyntax.ReadLock(db, _lockTimeout, Constants.Locks.MainDom);

if (!IsMainDomValue(_lockId, db))
{
Expand Down Expand Up @@ -284,7 +289,7 @@ private Task<bool> WaitForExistingAsync(string tempId, int millisecondsTimeout)
{
transaction = db.GetTransaction(IsolationLevel.ReadCommitted);
// get a read lock
_sqlServerSyntax.ReadLock(db, Constants.Locks.MainDom);
_sqlServerSyntax.ReadLock(db, _lockTimeout, Constants.Locks.MainDom);

// the row
var mainDomRows = db.Fetch<KeyValueDto>("SELECT * FROM umbracoKeyValue WHERE [key] = @key", new { key = MainDomKey });
Expand All @@ -296,7 +301,7 @@ private Task<bool> WaitForExistingAsync(string tempId, int millisecondsTimeout)
// which indicates that we
// can acquire it and it has shutdown.

_sqlServerSyntax.WriteLock(db, Constants.Locks.MainDom);
_sqlServerSyntax.WriteLock(db, _lockTimeout, Constants.Locks.MainDom);

// so now we update the row with our appdomain id
InsertLockRecord(_lockId, db);
Expand Down Expand Up @@ -355,7 +360,7 @@ private bool AcquireWhenMaxWaitTimeElapsed(IUmbracoDatabase db)
{
transaction = db.GetTransaction(IsolationLevel.ReadCommitted);

_sqlServerSyntax.WriteLock(db, Constants.Locks.MainDom);
_sqlServerSyntax.WriteLock(db, _lockTimeout, Constants.Locks.MainDom);

// so now we update the row with our appdomain id
InsertLockRecord(_lockId, db);
Expand Down Expand Up @@ -438,7 +443,7 @@ protected virtual void Dispose(bool disposing)
db.BeginTransaction(IsolationLevel.ReadCommitted);

// get a write lock
_sqlServerSyntax.WriteLock(db, Constants.Locks.MainDom);
_sqlServerSyntax.WriteLock(db, _lockTimeout, Constants.Locks.MainDom);

// When we are disposed, it means we have released the MainDom lock
// and called all MainDom release callbacks, in this case
Expand Down