Add Clear() to MemoryCache

src/libraries/Microsoft.Extensions.Caching.Memory/ref/Microsoft.Extensions.Caching.Memory.cs

@@ -34,6 +34,7 @@ protected virtual void Dispose(bool disposing) { }
         ~MemoryCache() { }
         public void Remove(object key) { }
         public bool TryGetValue(object key, out object result) { throw null; }
+        public void Clear() { }
     }
     public partial class MemoryCacheOptions : Microsoft.Extensions.Options.IOptions<Microsoft.Extensions.Caching.Memory.MemoryCacheOptions>
     {

src/libraries/Microsoft.Extensions.Caching.Memory/src/MemoryCache.cs

@@ -23,8 +23,8 @@ public class MemoryCache : IMemoryCache
         internal readonly ILogger _logger;
 
         private readonly MemoryCacheOptions _options;
-        private readonly ConcurrentDictionary<object, CacheEntry> _entries;
 
+        private ConcurrentDictionary<object, CacheEntry> _entries;
         private long _cacheSize;
         private bool _disposed;
         private DateTimeOffset _lastExpirationScan;
@@ -260,8 +260,8 @@ public bool TryGetValue(object key, out object result)
         public void Remove(object key)
         {
             ValidateCacheKey(key);
-
             CheckDisposed();
+
             if (_entries.TryRemove(key, out CacheEntry entry))
             {
                 if (_options.SizeLimit.HasValue)
@@ -276,6 +276,24 @@ public void Remove(object key)
             StartScanForExpiredItemsIfNeeded(_options.Clock.UtcNow);
         }
 
+        /// <summary>
+        /// Removes all keys and values from the cache.
+        /// </summary>
+        public void Clear()
+        {
+            CheckDisposed();
+
+            var oldEntries = Interlocked.Exchange(ref _entries, new ConcurrentDictionary<object, CacheEntry>());
+            Interlocked.Exchange(ref _cacheSize, 0);
+
+            foreach (var entry in oldEntries)
+            {
+                entry.Value.SetExpired(EvictionReason.Removed);
+                entry.Value.InvokeEvictionCallbacks();
+            }
+            oldEntries.Clear();
+        }
+
         private void RemoveEntry(CacheEntry entry)
         {
             if (EntriesCollection.Remove(new KeyValuePair<object, CacheEntry>(entry.Key, entry)))
@@ -317,7 +335,8 @@ private static void ScanForExpiredItems(MemoryCache cache)
         {
             DateTimeOffset now = cache._lastExpirationScan = cache._options.Clock.UtcNow;
 
-            foreach (KeyValuePair<object, CacheEntry> item in cache._entries)
+            var entries = cache._entries; // Clear() can update the reference in the meantime
+            foreach (KeyValuePair<object, CacheEntry> item in entries)
             {
                 CacheEntry entry = item.Value;
 
@@ -402,7 +421,8 @@ private void Compact(long removalSizeTarget, Func<CacheEntry, long> computeEntry
 
             // Sort items by expired & priority status
             DateTimeOffset now = _options.Clock.UtcNow;
-            foreach (KeyValuePair<object, CacheEntry> item in _entries)
+            var entries = _entries; // Clear() can update the reference in the meantime
+            foreach (KeyValuePair<object, CacheEntry> item in entries)
             {
                 CacheEntry entry = item.Value;
                 if (entry.CheckExpired(now))

src/libraries/Microsoft.Extensions.Caching.Memory/tests/CapacityTests.cs

@@ -444,5 +444,19 @@ public void NoCompactionWhenNoMaximumEntriesCountSpecified()
             // There should be 6 items in the cache
             Assert.Equal(6, cache.Count);
         }
+
+        [Fact]
+        public void ClearZeroesTheSize()
+        {
+            var cache = new MemoryCache(new MemoryCacheOptions { SizeLimit = 10 });
+            Assert.Equal(0, cache.Size);
+
+            cache.Set("key", "value", new MemoryCacheEntryOptions { Size = 5 });
+            Assert.Equal(5, cache.Size);
+
+            cache.Clear();
+            Assert.Equal(0, cache.Size);
+            Assert.Equal(0, cache.Count);
+        }
     }
 }

src/libraries/Microsoft.Extensions.Caching.Memory/tests/MemoryCacheSetAndRemoveTests.cs

@@ -366,6 +366,29 @@ public void RemoveRemoves()
             Assert.Null(result);
         }
 
+        [Fact]
+        public void ClearClears()
+        {
+            var cache = (MemoryCache)CreateCache();
+            var obj = new object();
+            string[] keys = new string[] { "key1", "key2", "key3", "key4" };
+
+            foreach (var key in keys)
+            {
+                var result = cache.Set(key, obj);
+                Assert.Same(obj, result);
+                Assert.Same(obj, cache.Get(key));
+            }
+
+            cache.Clear();
+
+            Assert.Equal(0, cache.Count);
+            foreach (var key in keys)
+            {
+                Assert.Null(cache.Get(key));
+            }
+        }
+
         [Fact]
         public void RemoveRemovesAndInvokesCallback()
         {
@@ -397,6 +420,38 @@ public void RemoveRemovesAndInvokesCallback()
             Assert.Null(result);
         }
 
+        [Fact]
+        public void ClearClearsAndInvokesCallback()
+        {
+            var cache = (MemoryCache)CreateCache();
+            var value = new object();
+            string key = "myKey";
+            var callbackInvoked = new ManualResetEvent(false);
+
+            var options = new MemoryCacheEntryOptions();
+            options.PostEvictionCallbacks.Add(new PostEvictionCallbackRegistration()
+            {
+                EvictionCallback = (subkey, subValue, reason, state) =>
+                {
+                    Assert.Equal(key, subkey);
+                    Assert.Same(value, subValue);
+                    Assert.Equal(EvictionReason.Removed, reason);
+                    var localCallbackInvoked = (ManualResetEvent)state;
+                    localCallbackInvoked.Set();
+                },
+                State = callbackInvoked
+            });
+            var result = cache.Set(key, value, options);
+            Assert.Same(value, result);
+
+            cache.Clear();
+            Assert.Equal(0, cache.Count);
+            Assert.True(callbackInvoked.WaitOne(TimeSpan.FromSeconds(30)), "Callback");
+
+            result = cache.Get(key);
+            Assert.Null(result);
+        }
+
         [Fact]
         public void RemoveAndReAddFromCallbackWorks()
         {

src/libraries/Microsoft.Extensions.Caching.Memory/tests/TokenExpirationTests.cs

@@ -162,6 +162,30 @@ public void RemoveItemDisposesTokenRegistration()
             Assert.True(callbackInvoked.WaitOne(TimeSpan.FromSeconds(30)), "Callback");
         }
 
+        [Fact]
+        public void ClearingCacheDisposesTokenRegistration()
+        {
+            var cache = (MemoryCache)CreateCache();
+            string key = "myKey";
+            var value = new object();
+            var callbackInvoked = new ManualResetEvent(false);
+            var expirationToken = new TestExpirationToken() { ActiveChangeCallbacks = true };
+            cache.Set(key, value, new MemoryCacheEntryOptions()
+                .AddExpirationToken(expirationToken)
+                .RegisterPostEvictionCallback((subkey, subValue, reason, state) =>
+                {
+                    // TODO: Verify params
+                    var localCallbackInvoked = (ManualResetEvent)state;
+                    localCallbackInvoked.Set();
+                }, state: callbackInvoked));
+            cache.Clear();
+
+            Assert.Equal(0, cache.Count);
+            Assert.NotNull(expirationToken.Registration);
+            Assert.True(expirationToken.Registration.Disposed);
+            Assert.True(callbackInvoked.WaitOne(TimeSpan.FromSeconds(30)), "Callback");
+        }
+
         [Fact]
         public void AddExpiredTokenPreventsCaching()
         {