Remove LogTo method, ILog and Debug logging

Author: hjgraca

libraries/src/AWS.Lambda.Powertools.Idempotency/AWS.Lambda.Powertools.Idempotency.csproj

@@ -43,4 +43,8 @@
         <None Include="../../AWSLogo128x128.png" Pack="true" Visible="false" PackagePath="" />
     </ItemGroup>
 
+    <ItemGroup>
+      <Folder Include="Output\" />
+    </ItemGroup>
+
 </Project>

libraries/src/AWS.Lambda.Powertools.Idempotency/IdempotencyOptions.cs

@@ -13,8 +13,6 @@
  * permissions and limitations under the License.
  */
 
-using AWS.Lambda.Powertools.Idempotency.Output;
-
 namespace AWS.Lambda.Powertools.Idempotency;
 
 /// <summary>
@@ -59,11 +57,6 @@ public class IdempotencyOptions
     /// as supported by <see cref="System.Security.Cryptography.HashAlgorithm"/> (eg. SHA1, SHA-256, ...)
     /// </summary>
     public string HashFunction { get; }
-    
-    /// <summary>
-    /// Instance of ILog to record internal details of idempotency 
-    /// </summary>
-    public ILog Log { get; }
 
     internal IdempotencyOptions(
         string eventKeyJmesPath, 
@@ -72,8 +65,7 @@ internal IdempotencyOptions(
         bool useLocalCache, 
         int localCacheMaxItems, 
         long expirationInSeconds, 
-        string hashFunction,
-        ILog log)
+        string hashFunction)
     {
         EventKeyJmesPath = eventKeyJmesPath;
         PayloadValidationJmesPath = payloadValidationJmesPath;
@@ -82,6 +74,5 @@ internal IdempotencyOptions(
         LocalCacheMaxItems = localCacheMaxItems;
         ExpirationInSeconds = expirationInSeconds;
         HashFunction = hashFunction;
-        Log = log;
     }
 }

libraries/src/AWS.Lambda.Powertools.Idempotency/IdempotencyOptionsBuilder.cs

@@ -1,5 +1,4 @@
 using System;
-using AWS.Lambda.Powertools.Idempotency.Output;
 
 namespace AWS.Lambda.Powertools.Idempotency;
 
@@ -15,7 +14,6 @@ public class IdempotencyOptionsBuilder
     private string _payloadValidationJmesPath;
     private bool _throwOnNoIdempotencyKey;
     private string _hashFunction = "MD5";
-    private ILog _log = new NullLog();
 
     /// <summary>
     /// Initialize and return an instance of IdempotencyConfig.
@@ -32,8 +30,7 @@ public IdempotencyOptions Build() =>
             _useLocalCache,
             _localCacheMaxItems,
             _expirationInSeconds,
-            _hashFunction,
-            _log);
+            _hashFunction);
 
     /// <summary>
     /// A JMESPath expression to extract the idempotency key from the event record.
@@ -103,15 +100,4 @@ public IdempotencyOptionsBuilder WithHashFunction(string hashFunction)
         _hashFunction = hashFunction;
         return this;
     }
-
-    /// <summary>
-    /// Logs to a custom logger.
-    /// </summary>
-    /// <param name="log">The logger.</param>
-    /// <returns>the instance of the builder (to chain operations)</returns>
-    public IdempotencyOptionsBuilder LogTo(ILog log)
-    {
-        _log = log;
-        return this;
-    }
 }

libraries/src/AWS.Lambda.Powertools.Idempotency/Internal/IdempotencyAspectHandler.cs

@@ -17,7 +17,6 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using AWS.Lambda.Powertools.Idempotency.Exceptions;
-using AWS.Lambda.Powertools.Idempotency.Output;
 using AWS.Lambda.Powertools.Idempotency.Persistence;
 
 namespace AWS.Lambda.Powertools.Idempotency.Internal;
@@ -29,7 +28,6 @@ internal class IdempotencyAspectHandler<T>
     private readonly Func<Task<T>> _target;
     private readonly JsonDocument _data;
     private readonly BasePersistenceStore _persistenceStore;
