Disambiguate cache key for similarly named models (#140)

* Disambiguate cache key for similarly named models

Two models with the same name in different apps would previously get the
same cache key.
Including the model's module in the cache key fixes this.

Author: ahumeau

CHANGES

@@ -1,6 +1,8 @@
 Unreleased
 ==========
 
+* Fix similarly named models from different apps having the same cache key
+
 django-solo-2.3.0
 =================
 

solo/models.py

@@ -64,7 +64,9 @@ def set_to_cache(self) -> None:
     @classmethod
     def get_cache_key(cls) -> str:
         prefix = getattr(settings, "SOLO_CACHE_PREFIX", solo_settings.SOLO_CACHE_PREFIX)
-        return f"{prefix}:{cls.__name__.lower()}"
+        # Include the model's module in the cache key so similarly named models from different
+        # apps do not have the same cache key.
+        return f"{prefix}:{cls.__module__.lower()}:{cls.__name__.lower()}"
 
     @classmethod
     def get_solo(cls) -> Self:

solo/tests/settings.py

@@ -17,6 +17,7 @@
 INSTALLED_APPS = (
     "solo",
     "solo.tests",
+    "solo.tests.testapp2",
 )
 
 SECRET_KEY = "any-key"

solo/tests/testapp2/__init__.py

@@ -0,0 +1,6 @@
+from solo.models import SingletonModel
+
+
+class SiteConfiguration(SingletonModel):
+    class Meta:
+        verbose_name = "Site Configuration 2"

solo/tests/testapp2/models.py

@@ -5,6 +5,7 @@
 from django.test.utils import override_settings
 
 from solo.tests.models import SiteConfiguration, SiteConfigurationWithExplicitlyGivenId
+from solo.tests.testapp2.models import SiteConfiguration as SiteConfiguration2
 
 
 class SingletonTest(TestCase):
@@ -103,3 +104,11 @@ def setUp(self):
     def test_when_singleton_instance_id_is_given_created_item_will_have_given_instance_id(self):
         item = SiteConfigurationWithExplicitlyGivenId.get_solo()
         self.assertEqual(item.pk, SiteConfigurationWithExplicitlyGivenId.singleton_instance_id)
+
+
+class SingletonsWithAmbiguousNameTest(TestCase):
+    def test_cache_key_is_not_ambiguous(self):
+        assert SiteConfiguration.get_cache_key() != SiteConfiguration2.get_cache_key()
+
+    def test_get_solo_returns_the_correct_singleton(self):
+        assert SiteConfiguration.get_solo() != SiteConfiguration2.get_solo()