Backplane auto-recovery is now Auto-Recovery

src/ZiggyCreatures.FusionCache.Serialization.CysharpMemoryPack/Internals/SerializableFusionCacheDistributedEntry.cs

@@ -17,10 +17,10 @@ internal partial class SerializableFusionCacheDistributedEntry<TValue>
 		public FusionCacheEntryMetadata? Metadata => Entry?.Metadata;
 
 		[MemoryPackInclude]
-		public long? Timestamp => Entry?.Timestamp;
+		public long Timestamp => Entry?.Timestamp ?? 0;
 
 		[MemoryPackConstructor]
-		SerializableFusionCacheDistributedEntry(TValue value, FusionCacheEntryMetadata? metadata, long? timestamp)
+		SerializableFusionCacheDistributedEntry(TValue value, FusionCacheEntryMetadata? metadata, long timestamp)
 		{
 			this.Entry = new FusionCacheDistributedEntry<TValue>(value, metadata, timestamp);
 		}

src/ZiggyCreatures.FusionCache/FusionCacheOptions.cs

@@ -37,11 +37,11 @@ public FusionCacheOptions()
 
 		_defaultEntryOptions = new FusionCacheEntryOptions();
 
-		// BACKPLANE AUTO-RECOVERY
-		EnableBackplaneAutoRecovery = true;
-		BackplaneAutoRecoveryMaxItems = null;
-		BackplaneAutoRecoveryMaxRetryCount = null;
-		BackplaneAutoRecoveryDelay = TimeSpan.FromMilliseconds(2_000);
+		// AUTO-RECOVERY
+		EnableAutoRecovery = true;
+		AutoRecoveryMaxItems = null;
+		AutoRecoveryMaxRetryCount = null;
+		AutoRecoveryDelay = TimeSpan.FromMilliseconds(2_000);
 
 		// LOG LEVELS
 		IncoherentOptionsNormalizationLogLevel = LogLevel.Warning;
@@ -149,56 +149,117 @@ public FusionCacheEntryOptions DefaultEntryOptions
 	/// </summary>
 	public string? BackplaneChannelPrefix { get; set; }
 
+	/// <summary>
+	/// DEPRECATED: please use EnableAutoRecovery.
+	/// <br/><br/>
+	/// Enable auto-recovery for the backplane notifications to better handle transient errors without generating synchronization issues: notifications that failed to be sent out will be retried later on, when the backplane becomes responsive again.
+	/// <br/><br/>
+	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
+	/// </summary>
+	[Obsolete("Backplane auto-recovery is now simply auto-recovery: please use the EnableAutoRecovery property.")]
+	public bool EnableBackplaneAutoRecovery
+	{
+		get { return EnableAutoRecovery; }
+		set { EnableAutoRecovery = value; }
+	}
+
 	/// <summary>
 	/// Enable auto-recovery for the backplane notifications to better handle transient errors without generating synchronization issues: notifications that failed to be sent out will be retried later on, when the backplane becomes responsive again.
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	public bool EnableBackplaneAutoRecovery { get; set; }
+	public bool EnableAutoRecovery { get; set; }
+
+	/// <summary>
+	/// DEPRECATED: please use AutoRecoveryMaxItems.
+	/// <br/><br/>
+	/// The maximum number of items in the auto-recovery queue: this can help reducing memory consumption. If set to <see langword="null"/> there will be no limit.
+	/// <br/><br/>
+	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
+	/// </summary>
+	[Obsolete("Backplane auto-recovery is now simply auto-recovery: please use the AutoRecoveryMaxItems property.")]
+	public int? BackplaneAutoRecoveryMaxItems
+	{
+		get { return AutoRecoveryMaxItems; }
+		set { AutoRecoveryMaxItems = value; }
+	}
+
+	// TODO: CHANGE THE DOCS LINKS TO THE NEW ONE SPECIFIC FOR AUTO-RECOVERY
 
 	/// <summary>
 	/// The maximum number of items in the auto-recovery queue: this can help reducing memory consumption. If set to <see langword="null"/> there will be no limit.
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	public int? BackplaneAutoRecoveryMaxItems { get; set; }
+	public int? AutoRecoveryMaxItems { get; set; }
 
 	/// <summary>
