mmrelay 1.2.2__tar.gz → 1.2.4__tar.gz

{mmrelay-1.2.2/src/mmrelay.egg-info → mmrelay-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mmrelay
-Version: 1.2.2
+Version: 1.2.4
 Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
 Home-page: https://github.com/jeremiah-k/meshtastic-matrix-relay
 Author: Geoff Whittington, Jeremiah K., and contributors
@@ -18,7 +18,7 @@ Classifier: Topic :: Communications
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: meshtastic>=2.6.4
+Requires-Dist: meshtastic>=2.7.3
 Requires-Dist: Pillow==11.3.0
 Requires-Dist: matrix-nio==0.25.2
 Requires-Dist: matplotlib==3.10.1

{mmrelay-1.2.2 → mmrelay-1.2.4}/requirements.txt

@@ -1,4 +1,4 @@
-meshtastic>=2.6.4
+meshtastic>=2.7.3
 Pillow==11.3.0
 matrix-nio==0.25.2
 matplotlib==3.10.1
@@ -16,7 +16,7 @@ setuptools>=80.9.0  # Required for console script entry points and Windows compa
 # Testing and coverage
 coverage==7.10.7
 pytest==8.4.2
-pytest-cov==6.3.0
+pytest-cov==7.0.0
 pytest-asyncio==1.2.0
 pytest-env==1.1.5
 pytest-timeout==2.4.0

{mmrelay-1.2.2 → mmrelay-1.2.4}/setup.py

@@ -44,7 +44,7 @@ setup(
     ],
     python_requires=">=3.9",
     install_requires=[
-        "meshtastic>=2.6.4",
+        "meshtastic>=2.7.3",
         "Pillow==11.3.0",
         "matrix-nio==0.25.2",
         "matplotlib==3.10.1",

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/__init__.py

@@ -2,4 +2,4 @@
 Meshtastic Matrix Relay - Bridge between Meshtastic mesh networks and Matrix chat rooms.
 """
 
-__version__ = "1.2.2"
+__version__ = "1.2.4"

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/cli.py

@@ -238,11 +238,11 @@ def print_version():
 def _validate_e2ee_dependencies():
     """
     Check whether end-to-end encryption (E2EE) is usable on the current platform.
-    
+
     Returns:
         bool: True if the platform is supported and required E2EE libraries can be imported;
         False otherwise.
-    
+
     Notes:
         - This function performs only local checks (platform and importability) and does not perform
           network I/O.
@@ -1499,13 +1499,13 @@ def handle_auth_logout(args):
 def handle_service_command(args):
     """
     Dispatch service-related subcommands.
-    
+
     Currently supports the "install" subcommand which imports and runs mmrelay.setup_utils.install_service().
     Returns 0 on successful installation, 1 on failure or for unknown subcommands.
-    
+
     Parameters:
         args: argparse.Namespace with a `service_command` attribute indicating the requested action.
-    
+
     Returns:
         int: Exit code (0 on success, 1 on error).
     """
@@ -1524,15 +1524,15 @@ def handle_service_command(args):
 
 def _diagnose_config_paths(args):
     """
-    Print a diagnostic summary of resolved configuration file search paths and their directory accessibility.
-    
-    Uses get_config_paths(args) to compute the ordered list of candidate config file locations, then prints each path with a concise directory status icon:
+    Prints a diagnostic summary of resolved configuration file search paths and their directory accessibility.
+
+    Each candidate config path is printed with a status icon:
     - ✅ directory exists and is writable
     - ⚠️ directory exists but is not writable
     - ❌ directory does not exist
-    
+
     Parameters:
-        args (argparse.Namespace): Parsed CLI arguments used to determine the config search order.
+        args (argparse.Namespace): CLI arguments used to determine the ordered list of candidate config paths (passed to get_config_paths).
     """
     print("1. Testing configuration paths...")
     from mmrelay.config import get_config_paths
@@ -1551,11 +1551,11 @@ def _diagnose_config_paths(args):
 def _diagnose_sample_config_accessibility():
     """
     Check availability of the bundled sample configuration and print a short diagnostic.
-    
+
     Performs two non-destructive checks and prints human-readable results:
     1) Verifies whether the sample config file exists at the path returned by mmrelay.tools.get_sample_config_path().
     2) Attempts to read the embedded resource "sample_config.yaml" from the mmrelay.tools package via importlib.resources and reports success and the content length.
-    
+
     Returns:
         bool: True if a filesystem sample config exists at the resolved path; False otherwise.
     """
@@ -1586,18 +1586,15 @@ def _diagnose_sample_config_accessibility():
 
 def _diagnose_platform_specific(args):
     """
-    Run platform-specific diagnostic checks.
-    
-    On Windows, imports and runs Windows-specific requirement checks and a configuration-generation
-    test from mmrelay.windows_utils, printing per-component results and any warnings. On non-Windows
-    platforms this reports that platform-specific tests are not required.
-    
+    Run platform-specific diagnostic checks and print a concise report.
+
+    On Windows, executes Windows-specific requirement checks and a configuration-generation test using the provided CLI arguments; on non-Windows platforms, reports that platform-specific tests are not required.
+
     Parameters:
-        args (argparse.Namespace): Parsed CLI arguments; passed through to the Windows
-            config-generation test when running on Windows.
-    
+        args (argparse.Namespace): CLI arguments forwarded to the Windows configuration-generation test (used only when running on Windows).
+
     Returns:
-        bool: True if the platform is Windows (Windows checks were executed), False otherwise.
+        bool: `True` if Windows checks were executed (running on Windows), `False` otherwise.
     """
     print("3. Platform-specific diagnostics...")
     import sys
@@ -1704,7 +1701,7 @@ logging:
 def _diagnose_minimal_config_template():
     """
     Validate the built-in minimal YAML configuration template and print a concise pass/fail status.
-    
+
     Attempts to parse the string returned by _get_minimal_config_template() using yaml.safe_load. Prints a single-line result showing a ✅ with the template character length when the template is valid YAML, or a ❌ with the YAML parsing error when invalid. This is a non-destructive diagnostic helper that prints output and does not return a value.
     """
     print("4. Testing minimal config template fallback...")
@@ -1720,15 +1717,15 @@ def _diagnose_minimal_config_template():
 
 def handle_config_diagnose(args):
     """
-    Run non-destructive diagnostics for the MMRelay configuration subsystem and print a human-readable report.
-    
-    Performs four checks: resolves candidate config paths and reports directory accessibility; verifies packaged sample config availability (filesystem and importlib.resources fallback); runs platform-specific diagnostics (Windows-focused where applicable); and validates the built-in minimal YAML template. Prints findings and suggested next steps to stdout/stderr.
-    
+    Run a set of non-destructive diagnostics for the MMRelay configuration subsystem and print a concise, human-readable report.
+
+    Performs four checks without modifying user files: (1) resolves and reports candidate configuration file paths and their directory accessibility, (2) verifies availability and readability of the packaged sample configuration, (3) executes platform-specific diagnostics (Windows checks when applicable), and (4) validates the built-in minimal YAML configuration template. Results and actionable guidance are written to stdout/stderr; additional Windows-specific guidance may be printed to stderr on unexpected failures.
+
     Parameters:
-        args (argparse.Namespace): Parsed CLI arguments used to resolve config search paths and to control platform-specific checks.
-    
+        args (argparse.Namespace): Parsed CLI arguments used to determine configuration search paths and to control platform-specific diagnostic behavior.
+
     Returns:
-        int: Exit code (0 on success, 1 on failure).
+        int: Exit code where `0` indicates diagnostics completed successfully and `1` indicates a failure occurred (an error summary is printed to stderr).
     """
     print("MMRelay Configuration System Diagnostics")
     print("=" * 40)

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/config.py

@@ -196,14 +196,12 @@ def get_log_dir():
 
 def get_e2ee_store_dir():
     """
-    Return the absolute path to the E2EE data store directory, creating it if missing.
-    
-    On Linux and macOS this is "<base_dir>/store" where base_dir is returned by get_base_dir().
-    On Windows this is "<custom_data_dir>/store" when module-level custom_data_dir is set; otherwise it uses
-    platformdirs.user_data_dir(APP_NAME, APP_AUTHOR)/store.
-    
+    Get the absolute path to the application's end-to-end encryption (E2EE) data store directory, creating it if necessary.
+
+    On Linux and macOS the directory is located under the application base directory; on Windows it uses the configured custom data directory when set, otherwise the platform-specific user data directory. The directory will be created if it does not exist.
+
     Returns:
-        str: Absolute path to the ensured store directory. The directory is created if it does not exist.
+        store_dir (str): Absolute path to the ensured E2EE store directory.
     """
     if sys.platform in ["linux", "darwin"]:
         # Use ~/.mmrelay/store/ for Linux and Mac
@@ -388,12 +386,12 @@ def is_e2ee_enabled(config):
 def check_e2ee_enabled_silently(args=None):
     """
     Check silently whether End-to-End Encryption (E2EE) is enabled in the first readable configuration file.
-    
+
     Searches candidate configuration paths returned by get_config_paths(args) in priority order, loads the first readable YAML file, and returns True if that configuration enables E2EE (via is_e2ee_enabled). I/O and YAML parsing errors are ignored and the function continues to the next candidate. On Windows this always returns False.
-    
+
     Parameters:
         args (optional): Parsed command-line arguments that can influence config search order.
-    
+
     Returns:
         bool: True if E2EE is enabled in the first valid configuration file found; otherwise False.
     """
@@ -493,16 +491,16 @@ def load_credentials():
 def save_credentials(credentials):
     """
     Persist a JSON-serializable credentials mapping to <base_dir>/credentials.json.
-    
+
     Writes the provided credentials (a JSON-serializable mapping) to the application's
     base configuration directory as credentials.json, creating the base directory if
     necessary. On Unix-like systems the file permissions are adjusted to be
     restrictive (0o600) when possible. I/O and permission errors are caught and
     logged; the function does not raise them.
-    
+
     Parameters:
         credentials (dict): JSON-serializable mapping of credentials to persist.
-    
+
     Returns:
         None
     """
@@ -822,18 +820,18 @@ def load_config(config_file=None, args=None):
 def validate_yaml_syntax(config_content, config_path):
     """
     Validate YAML text for syntax and common style issues, parse it with PyYAML, and return results.
-    
+
     Performs lightweight line-based checks for frequent mistakes (using '=' instead of ':'
     for mappings and non-standard boolean words like 'yes'/'no' or 'on'/'off') and then
     attempts to parse the content with yaml.safe_load. If only style warnings are found,
     parsing is considered successful and warnings are returned; if parsing fails or true
     syntax errors are detected, a detailed error message is returned that references
     config_path to identify the source.
-    
+
     Parameters:
         config_content (str): Raw YAML text to validate.
         config_path (str): Path or label used in error messages to identify the source of the content.
-    
+
     Returns:
         tuple:
             is_valid (bool): True if YAML parsed successfully (style warnings allowed), False on syntax/parsing error.

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/constants/queue.py

@@ -6,7 +6,10 @@ delays, size limits, and water marks for queue management.
 """
 
 # Message timing constants
-DEFAULT_MESSAGE_DELAY = 2.0  # Firmware-enforced minimum delay in seconds
+DEFAULT_MESSAGE_DELAY = (
+    2.5  # Set above the 2.0s firmware limit to prevent message dropping
+)
+MINIMUM_MESSAGE_DELAY = 2.1  # Minimum delay enforced to stay above firmware limit
 
 # Queue size management
 MAX_QUEUE_SIZE = 500

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/e2ee_utils.py

@@ -80,8 +80,13 @@ def get_e2ee_status(
         importlib.import_module("olm")
 
         if os.getenv("MMRELAY_TESTING") != "1":
-            importlib.import_module("nio.crypto").OlmDevice
-            importlib.import_module("nio.store").SqliteStore
+            nio_crypto = importlib.import_module("nio.crypto")
+            if not hasattr(nio_crypto, "OlmDevice"):
+                raise ImportError("nio.crypto.OlmDevice is unavailable")
+
+            nio_store = importlib.import_module("nio.store")
+            if not hasattr(nio_store, "SqliteStore"):
+                raise ImportError("nio.store.SqliteStore is unavailable")
 
         status["dependencies_installed"] = True
     except ImportError:

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/log_utils.py

@@ -69,14 +69,13 @@ _COMPONENT_LOGGERS = {
 
 def configure_component_debug_logging():
     """
-    Configure log levels for external component loggers based on config["logging"]["debug"].
+    Configure log levels and handlers for external component loggers based on config.
 
-    Reads per-component entries under `config["logging"]["debug"]` and applies one of:
-    - falsy or missing: silence the component by setting its loggers to CRITICAL+1
-    - boolean True: enable DEBUG for the component's loggers
-    - string: interpret as a logging level name (case-insensitive); invalid names fall back to DEBUG
+    Reads `config["logging"]["debug"]` and for each component:
+    - If enabled (True or a valid log level string), sets the component's loggers to the specified level and attaches the main application's handlers to them. This makes component logs appear in the console and log file.
+    - If disabled (falsy or missing), silences the component by setting its loggers to a level higher than CRITICAL.
 
-    This function mutates the levels of loggers listed in _COMPONENT_LOGGERS and runs only once per process; no-op if called again or if global `config` is None.
+    This function runs only once. It is not thread-safe and should be called early in the application startup, after the main logger is configured but before other modules are imported.
     """
     global _component_debug_configured, config
 
@@ -84,7 +83,22 @@ def configure_component_debug_logging():
     if _component_debug_configured or config is None:
         return
 
-    debug_config = config.get("logging", {}).get("debug", {})
+    # Get the main application logger and its handlers to attach to component loggers
+    main_logger = logging.getLogger(APP_DISPLAY_NAME)
+    main_handlers = main_logger.handlers
+    debug_settings = config.get("logging", {}).get("debug")
+
+    # Ensure debug_config is a dictionary, handling malformed configs gracefully
+    if isinstance(debug_settings, dict):
+        debug_config = debug_settings
+    else:
+        if debug_settings is not None:
+            main_logger.warning(
+                "Debug logging section is not a dictionary. "
+                "All component debug logging will be disabled. "
+                "Check your config.yaml debug section formatting."
+            )
+        debug_config = {}
 
     for component, loggers in _COMPONENT_LOGGERS.items():
         component_config = debug_config.get(component)
@@ -105,8 +119,15 @@ def configure_component_debug_logging():
                 # Invalid config, fall back to DEBUG
                 log_level = logging.DEBUG
 
+            # Configure all loggers for this component
             for logger_name in loggers:
-                logging.getLogger(logger_name).setLevel(log_level)
+                component_logger = logging.getLogger(logger_name)
+                component_logger.setLevel(log_level)
+                component_logger.propagate = False  # Prevent duplicate logging
+                # Attach main handlers to the component logger
+                for handler in main_handlers:
+                    if handler not in component_logger.handlers:
+                        component_logger.addHandler(handler)
         else:
             # Component debug is disabled - completely suppress external library logging
             # Use a level higher than CRITICAL to effectively disable all messages

{mmrelay-1.2.2 → mmrelay-1.2.4}/src/mmrelay/main.py

@@ -73,9 +73,18 @@ def print_banner():
 
 async def main(config):
     """
-    Coordinates the main asynchronous relay loop between Meshtastic and Matrix clients.
+    Coordinate the asynchronous relay loop between Meshtastic and Matrix clients.
 
-    Initializes the database, loads plugins, starts the message queue, and establishes connections to both Meshtastic and Matrix. Joins configured Matrix rooms, registers event callbacks for message and membership events, and periodically updates node names from the Meshtastic network. Monitors connection health, manages the Matrix sync loop with reconnection and shutdown handling, and ensures graceful shutdown of all components. Optionally wipes the message map on startup and shutdown if configured.
+    Initializes the database and plugins, starts the message queue, connects to Meshtastic and Matrix, joins configured Matrix rooms, registers event callbacks, monitors connection health, runs the Matrix sync loop with automatic retries, and ensures an orderly shutdown of all components (including optional message map wiping on startup and shutdown).
+
+    Parameters:
+        config (dict): Application configuration mapping. Expected keys used by this function include:
+            - "matrix_rooms": list of room dicts with at least an "id" entry,
+            - "meshtastic": optional dict with "message_delay",
+            - "database" (preferred) or legacy "db": optional dict containing "msg_map" with "wipe_on_restart" boolean.
+
+    Raises:
+        ConnectionError: If connecting to Matrix fails and no Matrix client can be obtained.
     """
     # Extract Matrix configuration
     from typing import List
@@ -154,9 +163,9 @@ async def main(config):
 
     async def shutdown():
         """
-        Signal the application to shut down.
-        
-        Sets the Meshtastic shutdown flag and triggers the local shutdown event so tasks waiting on that event can begin shutdown/cleanup. This coroutine only signals shutdown; it does not close clients or perform cleanup itself.
+        Signal the application to begin shutdown.
+
+        Set the Meshtastic shutdown flag and set the local shutdown event so any coroutines waiting on that event can start cleanup.
         """
         matrix_logger.info("Shutdown signal received. Closing down...")
         meshtastic_utils.shutting_down = True  # Set the shutting_down flag