From c0a4e1c04df97bc517c2facdb345dc5f3bb3a8f3 Mon Sep 17 00:00:00 2001 From: szeka9 Date: Sun, 3 May 2026 12:57:31 +0200 Subject: [PATCH 1/3] Wildcard URL support, update examples Support wildcard URLs with placeholder segments in the URL path. This allows more versatile applications and reduced code duplication. Update example application to include most common use cases. Set demo_app as the default in Makefile. --- Makefile | 2 +- assets/www/examples.html | 103 ++++++++++++++++++++++++--------- docs/setup.md | 4 +- example/demo_app/app.py | 54 ++++++++++++----- src/pyrobusta/protocol/http.py | 37 +++++++++++- tests/unit/test_http.py | 22 +++++++ 6 files changed, 177 insertions(+), 45 deletions(-) diff --git a/Makefile b/Makefile index 016ada9..a7bea0c 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ DEVICE ?= u0 SRC_DIR := src TEST_DIR := tests -EXAMPLE_DIR := example/mip_repo +EXAMPLE_DIR := example/demo_app BUILD_DIR := build DIST_DIR := dist TLS_DIR := tls diff --git a/assets/www/examples.html b/assets/www/examples.html index 95a1a4d..1323a79 100644 --- a/assets/www/examples.html +++ b/assets/www/examples.html @@ -64,44 +64,77 @@

Server configuration

-

Simple Server Application

-

The below example demonstrates how to set up a simple application, exposed at /app.

-

Use curl to test your application.

