fix: Get renderer working as expected (#105)

* Remove `register` loop from `shop` reference in modules
* Create a new renderer instance for this module

Author: sveneberth

src/viur/shop/modules/abstract.py

@@ -3,8 +3,8 @@
 from viur.core import Module, current, translate
 from viur.core.prototypes import List, Tree
 from viur.core.prototypes.tree import SkelType
+from viur.core.render.abstract import AbstractRenderer
 from viur.core.skeleton import SkeletonInstance
-
 from ..globals import SHOP_LOGGER
 
 if t.TYPE_CHECKING:
@@ -37,7 +37,8 @@ def __init__(
         shop: "Shop" = None,
         *args, **kwargs
     ):
-        # logger.debug(f"{self.__class__.__name__}<ShopModuleAbstract>.__init__()")
+        # logger.debug(f"{self.__class__.__name__}<ShopModuleAbstract>.__init__({moduleName=}, {modulePath=}, {shop=})")
+        self._is_registered = False
         if shop is None:
             raise ValueError("Missing shop argument!")
         if moduleName is None:
@@ -51,6 +52,23 @@ def __init__(
         super().__init__(moduleName, modulePath, *args, **kwargs)
         self.shop: "Shop" = shop
 
+    def register(self, target: dict, render: AbstractRenderer) -> None:
+        """
+        Overwritten to avoid loops.
+        The modules have an `shop` root/parent reference, but this should
+        not again be discovered by :meth:`register`.
+
+        Furthermore, this creates a new renderer instance just for this module
+        (with the `parent` reference), which does usually the viur-core in
+        :meth:`core.__build_app`. Otherwise, every module would use the same
+        shop renderer.
+        """
+        if self._is_registered:
+            return
+        self._is_registered = True
+        render = type(render)(parent=self)  # Create a new renderer instance for this module
+        return super().register(target, render)
+
     @property
     def session(self) -> dict:
         """Return a own session scope for this module"""

src/viur/shop/shop.py

@@ -3,11 +3,11 @@
 
 from viur.core import conf, logging
 from viur.core.bones import RelationalBone
-from viur.core.decorators import exposed
 from viur.core.module import Module
 from viur.core.modules.translation import Creator, TranslationSkel
 from viur.core.modules.user import UserSkel
 from viur.core.prototypes.instanced_module import InstancedModule
+from viur.core.render.abstract import AbstractRenderer
 from viur.core.skeleton import MetaSkel, skeletonByKind
 from viur.shop.data.translations import TRANSLATIONS
 from viur.shop.skeletons.article import ArticleAbstractSkel
@@ -29,6 +29,8 @@
 
 
 class Shop(InstancedModule, Module):
+    _is_registered_for: t.ClassVar[set[str]] = set()
+
     def __init__(
         self,
         *,
@@ -50,6 +52,7 @@ def __init__(
         #
         **kwargs: t.Any,
     ):
+        # logger.debug(f"{self.__class__.__name__}<Shop>.__init__()")
         super().__init__()
         self.hooks = HOOK_SERVICE
 
@@ -115,8 +118,26 @@ def __call__(self, *args, **kwargs) -> t.Self:
             SHOP_INSTANCE.set(self)
         elif self.modulePath == f"/vi/{self.moduleName}":
             SHOP_INSTANCE_VI.set(self)
+
+        import renders
+
+        logger.debug(dir(renders))
+
         return self
 
+    def register(self, target: dict, render: AbstractRenderer) -> None:
+        """
+        Overwritten to avoid loops.
+        The modules have an `shop` root/parent reference, but this should
+        not again be discovered by :meth:`register`.
+        """
+        # logging.debug(f"{self.__class__.__name__}.register() {self.moduleName=} {self.modulePath=} "
+        #               f"{id(target)=} {render=} {self._is_registered_for=}")
+        if (render_name := f"{type(render).__module__}.{type(render).__qualname__}") in Shop._is_registered_for:
+            return
+        Shop._is_registered_for.add(render_name)
+        return super().register(target, render)
+
     def _set_kind_names(self) -> None:
         """Set kindname of bones where the kind name can be dynamically
 
@@ -228,6 +249,16 @@ def _add_translations(self) -> None:
             except Exception as exc:
                 logger.exception(f"Failed to write added translation {skel=} :: {exc}")
 
+    def __repr__(self) -> str:
+        cls = type(self)
+        return (
+            f"<{cls.__module__}.{cls.__qualname__} object"
+            f"with moduleName={getattr(self, "moduleName", "NOT_SET")}, "
+            f"modulePath={getattr(self, "modulePath", "NOT_SET")}, "
+            f"render={getattr(self, "render", "NOT_SET")}"
+            f"at {hex(id(self))}>"
+        )
+
 
 Shop.html = True
 Shop.vi = True