-	/// The maximum number of retries for a backplane auto-recovery item: after this amount the item is discarded, to avoid keeping it retrying forever. If set to <see langword="null"/> there will be no limit.
+	/// DEPRECATED: please use AutoRecoveryMaxRetryCount.
+	/// <br/><br/>
+	/// The maximum number of retries for a auto-recovery item: after this amount the item is discarded, to avoid keeping it retrying forever. If set to <see langword="null"/> there will be no limit.
+	/// <br/><br/>
+	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
+	/// </summary>
+	[Obsolete("Backplane auto-recovery is now simply auto-recovery: please use the AutoRecoveryMaxRetryCount property.")]
+	public int? BackplaneAutoRecoveryMaxRetryCount
+	{
+		get { return AutoRecoveryMaxRetryCount; }
+		set { AutoRecoveryMaxRetryCount = value; }
+	}
+
+	/// <summary>
+	/// The maximum number of retries for a auto-recovery item: after this amount the item is discarded, to avoid keeping it retrying forever. If set to <see langword="null"/> there will be no limit.
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	public int? BackplaneAutoRecoveryMaxRetryCount { get; set; }
+	public int? AutoRecoveryMaxRetryCount { get; set; }
 
 	/// <summary>
+	/// DEPRECATED: please use AutoRecoveryDelay.
+	/// <br/><br/>
 	/// The amount of time to wait, after a backplane reconnection, before trying to process the auto-recovery queue: this may be useful to allow all the other nodes to be ready.
 	/// <br/>
 	/// Use <see cref="TimeSpan.Zero"/> to avoid any delay (risky).
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	[Obsolete("Please use BackplaneAutoRecoveryDelay instead.")]
+	[Obsolete("Please use AutoRecoveryDelay instead.")]
 	public TimeSpan BackplaneAutoRecoveryReconnectDelay
 	{
-		get { return BackplaneAutoRecoveryDelay; }
-		set { BackplaneAutoRecoveryDelay = value; }
+		get { return AutoRecoveryDelay; }
+		set { AutoRecoveryDelay = value; }
+	}
+
+	/// <summary>
+	/// DEPRECATED: please use AutoRecoveryDelay.
+	/// <br/><br/>
+	/// The amount of time to wait before actually processing the auto-recovery queue, to better handle backpressure.
+	/// <br/>
+	/// Use <see cref="TimeSpan.Zero"/> to avoid any delay (risky).
+	/// <br/><br/>
+	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
+	/// </summary>
+	[Obsolete("Backplane auto-recovery is now simply auto-recovery: please use the AutoRecoveryDelay property.")]
+	public TimeSpan BackplaneAutoRecoveryDelay
+	{
+		get; set;
 	}
 
 	/// <summary>
-	/// The amount of time to wait before actually processing the backplane auto-recovery queue, to better handle backpressure.
+	/// The amount of time to wait before actually processing the auto-recovery queue, to better handle backpressure.
 	/// <br/>
 	/// Use <see cref="TimeSpan.Zero"/> to avoid any delay (risky).
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	public TimeSpan BackplaneAutoRecoveryDelay { get; set; }
+	public TimeSpan AutoRecoveryDelay { get; set; }
 
 	/// <summary>
 	/// Enable expiring a cache entry, only on the distributed cache (if any), when anauto-recovery message is being published on the backplane, to ensure that the value in the distributed cache will not be stale.
 	/// <br/><br/>
 	/// <strong>DOCS:</strong> <see href="https://github.com/ZiggyCreatures/FusionCache/blob/main/docs/Backplane.md"/>
 	/// </summary>
-	[Obsolete("This is not needed anymore, everything is automatically handled now.")]
+	[Obsolete("This is not needed anymore, everything is handled automatically now.")]
 	public bool EnableDistributedExpireOnBackplaneAutoRecovery { get; set; }
 
 	/// <summary>

