From 830893d7135a7a319cf2dde8cbc98fed125a1e54 Mon Sep 17 00:00:00 2001
From: kim <grufwub@gmail.com>
Date: Mon, 16 Sep 2024 10:47:03 +0100
Subject: [PATCH] add comments to each specific key being invalidated

---
 internal/cache/invalidate.go | 40 +++++++++++++++++++++++++++++-------
 1 file changed, 33 insertions(+), 7 deletions(-)

diff --git a/internal/cache/invalidate.go b/internal/cache/invalidate.go
index 72666ed5e..baf989ec8 100644
--- a/internal/cache/invalidate.go
+++ b/internal/cache/invalidate.go
@@ -105,26 +105,46 @@ func (c *Caches) OnInvalidateFollow(follow *gtsmodel.Follow) {
 	c.Visibility.Invalidate("ItemID", follow.TargetAccountID)
 	c.Visibility.Invalidate("RequesterID", follow.TargetAccountID)
 
-	// Invalidate source account's following
-	// lists, and destination's follwer lists.
-	// (see FollowIDs() comment for details).
+	// Invalidate ID slice cache.
 	c.DB.FollowIDs.Invalidate(
+
+		// Invalidate follow ID lists
+		// FROM the origin account
+		// (including local-only follows).
 		">"+follow.AccountID,
 		"l>"+follow.AccountID,
+
+		// Invalidate follow ID lists
+		// TARGETTING origin account
+		// (including local-only follows).
 		"<"+follow.AccountID,
 		"l<"+follow.AccountID,
+
+		// Invalidate follow ID lists
+		// FROM the target account
+		// (including local-only follows).
 		"<"+follow.TargetAccountID,
 		"l<"+follow.TargetAccountID,
+
+		// Invalidate follow ID lists
+		// TARGETTING the target account
+		// (including local-only follows).
 		">"+follow.TargetAccountID,
 		"l>"+follow.TargetAccountID,
 	)
 
-	// Invalidate source account's lists
-	// and destination account's lists, and
-	// those specifically for this follow.
+	// Invalidate ID slice cache.
 	c.DB.ListIDs.Invalidate(
+
+		// Invalidate source
+		// account's owned lists.
 		"a"+follow.AccountID,
+
+		// Invalidate target account's.
 		"a"+follow.TargetAccountID,
+
+		// Invalidate lists containing
+		// list entries for follow.
 		"f"+follow.ID,
 	)
 }
@@ -150,9 +170,15 @@ func (c *Caches) OnInvalidateList(list *gtsmodel.List) {
 		"a" + list.AccountID,
 	)
 
-	// Invalidate listed IDs cache.
+	// Invalidate ID slice cache.
 	c.DB.ListedIDs.Invalidate(
+
+		// Invalidate list of
+		// account IDs in list.
 		"a"+list.ID,
+
+		// Invalidate list of
+		// follow IDs in list.
 		"f"+list.ID,
 	)
 }