Move decompress_7z_base64_data to rust (#723)

* Move decompress_7z_base64_data to rust

* Add error handling

* go on

* Fix setup

* Fix typing

* fix pylint

* Enable renovate for rust

Author: edenhaus

.devcontainer.json

@@ -44,14 +44,15 @@
   },
   // Add the IDs of extensions you want installed when the container is created.
   "features": {
-    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/devcontainers/features/rust:1": {}
   },
   "image": "mcr.microsoft.com/devcontainers/base:debian",
   "name": "Deebot client",
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   // "forwardPorts": [],
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "curl -LsSf https://astral.sh/uv/install.sh | sh && uv sync --frozen --dev && pre-commit install",
+  "postCreateCommand": "scripts/setup.sh",
   "postStartCommand": "uv sync --dev",
   "remoteEnv": {
     "PATH": "/home/vscode/.local/bin:/home/vscode/.cargo/bin:/workspaces/client.py/.venv/bin:${containerEnv:PATH}"

.github/renovate.json

@@ -21,6 +21,10 @@
       "addLabels": ["github_actions"],
       "matchManagers": ["github-actions"],
       "rangeStrategy": "pin"
+    },
+    {
+      "addLabels": ["rust"],
+      "matchManagers": ["cargo"]
     }
   ],
   "rebaseWhen": "behind-base-branch"

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         run: uv run --frozen mypy deebot_client/
 
       - name: Pylint review
-        run: uv run --frozen pylint deebot_client/
+        run: uv run --frozen pylint deebot_client/**/*.py
 
       - name: Verify no getLogger usages
         run: scripts/check_getLogger.sh

.github/workflows/python-publish.yml

@@ -32,6 +32,7 @@ jobs:
       - name: 🏗 Set package version
         run: |
           sed -i "s/^version = \".*\"/version = \"${{ github.event.release.tag_name }}\"/" pyproject.toml
+          sed -i "s/^version = \".*\"/version = \"${{ github.event.release.tag_name }}\"/" cargo.toml
       - name: 📦 Build package
         run: uv build
       - name: 🚀 Publish to PyPi

.gitignore

@@ -21,4 +21,9 @@ nosetests.xml
 .*_cache
 
 test.py
-.env
+.env
+
+/target
+
+# rust so
+*.cpython*.so

Cargo.lock

@@ -0,0 +1,15 @@
+[package]
+name = "deebot_client"
+version = "0.0.0"
+edition = "2021"
+authors = ["Robert Resch <robert@resch.dev>"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "deebot_client"
+crate-type = ["cdylib"]
+
+[dependencies]
+base64 = "0.22.1"
+pyo3 = "0.23.3"
+rust-lzma = "0.6.0"

Cargo.toml

@@ -18,7 +18,7 @@
 from deebot_client.events.map import CachedMapInfoEvent
 from deebot_client.logging_filter import get_logger
 from deebot_client.message import HandlingResult, HandlingState, MessageBodyDataDict
-from deebot_client.util import decompress_7z_base64_data
+from deebot_client.rs import decompress_7z_base64_data
 
 from .common import JsonCommandWithMessageHandling
 
@@ -275,7 +275,7 @@ def _handle_body_data_dict(
             # This command is used by new and old bots
             if data.get("compress", 0) == 1:
                 # Newer bot's return coordinates as base64 decoded string
-                coordinates = decompress_7z_base64_data(data["value"]).decode()
+                coordinates = decompress_7z_base64_data(data["value"])
             else:
                 # Older bot's return coordinates direct as comma/semicolon separated list
                 coordinates = data["value"]
@@ -305,7 +305,7 @@ def _get_subset_ids(
     ) -> list[int] | None:
         """Return subset ids."""
         # subset is based64 7z compressed
-        subsets = json.loads(decompress_7z_base64_data(data["subsets"]).decode())
+        subsets = json.loads(decompress_7z_base64_data(data["subsets"]))
 
         match data["type"]:
             case MapSetType.ROOMS:

deebot_client/commands/json/map.py

@@ -35,10 +35,12 @@
 from .exceptions import MapError
 from .logging_filter import get_logger
 from .models import Room
+from .rs import (
+    decompress_7z_base64_data,
+)
 from .util import (
     OnChangedDict,
     OnChangedList,
-    decompress_7z_base64_data,
 )
 
 if TYPE_CHECKING:
@@ -393,7 +395,7 @@ async def on_map_subset(event: MapSubsetEvent) -> None:
 
     def _update_trace_points(self, data: str) -> None:
         _LOGGER.debug("[_update_trace_points] Begin")
-        trace_points = decompress_7z_base64_data(data)
+        trace_points = decompress_7z_base64_data(data).encode()
 
         for i in range(0, len(trace_points), 5):
             position_x, position_y = struct.unpack("<hh", trace_points[i : i + 4])
@@ -620,7 +622,7 @@ def image(self) -> Image.Image:
 
     def update_points(self, base64_data: str) -> None:
         """Add map piece points."""
-        decoded = decompress_7z_base64_data(base64_data)
+        decoded = decompress_7z_base64_data(base64_data).encode()
         old_crc32 = self._crc32
         self._crc32 = zlib.crc32(decoded)
 

deebot_client/map.py

@@ -0,0 +1,2 @@
+def decompress_7z_base64_data(value: str) -> str:
+    """Decompress base64 decoded 7z compressed string."""