Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 31 additions & 1 deletion src/DependencyManagement/DependencySnapshotPurger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ internal class DependencySnapshotPurger : IDependencySnapshotPurger, IDisposable
private readonly TimeSpan _oldHeartbeatAgeMargin;
private readonly int _minNumberOfSnapshotsToKeep;

private string _currentlyUsedSnapshotPath;
private Timer _heartbeat;

public DependencySnapshotPurger(
Expand All @@ -42,6 +43,8 @@ public DependencySnapshotPurger(
/// </summary>
public void SetCurrentlyUsedSnapshot(string path, ILogger logger)
{
_currentlyUsedSnapshotPath = path;

Heartbeat(path, logger);

_heartbeat = new Timer(
Expand All @@ -65,6 +68,7 @@ public void Purge(ILogger logger)
var threshold = DateTime.UtcNow - _heartbeatPeriod - _oldHeartbeatAgeMargin;

var pathSortedByAccessTime = allSnapshotPaths
.Where(path => string.CompareOrdinal(path, _currentlyUsedSnapshotPath) != 0)
.Select(path => Tuple.Create(path, GetSnapshotAccessTimeUtc(path, logger)))
.OrderBy(entry => entry.Item2)
.ToArray();
Expand Down Expand Up @@ -108,7 +112,22 @@ internal void Heartbeat(string path, ILogger logger)

if (_storage.SnapshotExists(path))
{
_storage.SetSnapshotAccessTimeToUtcNow(path);
try
{
_storage.SetSnapshotAccessTimeToUtcNow(path);
}
// The files in the snapshot may be read-only in some scenarios, so updating
// the timestamp may fail. However, the snapshot can still be used, and
// we should not prevent function executions because of that.
// So, just log and move on.
catch (IOException e)
{
LogHeartbeatUpdateFailure(logger, path, e);
}
catch (UnauthorizedAccessException e)
{
LogHeartbeatUpdateFailure(logger, path, e);
}
}
}

Expand Down Expand Up @@ -140,5 +159,16 @@ private static int GetMinNumberOfSnapshotsToKeep()
{
return PowerShellWorkerConfiguration.GetInt("MDMinNumberOfSnapshotsToKeep") ?? 1;
}

private static void LogHeartbeatUpdateFailure(ILogger logger, string path, Exception exception)
{
var message = string.Format(
PowerShellWorkerStrings.FailedToUpdateManagedDependencySnapshotHeartbeat,
path,
exception.GetType().FullName,
exception.Message);

logger.Log(isUserOnlyLog: false, LogLevel.Warning, message);
}
}
}
3 changes: 3 additions & 0 deletions src/resources/PowerShellWorkerStrings.resx
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,9 @@
<data name="UpdatingManagedDependencySnapshotHeartbeat" xml:space="preserve">
<value>Updating dependencies folder heartbeat for '{0}''.</value>
</data>
<data name="FailedToUpdateManagedDependencySnapshotHeartbeat" xml:space="preserve">
<value>Failed to update dependencies folder heartbeat for '{0}'. Exception {1}: '{2}'.</value>
</data>
<data name="FailedToInstallDependenciesSnapshot" xml:space="preserve">
<value>Failed to install dependencies into '{0}' (installation mode: {1}), removing the folder.</value>
</data>
Expand Down
48 changes: 48 additions & 0 deletions test/Unit/DependencyManagement/DependencySnapshotPurgerTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,28 @@ public void DoesNotRemoveRecentlyUsedSnapshot()
_mockStorage.Verify(_ => _.RemoveSnapshot(It.IsAny<string>()), Times.Never);
}

[Fact]
public void DoesNotRemoveCurrentlyUsedSnapshotEvenIfNotAccessedForLongTime()
{
_mockStorage.Setup(_ => _.GetInstalledAndInstallingSnapshots()).Returns(new[] { "snapshot" });
_mockStorage.Setup(_ => _.SnapshotExists("snapshot")).Returns(true);
_mockStorage.Setup(_ => _.GetSnapshotAccessTimeUtc("snapshot")).Returns(DateTime.UtcNow - TimeSpan.FromMinutes(300));
_mockStorage.Setup(_ => _.SetSnapshotAccessTimeToUtcNow("snapshot"));

using (var purger = new DependencySnapshotPurger(
_mockStorage.Object,
heartbeatPeriod: TimeSpan.FromMinutes(10),
oldHeartbeatAgeMargin: TimeSpan.FromMinutes(5),
minNumberOfSnapshotsToKeep: 0))
{
purger.SetCurrentlyUsedSnapshot("snapshot", _mockLogger.Object);

purger.Purge(_mockLogger.Object);
}

_mockStorage.Verify(_ => _.RemoveSnapshot(It.IsAny<string>()), Times.Never);
}

[Fact]
public void RemovesMultipleSnapshotNotUsedForLongTime()
{
Expand Down Expand Up @@ -258,6 +280,32 @@ public void Heartbeat_DoesNotUpdateCurrentSnapshotAccessTime_WhenSnapshotDoesNot
_mockStorage.Verify(_ => _.SetSnapshotAccessTimeToUtcNow(It.IsAny<string>()), Times.Never);
}

[Theory]
[MemberData(nameof(GetNonFatalFileSystemExceptions))]
public void Heartbeat_Tolerates_FileAccessFailures(Exception exception)
{
const string snapshotPath = "FakeSnapshotPath";
_mockStorage.Setup(_ => _.SnapshotExists(snapshotPath)).Returns(true);
_mockStorage.Setup(_ => _.SetSnapshotAccessTimeToUtcNow(snapshotPath))
.Throws(exception);

using (var purger = new DependencySnapshotPurger(_mockStorage.Object))
{
purger.Heartbeat(snapshotPath, _mockLogger.Object);
}

_mockLogger.Verify(
_ => _.Log(
false,
LogLevel.Warning,
It.Is<string>(
message => message.Contains(exception.GetType().FullName)
&& message.Contains(exception.Message)
&& message.Contains(snapshotPath)),
null),
Times.AtLeastOnce);
}

[Fact]
public void SetCurrentlyUsedSnapshot_UpdatesCurrentSnapshotAccessTimeImmediately()
{
Expand Down