Merge branch 'main' into feature/lazy_basket_creation

Conflicts:
	src/viur/shop/modules/cart.py
	src/viur/shop/skeletons/cart.py

Author: sveneberth

README.md

@@ -1,4 +1,5 @@
 <div align="center">
+    <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-shop.svg" height="196" alt="A hexagonal logo of Shop" title="Shop logo"/>
     <h1>viur-shop (WIP)</h1>
     <a href="https://pypi.org/project/viur-shop/">
         <img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-shop">

pyproject.toml

@@ -9,9 +9,10 @@ build-backend = "setuptools.build_meta"
 name = "viur-shop"
 dynamic = ["version"]
 dependencies = [
-    "viur-toolkit>=0.1.0.dev4"
+    "viur-toolkit>=0.2.0",
+    "viur-core>=3.7.0"
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 authors = [
     { name = "Sven Eberth", email = "se@mausbrand.de" },
 ]
@@ -23,11 +24,10 @@ readme = "README.md"
 license = { file = "LICENSE" }
 keywords = ["viur", "plugin", "backend", "shop"]
 classifiers = [
-    "Development Status :: 1 - Planning",
+    "Development Status :: 2 - Pre-Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries :: Python Modules",

src/viur/shop/modules/address.py

@@ -82,7 +82,7 @@ def _disable_old_default(self, skel: SkeletonInstance) -> None:
         for other_skel in query.fetch(100):
             if skel["key"] != other_skel["key"]:
                 other_skel["is_default"] = False
-                other_skel.toDB()
+                other_skel.write()
 
 
 Address.json = True

src/viur/shop/modules/cart.py

@@ -5,11 +5,12 @@
 from viur.core.bones import BaseBone
 from viur.core.prototypes import Tree
 from viur.core.prototypes.tree import SkelType
+from viur.core.session import Session
 from viur.core.skeleton import Skeleton, SkeletonInstance
 from viur.shop.modules.abstract import ShopModuleAbstract
 from viur.shop.types import *
 from viur.shop.types.exceptions import InvalidStateError
-from ..globals import SENTINEL, SHOP_LOGGER
+from ..globals import SENTINEL, SHOP_INSTANCE, SHOP_LOGGER
 from ..services import EVENT_SERVICE, Event
 from ..skeletons.cart import CartItemSkel, CartNodeSkel
 from ..skeletons.order import OrderSkel
@@ -40,9 +41,9 @@ def baseSkel(
         if sub_skel is None:
             return cls()  # noqa
         if isinstance(sub_skel, list):
-            return cls.subSkel(*sub_skel)
+            return cls.subskel(*sub_skel)
         else:
-            return cls.subSkel(sub_skel)
+            return cls.subskel(sub_skel)
 
     def canView(self, skelType: SkelType, skel: SkeletonInstance) -> bool:
         if super().canView(skelType, skel):
@@ -63,7 +64,7 @@ def current_session_cart_key(self) -> db.Key | None:
     def get_current_session_cart_key(self, *, create_if_missing: bool = False) -> db.Key | None:
         if user := current.user.get():
             user_skel = conf.main_app.vi.user.viewSkel()
-            user_skel.fromDB(user["key"])
+            user_skel.read(user["key"])
             if user_skel["basket"]:
                 self.session["session_cart_key"] = user_skel["basket"]["dest"]["key"]
                 current.session.get().markChanged()
@@ -74,7 +75,7 @@ def get_current_session_cart_key(self, *, create_if_missing: bool = False) -> db
     @property
     def current_session_cart(self) -> SkeletonInstance_T[CartNodeSkel]:  # TODO: Caching
         skel = self.viewSkel("node")
-        if not skel.fromDB(self.get_current_session_cart_key(create_if_missing=True)):
+        if not skel.read(self.get_current_session_cart_key(create_if_missing=True)):
             logger.critical(f"Invalid session_cart_key {self.current_session_cart_key} ?! Not in DB!")
             self.detach_session_cart()
             return self.current_session_cart
@@ -87,8 +88,8 @@ def _ensure_current_session_cart(self) -> db.Key:
             root_node["is_root_node"] = True
             root_node["name"] = root_node.name.getDefaultValue(root_node)
             root_node["cart_type"] = CartType.BASKET
-            key = root_node.toDB()
-            self.session["session_cart_key"] = key
+            root_node.write()
+            self.session["session_cart_key"] = root_node["key"]
             current.session.get().markChanged()
             # Store basket at the user skel, it will be shared over multiple sessions / devices
             if user := current.user.get():
@@ -106,9 +107,9 @@ def detach_session_cart(self) -> db.Key:
     @staticmethod
     def _set_basket_txn(user_key: db.Key, basket_key: db.Key | None) -> SkeletonInstance:
         user_skel = conf.main_app.vi.user.editSkel()
-        user_skel.fromDB(user_key)
+        user_skel.read(user_key)
         user_skel.setBoneValue("basket", basket_key)
-        user_skel.toDB()
+        user_skel.write()
         return user_skel
 
     def get_available_root_nodes(self, *args, **kwargs) -> list[dict[t.Literal["name", "key"], str]]:
@@ -160,7 +161,7 @@ def is_valid_node(
         """
         # TODO: return (okay_status, reason, skel) tuple/Dataclass?
         skel = self.viewSkel("node")
-        if not skel.fromDB(node_key):
+        if not skel.read(node_key):
             logger.debug(f"fail reason: 404")
             return False
         logger.debug(f'{skel=}')
@@ -224,7 +225,7 @@ def cart_get(
         if not isinstance(cart_key, db.Key):
             raise TypeError(f"cart_key must be an instance of db.Key")
         skel = self.viewSkel(skel_type)
-        if not skel.fromDB(cart_key):
+        if not skel.read(cart_key):
             logger.debug(f"Cart {cart_key} does not exist")
             return None
         if not self.canView(skel_type, skel):
@@ -278,13 +279,13 @@ def add_or_update_article(
             res = skel.setBoneValue("article", article_key)
             skel["parententry"] = parent_cart_key
             parent_skel = self.viewSkel("node")
-            assert parent_skel.fromDB(parent_cart_key)
+            assert parent_skel.read(parent_cart_key)
             if parent_skel["is_root_node"]:
                 skel["parentrepo"] = parent_skel["key"]
             else:
                 skel["parentrepo"] = parent_skel["parentrepo"]
             article_skel: SkeletonInstance = self.shop.article_skel()
-            if not article_skel.fromDB(article_key):
+            if not article_skel.read(article_key):
                 raise errors.NotFound(f"Article with key {article_key=} does not exist!")
             if not article_skel["shop_listed"]:
                 # logger.debug(f"not listed: {article_skel=}")
@@ -337,7 +338,7 @@ def add_or_update_article(
                 descr_appendix=f'Quantity of free article cannot be greater than 1! (reached {skel["quantity"]})'
             )
         skel = self.additional_add_or_update_article(skel, **kwargs)
-        key = skel.toDB()
+        skel.write()
         EVENT_SERVICE.call(Event.ARTICLE_CHANGED, skel=skel, deleted=False)
         self.clear_children_cache()
         # TODO: Validate quantity with hook (stock availability)
@@ -346,7 +347,7 @@ def add_or_update_article(
                 skel=parent_skel
             )
             EVENT_SERVICE.call(Event.CART_CHANGED, skel=parent_skel, deleted=False)
-            parent_skel.toDB()
+            parent_skel.write()
 
         return skel
 
@@ -370,7 +371,7 @@ def move_article(
         parent_skel = self.viewSkel("node")
         if not self.is_valid_node(new_parent_cart_key):
             raise e.InvalidArgumentException("parent_cart_key", parent_cart_key)
-        if not parent_skel.fromDB(new_parent_cart_key):
+        if not parent_skel.read(new_parent_cart_key):
             raise e.InvalidArgumentException(
                 "new_parent_cart_key", new_parent_cart_key,
                 f"Target cart node does not exist"
@@ -381,7 +382,7 @@ def move_article(
                 f"Target cart node is inside a different repo"
             )
         skel["parententry"] = new_parent_cart_key
-        skel.toDB()
+        skel.write()
         EVENT_SERVICE.call(Event.ARTICLE_CHANGED, skel=skel, deleted=False)
         return skel
 
@@ -415,7 +416,7 @@ def cart_add(
             discount_key=discount_key,
         )
         skel = self.additional_cart_add(skel, **kwargs)
-        skel.toDB()
+        skel.write()
         EVENT_SERVICE.call(Event.CART_CHANGED, skel=skel, deleted=False)
         self.onAdded("node", skel)
         return skel
@@ -445,7 +446,7 @@ def cart_update(
         # TODO: must be inside a own root node ...
         # if not self.canEdit(skel):
         #     raise errors.Forbidden
-        assert skel.fromDB(cart_key)
+        assert skel.read(cart_key)
         skel = self._cart_set_values(
             skel=skel,
             parent_cart_key=parent_cart_key,
@@ -456,7 +457,7 @@ def cart_update(
             discount_key=discount_key,
         )
         self.additional_cart_update(skel, **kwargs)
-        skel.toDB()
+        skel.write()
         EVENT_SERVICE.call(Event.CART_CHANGED, skel=skel, deleted=False)
         return skel
 
@@ -482,7 +483,7 @@ def _cart_set_values(
                 if not self.is_valid_node(parent_cart_key):
                     raise e.InvalidArgumentException("parent_cart_key", parent_cart_key)
                 parent_skel = self.viewSkel("node")
-                assert parent_skel.fromDB(parent_cart_key)
+                assert parent_skel.read(parent_cart_key)
                 if parent_skel["is_root_node"]:
                     skel["parentrepo"] = parent_skel["key"]
                 else:
@@ -531,10 +532,12 @@ def cart_remove(
         self,
         cart_key: db.Key,
     ) -> None:
-        self.deleteRecursive(cart_key)
         skel = self.editSkel("node")
-        if not skel.fromDB(cart_key):
+        if not skel.read(cart_key):
             raise errors.NotFound
+        # This delete could fail if the cart is used by an order
+        skel.delete()
+        self.deleteRecursive(cart_key)
         if skel["parententry"] is None or skel["is_root_node"]:
             logger.info(f"{skel['key']} was a root node!")
             # raise NotImplementedError("Cannot delete root node")
@@ -543,7 +546,6 @@ def cart_remove(
                 self.detach_session_cart()
                 # del self.session["session_cart_key"]
                 # current.session.get().markChanged()
-        skel.delete()
         EVENT_SERVICE.call(Event.CART_CHANGED, skel=skel, deleted=True)
 
     # --- Hooks ---------------------------------------------------------------
@@ -629,14 +631,14 @@ def freeze_cart(
         #   ensure each article still exists and shop_listed is True
         return NotImplemented
         cart_skel = self.editSkel("node")
-        assert cart_skel.fromDB(cart_key)
+        assert cart_skel.read(cart_key)
         """
         skel["shop_vat_rate_value"] = self.shop.vat_rate.get_vat_rate_for_country(
             country=order_skel["billing_address"]["dest"]["country"],
             category=article_skel["shop_vat_rate_category"],
         )
         """
-        cart_skel.toDB()
+        cart_skel.write()
 
     # -------------------------------------------------------------------------
 
@@ -646,13 +648,13 @@ def get_discount_for_leaf(
     ) -> list[SkeletonInstance]:
         if isinstance(leaf_key_or_skel, db.Key):
             skel = self.viewSkel("leaf")
-            skel.fromDB(leaf_key_or_skel)
+            skel.read(leaf_key_or_skel)
         else:
             skel = leaf_key_or_skel
         discounts = []
         while (pk := skel["parententry"]):
             skel = self.viewSkel("node", sub_skel="discount")
-            if not skel.fromDB(pk):
+            if not skel.read(pk):
                 raise InvalidStateError(f"{pk=} doesn't exist!")
             if discount := skel["discount"]:
                 discounts.append(discount["dest"])
@@ -665,10 +667,32 @@ def add_new_parent(self, leaf_skel, **kwargs):
         for key, value in kwargs.items():
             new_parent_skel[key] = value  # TODO: use .setBoneValue?
         self.onAdd("node", new_parent_skel)
-        new_parent_skel.toDB()
+        new_parent_skel.write()
         self.onAdded("node", new_parent_skel)
         EVENT_SERVICE.call(Event.CART_CHANGED, skel=new_parent_skel, deleted=False)
         leaf_skel["parententry"] = new_parent_skel["key"]
-        leaf_skel.toDB()
+        leaf_skel.write()
         EVENT_SERVICE.call(Event.ARTICLE_CHANGED, skel=leaf_skel, deleted=False)
         return new_parent_skel
+
+
+try:
+    Session.on_delete
+except AttributeError:  # backward compatibility for viur-core
+    from viur.core.version import __version__
+
+    logger.warning(f"viur-core {__version__} has no Session.on_delete")
+    Session.on_delete = lambda *_, **__: None
+
+
+@Session.on_delete
+def delete_guest_cart(session: db.Entity) -> None:
+    """Delete carts from guest sessions to avoid orphaned carts"""
+    if session["user"] != Session.GUEST_USER:
+        return
+    try:
+        cart = session["data"]["shop"]["cart"]["session_cart_key"]
+    except (KeyError, TypeError):
+        return
+    SHOP_INSTANCE.get().cart.cart_remove(cart)
+    logger.debug(f"Deleted {cart=} and children after deleting {session=}")

src/viur/shop/modules/discount.py

@@ -51,7 +51,7 @@ def search(
 
         skel = self.viewSkel()
         if discount_key is not None:
-            if not skel.fromDB(discount_key):
+            if not skel.read(discount_key):
                 raise errors.NotFound
             return [skel]
         elif code is not None:
@@ -154,7 +154,7 @@ def apply(
                     for leaf_skel in leaf_skels:
                         # Assign discount on new parent node for the leaf where the article is
                         parent_skel = self.shop.cart.viewSkel("node")
-                        assert parent_skel.fromDB(leaf_skel["parententry"])
+                        assert parent_skel.read(leaf_skel["parententry"])
                         if parent_skel["discount"] and parent_skel["discount"]["dest"]["key"] == discount_skel["key"]:
                             logger.info("Parent has already this discount key")
                             continue
@@ -191,7 +191,7 @@ def can_apply(
             cart = None
         else:
             cart = self.shop.cart.viewSkel("node")
-            if not cart.fromDB(cart_key):
+            if not cart.read(cart_key):
                 raise errors.NotFound
 
         if not as_automatically and skel["activate_automatically"]:
@@ -226,7 +226,7 @@ def remove(
 
         discount_skel = self.viewSkel()
 
-        if not discount_skel.fromDB(discount_key):
+        if not discount_skel.read(discount_key):
             raise errors.NotFound
         try:
             # Todo what we do when we have more than more condition

src/viur/shop/modules/discount_condition.py

@@ -100,7 +100,7 @@ def on_change(self, skel, event: str):
         # logger.debug(pprint.pformat(skel, width=120))
         skel_old = self.viewSkel()
         if skel["key"] is not None:  # not on add
-            skel_old.fromDB(skel["key"])
+            skel_old.read(skel["key"])
         current.request_data.get()[f'shop_skel_{skel["key"]}'] = skel_old
 
     def on_changed(self, skel, event: str):
@@ -119,7 +119,7 @@ def generate_subcodes(self, parent_key: db.Key, prefix: str, amount: int):
         """Generate subcodes for a parent individual code."""
         chunk_amount = amount
         while chunk_amount > 0:
-            skel = self.addSkel()  # .subSkel("individual")
+            skel = self.addSkel()  # .subskel("individual")
             skel["is_subcode"] = True
             skel["quantity_volume"] = 1
             skel.setBoneValue("parent_code", parent_key)
@@ -131,7 +131,7 @@ def generate_subcodes(self, parent_key: db.Key, prefix: str, amount: int):
 
                 try:
                     self.onAdd(skel)
-                    skel.toDB()
+                    skel.write()
                     self.onAdded(skel)
                     break
                 except ValueError as e:
@@ -164,7 +164,7 @@ def get_skel(cls, key: db.Key, expires: int = 3600) -> SkeletonInstance_T["Disco
     def _get_skel(key: db.Key, ttl_hash: int | None = None) -> SkeletonInstance_T["DiscountConditionSkel"] | None:
         # logger.debug(f"_get_skel({key=}, {ttl_hash=})")
         skel = SHOP_INSTANCE.get().discount_condition.viewSkel()
-        if not skel.fromDB(key):
+        if not skel.read(key):
             return None
         return skel  # type: ignore
 
@@ -175,7 +175,7 @@ def get_by_code(self, code: str = None) -> t.Iterator[SkeletonInstance]:
         for cond_skel in query.fetch(100):
             if cond_skel["is_subcode"]:
                 parent_cond_skel = self.viewSkel()
-                assert parent_cond_skel.fromDB(cond_skel["parent_code"]["dest"]["key"])
+                assert parent_cond_skel.read(cond_skel["parent_code"]["dest"]["key"])
                 yield parent_cond_skel
                 # yield cond_skel["parent_code"]["dest"]
             else:
@@ -202,7 +202,7 @@ def mark_discount_used(order_skel, payment):
 
         for discount in discounts:
             d_skel = self.shop.discount.viewSkel()
-            d_skel.fromDB(discount)
+            d_skel.read(discount)
             for condition in d_skel["condition"]:
                 # TODO: Increase only "active" conditions in case of OR operator
                 # cond_skel = toolkit.get_full_skel_from_ref_skel(condition["dest"])