From 8c5c79e308a368280f7a66bf0377c782d5614492 Mon Sep 17 00:00:00 2001
From: Kevin Squire <kevin@secondspectrum.com>
Date: Fri, 22 Nov 2024 16:13:48 -0800
Subject: [PATCH] RFC: Fix rehash check (#74)

* Fix rehash check

* We should rehash when 3/4 of the slots have been deleted, not when 3/4
  of the keys have been deleted.  The previous logic caused us to rehash
  when, e.g., there were 5 keys and we deleted 4.  The new logic
  requires at least 12 removals before a size-based rehash occurs.

* Update src/ordered_dict.jl

Co-authored-by: Kevin Squire <kevin@secondspectrum.com>

---------

Co-authored-by: Max Horn <max@quendi.de>
---
 src/ordered_dict.jl       |  2 +-
 test/test_ordered_dict.jl | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/src/ordered_dict.jl b/src/ordered_dict.jl
index 0db6279..f27a1a6 100644
--- a/src/ordered_dict.jl
+++ b/src/ordered_dict.jl
@@ -313,7 +313,7 @@ function _setindex!(h::OrderedDict, v, key, index)
     sz = length(h.slots)
     cnt = nk - h.ndel
     # Rehash now if necessary
-    if h.ndel >= ((3*nk)>>2) || cnt*3 > sz*2
+    if h.ndel >= ((3*nk)>>2) >= 3 || cnt*3 > sz*2
         # > 3/4 deleted or > 2/3 full
         rehash!(h, cnt > 64000 ? cnt*2 : cnt*4)
     end
diff --git a/test/test_ordered_dict.jl b/test/test_ordered_dict.jl
index 4a1100d..18f7306 100644
--- a/test/test_ordered_dict.jl
+++ b/test/test_ordered_dict.jl
@@ -474,6 +474,39 @@ using OrderedCollections, Test
         @test od[14] == 14
     end
 
+    @testset "Issue #65" begin
+        x = OrderedDict{OrderedDict, Int}()
+        x[x] = 0  # There's no reason to ever do this, but it shouldn't overflow the stack
+        @test length(deepcopy(x)) == 1
+
+        # Test that a rehash isn't triggered during setindex! with only a few keys added/removed.
+        # It should only be triggered when a count equal to 3/4 of the slots have been removed.
+        # With the smallest size dict, that would be 12/16
+        od = OrderedDict{Int,Int}(i=>i for i in 1:5)
+        for i in 1:4
+            pop!(od, i)
+        end
+        del_slots1 = sum(od.slots .< 0)
+        od[6] = 6
+        del_slots2 = sum(od.slots .< 0)
+        @test del_slots1 - 1 <= del_slots2 <= del_slots1
+
+        for i in 7:14
+            od[i] = i
+        end
+        for i in 5:13
+            pop!(od, i)
+        end
+        del_slots3 = sum(od.slots .< 0)
+        # Some of the previously deleted slots might have been reused, but we should at
+        # least see deleted slots for items 5 through 13
+        @test del_slots3 >= 9
+        # We've now removed 13 items, so the next assignment should trigger a rehash
+        od[15] = 15
+        del_slots4 = sum(od.slots .< 0)
+        @test del_slots4 == 0
+    end
+
     @testset "ordered access" begin
         od = OrderedDict(:a=>1, :b=>2, :c=>3)
         @test popfirst!(od) == (:a => 1)
@@ -493,4 +526,5 @@ using OrderedCollections, Test
         end
         @test pass
     end
+
 end # @testset OrderedDict