Enhancement: Add logging on api endpoints

mytoyota/api.py

@@ -1,8 +1,10 @@
 """Toyota Connected Services API."""
 
+import logging
 from datetime import date, datetime, timezone
 from uuid import uuid4
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.const import (
     VEHICLE_ASSOCIATION_ENDPOINT,
     VEHICLE_GLOBAL_REMOTE_ELECTRIC_STATUS_ENDPOINT,
@@ -24,6 +26,8 @@
 from mytoyota.models.endpoints.vehicle_guid import VehiclesResponseModel
 from mytoyota.models.endpoints.vehicle_health import VehicleHealthResponseModel
 
+_LOGGER: logging.Logger = logging.getLogger(__name__)
+
 
 class Api:
     """API Class. Allows access to available endpoints to retrieve the raw data."""
@@ -72,7 +76,11 @@
 
     async def get_vehicles_endpoint(self) -> VehiclesResponseModel:
         """Return list of vehicles registered with provider."""
-        return await self._request_and_parse(VehiclesResponseModel, "GET", VEHICLE_GUID_ENDPOINT)
+        parsed_response = await self._request_and_parse(
+            VehiclesResponseModel, "GET", VEHICLE_GUID_ENDPOINT
+        )
+        _LOGGER.debug(msg=f"Parsed 'VehiclesResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_location_endpoint(self, vin: str) -> LocationResponseModel:
         """Get the last known location of your car. Only updates when car is parked.
@@ -87,9 +95,11 @@
         -------
             LocationResponseModel: A pydantic model for the location response
         """
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             LocationResponseModel, "GET", VEHICLE_LOCATION_ENDPOINT, vin=vin
         )
+        _LOGGER.debug(msg=f"Parsed 'LocationResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_vehicle_health_status_endpoint(self, vin: str) -> VehicleHealthResponseModel:
         r"""Get the latest health status.
@@ -105,18 +115,22 @@
         -------
             VehicleHealthResponseModel: A pydantic model for the vehicle health response
         """
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             VehicleHealthResponseModel, "GET", VEHICLE_HEALTH_STATUS_ENDPOINT, vin=vin
         )
+        _LOGGER.debug(msg=f"Parsed 'VehicleHealthResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_remote_status_endpoint(self, vin: str) -> RemoteStatusResponseModel:
         """Get information about the vehicle."""
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             RemoteStatusResponseModel,
             "GET",
             VEHICLE_GLOBAL_REMOTE_STATUS_ENDPOINT,
             vin=vin,
         )
+        _LOGGER.debug(msg=f"Parsed 'RemoteStatusResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_vehicle_electric_status_endpoint(self, vin: str) -> ElectricResponseModel:
         r"""Get the latest electric status.
@@ -132,12 +146,14 @@
         -------
             ElectricResponseModel: A pydantic model for the electric response
         """
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             ElectricResponseModel,
             "GET",
             VEHICLE_GLOBAL_REMOTE_ELECTRIC_STATUS_ENDPOINT,
             vin=vin,
         )
+        _LOGGER.debug(msg=f"Parsed 'ElectricResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_telemetry_endpoint(self, vin: str) -> TelemetryResponseModel:
         """Get the latest telemetry status.
@@ -152,9 +168,11 @@
         -------
             TelemetryResponseModel: A pydantic model for the telemetry response
         """
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             TelemetryResponseModel, "GET", VEHICLE_TELEMETRY_ENDPOINT, vin=vin
         )
+        _LOGGER.debug(msg=f"Parsed 'TelemetryResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_notification_endpoint(self, vin: str) -> NotificationResponseModel:
         """Get all available notifications for the vehicle.
@@ -171,12 +189,14 @@
         -------
             NotificationResponseModel: A pydantic model for the notification response
         """
-        return await self._request_and_parse(
+        parsed_response = await self._request_and_parse(
             NotificationResponseModel,
             "GET",
             VEHICLE_NOTIFICATION_HISTORY_ENDPOINT,
             vin=vin,
         )
+        _LOGGER.debug(msg=f"Parsed 'NotificationResponseModel': {parsed_response}")
+        return parsed_response
 
     async def get_trips_endpoint(  # noqa: PLR0913
         self,
@@ -217,4 +237,8 @@
             limit=limit,
             offset=offset,
         )
-        return await self._request_and_parse(TripsResponseModel, "GET", endpoint, vin=vin)
+        parsed_response = await self._request_and_parse(
+            TripsResponseModel, "GET", endpoint, vin=vin
+        )
+        _LOGGER.debug(msg=f"Parsed 'TripsResponseModel': {parsed_response}")
+        return parsed_response

mytoyota/client.py

@@ -11,13 +11,14 @@
 import logging
 from typing import List, Optional
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.api import Api
 from mytoyota.models.vehicle import Vehicle
 
 from .controller import Controller
 from .exceptions import ToyotaInvalidUsernameError
 
-_LOGGER: logging.Logger = logging.getLogger(__package__)
+_LOGGER: logging.Logger = logging.getLogger(__name__)
 
 
 class MyT:

mytoyota/controller.py

@@ -11,16 +11,17 @@
 import httpx
 import jwt
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.const import (
     ACCESS_TOKEN_URL,
     API_BASE_URL,
     AUTHENTICATE_URL,
     AUTHORIZE_URL,
 )
 from mytoyota.exceptions import ToyotaApiError, ToyotaInternalError, ToyotaLoginError
-from mytoyota.utils.logs import format_httpx_response
+from mytoyota.utils.logging.log_utils import format_httpx_response
 
-_LOGGER: logging.Logger = logging.getLogger(__package__)
+_LOGGER: logging.Logger = logging.getLogger(__name__)
 
 CACHE_FILENAME: Path = Path.home() / ".cache" / "toyota_credentials_cache_contains_secrets"
 

mytoyota/models/vehicle.py

@@ -11,6 +11,7 @@
 
 from arrow import Arrow
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.api import Api
 from mytoyota.models.dashboard import Dashboard
 from mytoyota.models.endpoints.vehicle_guid import VehicleGuidModel
@@ -20,9 +21,9 @@
 from mytoyota.models.summary import Summary, SummaryType
 from mytoyota.models.trips import Trip
 from mytoyota.utils.helpers import add_with_none
-from mytoyota.utils.logs import censor_all
+from mytoyota.utils.logging.log_utils import censor_all
 
-_LOGGER: logging.Logger = logging.getLogger(__package__)
+_LOGGER: logging.Logger = logging.getLogger(__name__)
 
 
 class Vehicle:

mytoyota/statistics.py

@@ -4,6 +4,7 @@
 import arrow
 from arrow import Arrow
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.const import (
     BUCKET,
     DATA,
@@ -29,7 +30,7 @@
     convert_to_mpg,
 )
 
-_LOGGER: logging.Logger = logging.getLogger(__package__)
+_LOGGER: logging.Logger = logging.getLogger(__name__)
 
 
 class Statistics:

mytoyota/utils/conversions.py

@@ -1,7 +1,9 @@
 """Conversion utilities used."""
 import logging
 
-_LOGGER: logging.Logger = logging.getLogger(__package__)
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
+
+_LOGGER: logging.Logger = logging.getLogger(__name__)
 
 
 def convert_to_miles(kilometers: float) -> float:

mytoyota/utils/logging/log_config.yaml

@@ -0,0 +1,33 @@
+version: 1
+disable_existing_loggers: False
+
+formatters:
+  simple:
+    format: "%(asctime)s %(levelname)s %(message)s"
+    datefmt: "%Y-%m-%d %H:%M:%S"
+
+handlers:
+  file:
+    class: "logging.FileHandler"
+    formatter: "simple"
+    filename: ".log"
+    mode: "w"
+    filters:
+      - "logfilter"
+
+filters:
+  logfilter:
+    (): mytoyota.utils.logging.log_filters.RedactingFilter
+    patterns:
+      - 'access_token\":\s*\"([^\"]*)'
+      - 'id_token\":\s*\"([^\"]*)'
+      - 'subscriberGuid\":\s*\"([^\"]*)'
+      - 'contractId\":\s*\"([^\"]*)'
+      - 'vin\":\s*\"([^\"]*)'
+      - 'euiccid\":\s*\"([^\"]*)'
+      - "guid':\\s*'([^']*)"
+
+root:
+  level: "DEBUG"
+  handlers:
+    - "file"

mytoyota/utils/logging/log_filters.py

@@ -0,0 +1,24 @@
+"""Module with filter log filter classes."""
+import logging
+import re
+
+
+class RedactingFilter(logging.Filter):
+    """Helper class to filter logs by given pattern via 'logging.Filter'."""
+
+    def __init__(self, patterns):
+        """Initialise RedactingFilter class."""
+        super(RedactingFilter, self).__init__()
+        self._patterns = patterns
+
+    def filter(self, record):
+        """Modify the log record to mask sensitive data."""
+        record.msg = self.mask_sensitive_data(record.msg)
+        return True
+
+    def mask_sensitive_data(self, msg):
+        """Mask sensitive data in logs by given patterns."""
+        for pattern in self._patterns:
+            compiled_pattern = re.compile(pattern)
+            msg = compiled_pattern.sub("****", msg)
+        return msg

mytoyota/utils/logging/logging_config.py

@@ -0,0 +1,13 @@
+"""Load a central config for logging."""
+import logging
+import logging.config
+from pathlib import Path
+
+import yaml
+
+BASE_DIR = Path(__file__).parent
+
+with open(file=BASE_DIR / "log_config.yaml", mode="r", encoding="utf-8") as config:
+    config_dict = yaml.safe_load(config)
+
+logging.config.dictConfig(config_dict)

simple_client_example.py

@@ -1,13 +1,16 @@
 """Simple test of new API Changes."""
 import asyncio
 import json
+import logging
 import pprint
 from datetime import date, timedelta
 
+import mytoyota.utils.logging.logging_config  # noqa # pylint: disable=unused-import
 from mytoyota.client import MyT
 from mytoyota.models.summary import SummaryType
 
 pp = pprint.PrettyPrinter(indent=4)
+logger = logging.getLogger(__name__)
 
 # Set your username and password in a file on top level called "credentials.json" in the format:
 #   {

tests/test_utils/test_logs.py

@@ -2,7 +2,7 @@
 import pytest
 from httpx import Request, Response
 
-from mytoyota.utils.logs import (
+from mytoyota.utils.logging.log_utils import (
     censor_all,
     censor_string,
     censor_value,