-
diff --git a/docs/setup.md b/docs/setup.md index 99df216..6f8f833 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,6 +1,6 @@ # Device Setup -Use [mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) command-line tool to access your device over a serial connection.\ +Use [mpremote](https://docs.micropython.org/en/latest/reference/mpremote.html) to access your device over a serial connection.\ You can install mpremote via pip. It is also included in the project's requirements.txt ```bash @@ -22,7 +22,7 @@ Type "help()" for more information. # Connect to Wi-Fi -During the initial setup, you’ll need to connect your device to a Wi-Fi network in order to install PyRobusta using the mip tool.\ +During the initial setup, you’ll need to connect your device to a Wi-Fi network in order to install PyRobusta using the mip package manager.\ After connecting to your device with mpremote, run the following script: ```python diff --git a/example/demo_app/app.py b/example/demo_app/app.py index 937b89f..4e605fa 100644 --- a/example/demo_app/app.py +++ b/example/demo_app/app.py @@ -1,26 +1,54 @@ import asyncio -from gc import mem_free, mem_alloc from pyrobusta.server import http_server from pyrobusta.protocol.http import HttpEngine +from pyrobusta.utils.config import PYROBUSTA_VERSION +APP_VERSION = "v0.0.1" -@HttpEngine.route("/app", "GET") -def app(http_ctx, payload): - free = mem_free() - value_format = "bytes" + +@HttpEngine.route("/version", "GET") +def version(http_ctx, _): + include_server_version = False if http_ctx.query: - value_format = http_ctx.get_url_encoded_query_param( - http_ctx.query, "format", default="bytes" - ) - if value_format not in ("%", "bytes"): - raise ValueError("invalid format") + is_detailed = http_ctx.get_url_encoded_query_param( + http_ctx.query, "detailed", default="false" + ).lower() + + if is_detailed not in ("true", "false"): + http_ctx.terminate(400, True) + return "text/plain", "Invalid query" + + include_server_version = is_detailed.lower() == "true" + + if http_ctx.headers.get("accept") == "application/json": + version_dict = {"app_version": APP_VERSION} + if include_server_version: + version_dict["server_version"] = PYROBUSTA_VERSION + return "application/json", version_dict + + version_text = f"app_version: {APP_VERSION}\n" + if include_server_version: + version_text += f"server_version: {PYROBUSTA_VERSION}\n" + return "text/plain", version_text + + +@HttpEngine.route("/{app_or_server}/version", "GET") +def version(http_ctx, _): + include_server_version = False + resource = http_ctx.url.split(b"/")[1] + + if resource not in (b"app", b"server"): + http_ctx.terminate(404, True) + return "text/plain", "Not found" + + version_string = APP_VERSION if resource == b"app" else PYROBUSTA_VERSION - if value_format == "%": - free = round(100 * free / (free + mem_alloc()), 2) + if http_ctx.headers.get("accept") == "application/json": + return "application/json", {"version": version_string} - return "text/plain", f"Free memory [{value_format}]: {free}\n" + return "text/plain", f"{version_string}\n" async def main(): diff --git a/src/pyrobusta/protocol/http.py b/src/pyrobusta/protocol/http.py index ccf4e2b..f9d31c3 100644 --- a/src/pyrobusta/protocol/http.py +++ b/src/pyrobusta/protocol/http.py @@ -237,6 +237,39 @@ def is_norm_path_served(cls, path: str): return True return False + @staticmethod + def _is_matching_url_path(path: bytes, pattern: bytes) -> bool: + """ + Match a URL path against a pattern that can contain wildcard segments + e.g. /path/{wildcard}/resource where {wildcard} matches any non-empty + string in that segment. + """ + if path == pattern: + return True + i = j = 0 + n, m = len(path), len(pattern) + while i < n and j < m: + # Find next segment boundaries + ni = path.find(b"/", i) + nj = pattern.find(b"/", j) + if ni == -1: + ni = n + if nj == -1: + nj = m + path_seg = path[i:ni] + pat_seg = pattern[j:nj] + if path_seg != pat_seg: + if not ( + len(pat_seg) >= 2 + and pat_seg[0] == 123 # { + and pat_seg[-1] == 125 # } + and len(path_seg) > 0 + ): + return False + i = ni + 1 + j = nj + 1 + return i >= n and j >= m + @staticmethod def _lookup(tuple_, key): idx = tuple_.index(key) @@ -245,13 +278,13 @@ def _lookup(tuple_, key): @classmethod def _get_callback(cls, endpoint, method: bytes): for e in cls.ENDPOINTS: - if endpoint == e[0] and method == e[2]: + if cls._is_matching_url_path(endpoint, e[0]) and method == e[2]: return e[1] @classmethod def _has_endpoint(cls, endpoint: bytes): for e in cls.ENDPOINTS: - if endpoint == e[0]: + if cls._is_matching_url_path(endpoint, e[0]): return True return False diff --git a/tests/unit/test_http.py b/tests/unit/test_http.py index 96be22d..9f83a1a 100644 --- a/tests/unit/test_http.py +++ b/tests/unit/test_http.py @@ -366,6 +366,28 @@ def test_overlapping_url_encoded_query_parameter(self): "value3", ) + def test_url_path_matching(self): + for case in ( + (b"", b""), + (b"/", b"/"), + (b"///", b"///"), + (b"/path/to/resource", b"/path/to/resource"), + (b"/path/to/specific/resource", b"/path/to/{wildcard}/resource"), + (b"anything", b"{wildcard}"), + (b"path/to/resource", b"path/to/{wildcard}"), + ): + self.assertEqual(self.engine._is_matching_url_path(case[0], case[1]), True) + + def test_url_path_matching_mismatch(self): + for case in ( + (b"", b"/"), + (b"", b"{wildcard}"), + (b"/path/to/resource/subresource", b"/path/to/resource"), + (b"/path/to/", b"/path/to/{wildcard}"), + (b"/to/resource", b"{wildcard}/to/resource"), + ): + self.assertEqual(self.engine._is_matching_url_path(case[0], case[1]), False) + def test_chunked_transfer_encoding_valid(self): self.engine.url = b"/api/test" self.engine.method = b"GET" From 3bbc3be0a477ea74246ea00a855bdc81afd3f01c Mon Sep 17 00:00:00 2001 From: szeka9 Date: Mon, 4 May 2026 21:07:19 +0200 Subject: [PATCH 2/3] Fix response generation for empty requests Exception is raised on empty requests due to invalid comparison of initial parser state. The comparison fails when the state machine is already terminated. Instead, use a new member variable for indicating if the state machine received any data.. --- src/pyrobusta/bindings/http_connection.py | 2 +- src/pyrobusta/protocol/http.py | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/pyrobusta/bindings/http_connection.py b/src/pyrobusta/bindings/http_connection.py index 0d9b79f..ece96aa 100644 --- a/src/pyrobusta/bindings/http_connection.py +++ b/src/pyrobusta/bindings/http_connection.py @@ -88,7 +88,7 @@ async def _run_state_machine(self): await sleep_ms(self.STATE_MACHINE_SLEEP_MS) # [3] write response - if self._engine.is_started() and self._engine.is_terminated(): + if not self._engine.is_request_empty() and self._engine.is_terminated(): self._engine.write_response_head(self._send_buf) await self._flush_response() if self._engine.resp_handler is not None: diff --git a/src/pyrobusta/protocol/http.py b/src/pyrobusta/protocol/http.py index f9d31c3..d369f06 100644 --- a/src/pyrobusta/protocol/http.py +++ b/src/pyrobusta/protocol/http.py @@ -62,6 +62,7 @@ class HttpEngine: "query", "content_len_cnt", "recv_chunk_size", + "is_req_empty", "mp_boundary", "mp_is_first", "mp_is_last", @@ -120,6 +121,7 @@ def __init__(self): self.query = None self.content_len_cnt = 0 self.recv_chunk_size = 0 + self.is_req_empty = True # [Multipart state] self.mp_boundary = None @@ -140,6 +142,7 @@ def reset(self): self.query = None self.content_len_cnt = 0 self.recv_chunk_size = 0 + self.is_req_empty = True self.mp_boundary = None # ========================================= @@ -499,11 +502,11 @@ def abort(self, status_code: int): self.resp_handler = None self.terminate(status_code, False) - def is_started(self): + def is_request_empty(self): """ - Returns true if the state machine has received any input. + Returns false if the state machine has received any input. """ - return self.state != self._start_parser # pylint: disable=W0143 + return self.is_req_empty def is_terminated(self): """ @@ -571,6 +574,7 @@ def _start_parser(self, rx): Initial state. """ if rx.size(): + self.is_req_empty = False self.state = self._parse_request_line_st def _parse_request_line_st(self, rx): From d4709bb69e5178a9c2c4b1fb45e987b5a075b4e6 Mon Sep 17 00:00:00 2001 From: szeka9 Date: Mon, 4 May 2026 21:28:21 +0200 Subject: [PATCH 3/3] Move path normalization helper to file server module is_norm_path_served() is only used in the context of the file server module. --- src/pyrobusta/protocol/http.py | 16 ---------------- src/pyrobusta/protocol/http_file_server.py | 21 +++++++++++++++++++++ tests/unit/test_http.py | 2 +- 3 files changed, 22 insertions(+), 17 deletions(-) diff --git a/src/pyrobusta/protocol/http.py b/src/pyrobusta/protocol/http.py index d369f06..21e6486 100644 --- a/src/pyrobusta/protocol/http.py +++ b/src/pyrobusta/protocol/http.py @@ -8,7 +8,6 @@ from ..utils.config import ( get_config, - CONF_HTTP_SERVED_PATHS, CONF_HTTP_MULTIPART, CONF_HTTP_SERVE_FILES, ) @@ -225,21 +224,6 @@ def get_url_encoded_query_param(query: str, key: str, default: str = None): return query[idx_start + len(key) + 1 : idx_end] return query[idx_start + len(key) + 1 :] - @classmethod - def is_norm_path_served(cls, path: str): - """ - Returns true if a normalized path is configured to be served. - """ - served_paths = get_config(CONF_HTTP_SERVED_PATHS) - parts = path.split("/") - for i, _ in enumerate(parts): - current_path = "/".join(parts[: i + 1]) - if not current_path: - current_path = "/" - if current_path in served_paths: - return True - return False - @staticmethod def _is_matching_url_path(path: bytes, pattern: bytes) -> bool: """ diff --git a/src/pyrobusta/protocol/http_file_server.py b/src/pyrobusta/protocol/http_file_server.py index a8c278b..767fb5e 100644 --- a/src/pyrobusta/protocol/http_file_server.py +++ b/src/pyrobusta/protocol/http_file_server.py @@ -9,6 +9,11 @@ from pyrobusta.protocol import http from pyrobusta.utils.helpers import normalize_path, add_method +from ..utils.config import ( + get_config, + CONF_HTTP_SERVED_PATHS, +) + CONTENT_TYPES = ( b"raw", b"application/octet-stream", @@ -35,6 +40,21 @@ ) +def is_norm_path_served(path: str): + """ + Returns true if a normalized path is configured to be served. + """ + served_paths = get_config(CONF_HTTP_SERVED_PATHS) + parts = path.split("/") + for i, _ in enumerate(parts): + current_path = "/".join(parts[: i + 1]) + if not current_path: + current_path = "/" + if current_path in served_paths: + return True + return False + + def _send_file_st(self, _, file_path: bytes): """ State for returning a file. By default, /www is prepended to the path. @@ -85,3 +105,4 @@ def apply_patches(): """ add_method(http.HttpEngine, _send_file_st) + add_method(http.HttpEngine, is_norm_path_served, "static") diff --git a/tests/unit/test_http.py b/tests/unit/test_http.py index 9f83a1a..aa39e43 100644 --- a/tests/unit/test_http.py +++ b/tests/unit/test_http.py @@ -462,7 +462,7 @@ class TestWebHelpers(TestWebStateMachineBase): @classmethod def setUpClass(cls): - cls.base_config = {"http_multipart": "False", "http_serve_files": "False"} + cls.base_config = {"http_multipart": "False", "http_serve_files": "True"} # Simplify file-open assertions by treating resources # as if they are installed at the root (/) rather than # relative to the current working directory.