Make RocksDBStore.DeleteChainId() idempotent (#891)

* Make RocksDBStore.DeleteChainId() idempotent * Fix RocksDBStore's incorrect log context
planetarium · Jun 2, 2020 · 554692b · 554692b
1 parent 9c38e2a
commit 554692b
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -6,6 +6,15 @@ Version 0.9.4
 
 To be released.
 
+ -  (Libplanet.RocksDBStore) Fixed a bug that  `RocksDBStore.DeleteChainId()`
+    method had thrown `KeyNotFoundException` when there's no such chain ID.
+    [[#891]]
+ -  (Libplanet.RocksDBStore) Fixed a bug that `RocksDBStore` had written logs
+    into the incorrect context `DefaultContext`, not `RocksDBStore`
+    the correct one.  [[#891]]
+
+[#891]: https://github.com/planetarium/libplanet/pull/891
+
 
 Version 0.9.3
 -------------

diff --git a/Libplanet.RocksDBStore/RocksDBStore.cs b/Libplanet.RocksDBStore/RocksDBStore.cs
@@ -76,7 +76,7 @@ public RocksDBStore(
             int statesCacheSize = 10000
         )
         {
-            _logger = Log.ForContext<DefaultStore>();
+            _logger = Log.ForContext<RocksDBStore>();
 
             if (path is null)
             {
@@ -141,11 +141,19 @@ public override IEnumerable<Guid> ListChainIds()
         /// <inheritdoc/>
         public override void DeleteChainId(Guid chainId)
         {
-            _lastStateRefCaches.Remove(chainId);
+            try
+            {
+                _lastStateRefCaches.Remove(chainId);
 
-            var cfName = chainId.ToString();
-            _chainDb.DropColumnFamily(cfName);
-            _stateRefDb.DropColumnFamily(cfName);
+                var cfName = chainId.ToString();
+                _chainDb.DropColumnFamily(cfName);
+                _stateRefDb.DropColumnFamily(cfName);
+            }
+            catch (KeyNotFoundException)
+            {
+                // Do nothing according to the specification: DeleteChainId() should be idempotent.
+                _logger.Debug("No such chain ID: {ChainId}.", chainId);
+            }
         }
 
         /// <inheritdoc />

diff --git a/Libplanet.Tests/Store/StoreTest.cs b/Libplanet.Tests/Store/StoreTest.cs
@@ -73,6 +73,14 @@ public void DeleteChainId()
             Assert.Equal(0, Fx.Store.GetTxNonce(Fx.StoreChainId, Fx.Transaction1.Signer));
         }
 
+        [SkippableFact]
+        public void DeleteChainIdIsIdempotent()
+        {
+            Assert.Empty(Fx.Store.ListChainIds());
+            Fx.Store.DeleteChainId(Guid.NewGuid());
+            Assert.Empty(Fx.Store.ListChainIds());
+        }
+
         [SkippableFact]
         public void CanonicalChainId()
         {