src/ZiggyCreatures.FusionCache/FusionCache_Async.cs

@@ -633,6 +633,7 @@ private async ValueTask ExecuteDistributedActionAsync(string operationId, string
 		var mustAwaitCompletion = MustAwaitDistributedOperations(options);
 		var isBackground = !mustAwaitCompletion;
 
+		// TODO: MAYBE USE A SLIMMER UTIL
 		await FusionCacheExecutionUtils.RunAsyncActionAdvancedAsync(
 			async ct =>
 			{

src/ZiggyCreatures.FusionCache/Internals/Backplane/BackplaneAccessor.cs

@@ -150,8 +150,8 @@ public void Subscribe()
 
 			ProcessError(operationId, "", exc, $"subscribing to a backplane of type {_backplane.GetType().FullName}");
 
-			if (_logger?.IsEnabled(_options.BackplaneErrorsLogLevel) ?? false)
-				_logger.Log(_options.BackplaneErrorsLogLevel, exc, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): an error occurred while subscribing to a backplane of type {BackplaneType}", _cache.CacheName, _cache.InstanceId, operationId, "", _backplane.GetType().FullName);
+			//if (_logger?.IsEnabled(_options.BackplaneErrorsLogLevel) ?? false)
+			//	_logger.Log(_options.BackplaneErrorsLogLevel, exc, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): an error occurred while subscribing to a backplane of type {BackplaneType}", _cache.CacheName, _cache.InstanceId, operationId, "", _backplane.GetType().FullName);
 		}
 	}
 
@@ -167,8 +167,8 @@ public void Unsubscribe()
 
 			ProcessError(operationId, "", exc, $"unsubscribing from a backplane of type {_backplane.GetType().FullName}");
 
-			if (_logger?.IsEnabled(_options.BackplaneErrorsLogLevel) ?? false)
-				_logger.Log(_options.BackplaneErrorsLogLevel, exc, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): an error occurred while unsubscribing from a backplane of type {BackplaneType}", _cache.CacheName, _cache.InstanceId, operationId, "", _backplane.GetType().FullName);
+			//if (_logger?.IsEnabled(_options.BackplaneErrorsLogLevel) ?? false)
+			//	_logger.Log(_options.BackplaneErrorsLogLevel, exc, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): an error occurred while unsubscribing from a backplane of type {BackplaneType}", _cache.CacheName, _cache.InstanceId, operationId, "", _backplane.GetType().FullName);
 		}
 	}
 
@@ -179,7 +179,7 @@ private void HandleConnect(BackplaneConnectionInfo info)
 		if (_logger?.IsEnabled(LogLevel.Information) ?? false)
 			_logger.Log(LogLevel.Information, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId}): backplane " + (info.IsReconnection ? "re-connected" : "connected"), _cache.CacheName, _cache.InstanceId, operationId);
 
-		if (info.IsReconnection && _options.EnableBackplaneAutoRecovery)
+		if (info.IsReconnection && _options.EnableAutoRecovery)
 		{
 			_cache.TryUpdateAutoRecoveryBarrier(operationId);
 		}
@@ -208,6 +208,9 @@ private async ValueTask HandleIncomingMessageAsync(BackplaneMessage message)
 			_events.OnCircuitBreakerChange(operationId, null, true);
 		}
 
+		// EVENT
+		_events.OnMessageReceived(operationId, message);
+
 		// IGNORE NULL
 		if (message is null)
 		{
@@ -233,7 +236,7 @@ private async ValueTask HandleIncomingMessageAsync(BackplaneMessage message)
 		}
 
 		// AUTO-RECOVERY
-		if (_options.EnableBackplaneAutoRecovery)
+		if (_options.EnableAutoRecovery)
 		{
 			if (_cache.CheckIncomingMessageForAutoRecoveryConflicts(operationId, message) == false)
 			{
@@ -244,9 +247,6 @@ private async ValueTask HandleIncomingMessageAsync(BackplaneMessage message)
 			}
 		}
 