-    private readonly ILog _log;
 
     public IdempotencyAspectHandler(
         Func<Task<T>> target,
@@ -40,7 +38,6 @@ public IdempotencyAspectHandler(
         _data = payload;
         _persistenceStore = Idempotency.Instance.PersistenceStore;
         _persistenceStore.Configure(Idempotency.Instance.IdempotencyOptions, functionName);
-        _log = Idempotency.Instance.IdempotencyOptions.Log;
     }
 
     /// <summary>
@@ -117,7 +114,7 @@ private Task<DataRecord> GetIdempotencyRecord()
         catch (IdempotencyItemNotFoundException e)
         {
             // This code path will only be triggered if the record is removed between saveInProgress and getRecord
-            _log.WriteDebug("An existing idempotency record was deleted before we could fetch it");
+            Console.WriteLine("An existing idempotency record was deleted before we could fetch it");
             throw new IdempotencyInconsistentStateException("saveInProgress and getRecord return inconsistent results",
                 e);
         }
@@ -159,7 +156,6 @@ private Task<T> HandleForStatus(DataRecord record)
             default:
                 try
                 {
-                    _log.WriteDebug("Response for key '{0}' retrieved from idempotency store, skipping the function", record.IdempotencyKey);
                     var result = JsonSerializer.Deserialize<T>(record.ResponseData!);
                     if (result is null)
                     {

libraries/src/AWS.Lambda.Powertools.Idempotency/Output/ILog.cs

@@ -21,7 +21,6 @@
 using AWS.Lambda.Powertools.Common;
 using AWS.Lambda.Powertools.Idempotency.Exceptions;
 using AWS.Lambda.Powertools.Idempotency.Internal;
-using AWS.Lambda.Powertools.Idempotency.Output;
 using AWS.Lambda.Powertools.Idempotency.Serialization;
 using DevLab.JmesPath;
 
@@ -41,10 +40,6 @@ public abstract class BasePersistenceStore : IPersistenceStore
     /// </summary>
     protected bool PayloadValidationEnabled;
     private LRUCache<string, DataRecord> _cache = null!;
-    /// <summary>
-    /// Instance of ILog to log the internal details of idempotency
-    /// </summary>
-    protected ILog Log = null!;
 
     /// <summary>
     /// Initialize the base persistence layer from the configuration settings
@@ -60,7 +55,6 @@ public void Configure(IdempotencyOptions idempotencyOptions, string functionName
             _functionName += "." + functionName;
         }
         _idempotencyOptions = idempotencyOptions;
-        Log = _idempotencyOptions.Log;
 
         //TODO: optimize to not reconfigure
         if (!string.IsNullOrWhiteSpace(_idempotencyOptions.PayloadValidationJmesPath))
@@ -100,7 +94,6 @@ public virtual async Task SaveSuccess(JsonDocument data, object result, DateTime
             responseJson,
             GetHashedPayload(data)
         );
-        Log.WriteDebug("Function successfully executed. Saving record to persistence store with idempotency key: {0}", record.IdempotencyKey);
         await UpdateRecord(record);
         SaveToCache(record);
     }
@@ -127,7 +120,6 @@ public virtual async Task SaveInProgress(JsonDocument data, DateTimeOffset now)
             null,
             GetHashedPayload(data)
         );
-        Log.WriteDebug("saving in progress record for idempotency key: {0}", record.IdempotencyKey);
         await PutRecord(record, now);
     }
 
@@ -140,7 +132,7 @@ public virtual async Task DeleteRecord(JsonDocument data, Exception throwable)
     {
         var idemPotencyKey = GetHashedIdempotencyKey(data);
 
-        Log.WriteDebug("Function raised an exception {0}. " +
+        Console.WriteLine("Function raised an exception {0}. " +
                   "Clearing in progress record in persistence store for idempotency key: {1}",
             throwable.GetType().Name,
             idemPotencyKey);
@@ -162,7 +154,6 @@ public virtual async Task<DataRecord> GetRecord(JsonDocument data, DateTimeOffse
         var cachedRecord = RetrieveFromCache(idempotencyKey, now);
         if (cachedRecord != null)
         {
-            Log.WriteDebug("Idempotency record found in cache with idempotency key: {0}", idempotencyKey);
             ValidatePayload(data, cachedRecord);
             return cachedRecord;
         }
@@ -217,7 +208,6 @@ private DataRecord RetrieveFromCache(string idempotencyKey, DateTimeOffset now)
             {
                 return record;
             }
-            Log.WriteDebug("Removing expired local cache record for idempotency key: {0}", idempotencyKey);
             DeleteFromCache(idempotencyKey);
         }
         return null;
@@ -285,7 +275,7 @@ private string GetHashedIdempotencyKey(JsonDocument data)
             {
                 throw new IdempotencyKeyException("No data found to create a hashed idempotency key");
             }
-            Log.WriteWarning("No data found to create a hashed idempotency key. JMESPath: {0}", _idempotencyOptions.EventKeyJmesPath ?? string.Empty);
+            Console.WriteLine("No data found to create a hashed idempotency key. JMESPath: {0}", _idempotencyOptions.EventKeyJmesPath ?? string.Empty);
         }
 
         var hash = GenerateHash(node);

libraries/src/AWS.Lambda.Powertools.Idempotency/Output/NullLog.cs

@@ -123,8 +123,6 @@ public override async Task PutRecord(DataRecord record, DateTimeOffset now)
 
         try
         {
-            Log.WriteDebug("Putting record for idempotency key: {0}", record.IdempotencyKey);
-
             var expressionAttributeNames = new Dictionary<string, string>
             {
                 {"#id", _keyAttr},
@@ -146,7 +144,6 @@ public override async Task PutRecord(DataRecord record, DateTimeOffset now)
         }
         catch (ConditionalCheckFailedException e)
         {
-            Log.WriteDebug("Failed to put record for already existing idempotency key: {0}", record.IdempotencyKey);
             throw new IdempotencyItemAlreadyExistsException(
                 "Failed to put record for already existing idempotency key: " + record.IdempotencyKey, e);
         }
@@ -156,7 +153,6 @@ public override async Task PutRecord(DataRecord record, DateTimeOffset now)
     /// <inheritdoc />
     public override async Task UpdateRecord(DataRecord record) 
     {
-        Log.WriteDebug("Updating record for idempotency key: {0}", record.IdempotencyKey);
         var updateExpression = "SET #response_data = :response_data, #expiry = :expiry, #status = :status";
 
         var expressionAttributeNames = new Dictionary<string, string>
@@ -194,7 +190,6 @@ public override async Task UpdateRecord(DataRecord record)
     /// <inheritdoc />
     public override async Task DeleteRecord(string idempotencyKey) 
     {
-        Log.WriteDebug("Deleting record for idempotency key: {0}", idempotencyKey);
         var request = new DeleteItemRequest
         {
             TableName = _tableName,