-		// EVENT
-		_events.OnMessageReceived(operationId, message);
-
 		// PROCESS MESSAGE
 		switch (message.Action)
 		{
@@ -290,7 +290,7 @@ private async ValueTask HandleIncomingMessageSetAsync(string operationId, Backpl
 		if (mca is null)
 		{
 			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 0", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): no memory cache, ignoring incoming backplane message", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
 			return;
 		}
 
@@ -300,7 +300,7 @@ private async ValueTask HandleIncomingMessageSetAsync(string operationId, Backpl
 		if (memoryEntry is null)
 		{
 			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 1", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): no memory entry, ignoring incoming backplane message", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
 			return;
 		}
 
@@ -315,62 +315,44 @@ private async ValueTask HandleIncomingMessageSetAsync(string operationId, Backpl
 		if (memoryEntry.Timestamp >= message.Timestamp)
 		{
 			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 2", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): memory entry more fresh than the incoming backplane message, ignoring incoming backplane message", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
 			return;
 		}
 
-		if (_cache.HasDistributedCache == false)
+		if (_cache.HasDistributedCache)
 		{
-			_cache.MaybeExpireMemoryEntryInternal(operationId, cacheKey, true, message.Timestamp);
-			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 3", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-			return;
-		}
-
-		var dca = _cache.GetCurrentDistributedAccessor(null);
-		if (dca.CanBeUsed(operationId, cacheKey) == false)
-		{
-			_cache.MaybeExpireMemoryEntryInternal(operationId, cacheKey, true, message.Timestamp);
-			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 4", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-			return;
-		}
-
-		//if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-		//	_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): during backplane auto-recovery of an item, the distributed cache was necessary (because of the EnableDistributedExpireOnBackplaneAutoRecovery option) but was not available", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-
-		if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-			_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 5", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+			var dca = _cache.GetCurrentDistributedAccessor(null);
+			if (dca.CanBeUsed(operationId, cacheKey) == false)
+			{
+				if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
+					_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): distributed cache not currently usable, expiring local memory entry", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
 
-		(var isSame, var hasUpdated) = await _cache.TryUpdateMemoryEntryFromDistributedEntryAsync(operationId, cacheKey, memoryEntry).ConfigureAwait(false);
+				_cache.MaybeExpireMemoryEntryInternal(operationId, cacheKey, true, message.Timestamp);
 
-		if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-			_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 6", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+				return;
+			}
 
-		if (isSame)
-		{
-			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 7", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-			return;
-		}
+			(var error, var isSame, var hasUpdated) = await _cache.TryUpdateMemoryEntryFromDistributedEntryUntypedAsync(operationId, cacheKey, memoryEntry).ConfigureAwait(false);
 
-		if (hasUpdated)
-		{
-			if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-				_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 8", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-			return;
+			if (error == false)
+			{
+				if (isSame)
+				{
+					if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
+						_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): memory entry is the same as the distributed entry, ignoring incoming backplane message", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+					return;
+				}
+
+				if (hasUpdated)
+				{
+					if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
+						_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): memory entry updated from the distributed entry, ignoring incoming backplane message", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
+					return;
+				}
+			}
 		}
 
 		_cache.MaybeExpireMemoryEntryInternal(operationId, cacheKey, true, null);
-
-		if (_logger?.IsEnabled(LogLevel.Trace) ?? false)
-			_logger.Log(LogLevel.Trace, "FUSION [N={CacheName} I={CacheInstanceId}] (O={CacheOperationId} K={CacheKey}): AAA 9", _cache.CacheName, _cache.InstanceId, operationId, cacheKey);
-
-		//// TODO: CACHE THE METHOD INFO
-		//var methodInfo = typeof(BackplaneAccessor).GetMethod(nameof(Foo), System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance).MakeGenericMethod(memoryEntry.ValueType);
-		//var task = (Task)methodInfo.Invoke(this, new object[] { operationId, cacheKey, dca!, options, memoryEntry });
-
-		//await task.ConfigureAwait(false);
 	}
 
 	public async ValueTask<bool> PublishSentinelAsync(string operationId, string key, FusionCacheEntryOptions options, CancellationToken token)