refactor(logging): implement structured logging across modules

stickerdaniel · stickerdaniel · commit b8e13c6aeeed · 2025-07-05T14:28:14.000-04:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,7 +13,16 @@
             "source.organizeImports.ruff": "explicit"
         }
     },
+    "python.defaultInterpreterPath": ".venv/bin/python",
+    "python.terminal.activateEnvironment": true,
     "yaml.schemas": {
         "https://www.schemastore.org/github-issue-config.json": "file:///Users/daniel/Documents/development/python/linkedin-mcp-server/.github/ISSUE_TEMPLATE/config.yml"
     },
+    "cursorpyright.analysis.autoImportCompletions": true,
+    "cursorpyright.analysis.diagnosticMode": "workspace",
+    "cursorpyright.analysis.extraPaths": [
+        "./linkedin_mcp_server"
+    ],
+    "cursorpyright.analysis.stubPath": "./linkedin_mcp_server",
+    "cursorpyright.analysis.typeCheckingMode": "off"
 }
diff --git a/linkedin_mcp_server/config/secrets.py b/linkedin_mcp_server/config/secrets.py
@@ -22,14 +22,14 @@ def get_credentials() -> Dict[str, str]:
 
     # First, try configuration (includes environment variables)
     if config.linkedin.email and config.linkedin.password:
-        print("Using LinkedIn credentials from configuration")
+        logger.info("Using LinkedIn credentials from configuration")
         return {"email": config.linkedin.email, "password": config.linkedin.password}
 
     # Second, try keyring if enabled
     if config.linkedin.use_keyring:
         credentials = get_credentials_from_keyring()
         if credentials["email"] and credentials["password"]:
-            print(f"Using LinkedIn credentials from {get_keyring_name()}")
+            logger.info(f"Using LinkedIn credentials from {get_keyring_name()}")
             return {"email": credentials["email"], "password": credentials["password"]}
 
     # If in non-interactive mode and no credentials found, raise error
@@ -57,9 +57,9 @@ def prompt_for_credentials() -> Dict[str, str]:
 
     # Store credentials securely in keyring
     if save_credentials_to_keyring(credentials["email"], credentials["password"]):
-        print(f"✅ Credentials stored securely in {get_keyring_name()}")
+        logger.info(f"Credentials stored securely in {get_keyring_name()}")
     else:
-        print("⚠️ Warning: Could not store credentials in system keyring.")
-        print("   Your credentials will only be used for this session.")
+        logger.warning("Could not store credentials in system keyring.")
+        logger.info("Your credentials will only be used for this session.")
 
     return credentials
diff --git a/linkedin_mcp_server/drivers/chrome.py b/linkedin_mcp_server/drivers/chrome.py
@@ -5,6 +5,7 @@
 This module handles the creation and management of Chrome WebDriver instances.
 """
 
+import logging
 import os
 import sys
 from typing import Dict, Optional
@@ -34,6 +35,8 @@
 # Global driver storage to reuse sessions
 active_drivers: Dict[str, webdriver.Chrome] = {}
 
+logger = logging.getLogger(__name__)
+
 
 def get_or_create_driver() -> Optional[webdriver.Chrome]:
     """
@@ -55,8 +58,8 @@ def get_or_create_driver() -> Optional[webdriver.Chrome]:
 
     # Set up Chrome options
     chrome_options = Options()
-    print(
-        f"🌐 Running browser in {'headless' if config.chrome.headless else 'visible'} mode"
+    logger.info(
+        f"Running browser in {'headless' if config.chrome.headless else 'visible'} mode"
     )
     if config.chrome.headless:
         chrome_options.add_argument("--headless=new")
@@ -78,22 +81,22 @@ def get_or_create_driver() -> Optional[webdriver.Chrome]:
 
     # Initialize Chrome driver
     try:
-        print("🌐 Initializing Chrome WebDriver...")
+        logger.info("Initializing Chrome WebDriver...")
 
         # Use ChromeDriver path from environment or config
         chromedriver_path = (
             os.environ.get("CHROMEDRIVER_PATH") or config.chrome.chromedriver_path
         )
 
         if chromedriver_path:
-            print(f"🌐 Using ChromeDriver at path: {chromedriver_path}")
+            logger.info(f"Using ChromeDriver at path: {chromedriver_path}")
             service = Service(executable_path=chromedriver_path)
             driver = webdriver.Chrome(service=service, options=chrome_options)
         else:
-            print("🌐 Using auto-detected ChromeDriver")
+            logger.info("Using auto-detected ChromeDriver")
             driver = webdriver.Chrome(options=chrome_options)
 
-        print("✅ Chrome WebDriver initialized successfully")
+        logger.info("Chrome WebDriver initialized successfully")
 
         # Add a page load timeout for safety
         driver.set_page_load_timeout(60)
@@ -103,7 +106,7 @@ def get_or_create_driver() -> Optional[webdriver.Chrome]:
         for attempt in range(max_retries):
             try:
                 if login_to_linkedin(driver):
-                    print("Successfully logged in to LinkedIn")
+                    logger.info("Successfully logged in to LinkedIn")
                     active_drivers[session_id] = driver
                     return driver
             except (
@@ -123,15 +126,18 @@ def get_or_create_driver() -> Optional[webdriver.Chrome]:
                     # In interactive mode, handle the error and potentially retry
                     should_retry = handle_login_error(e)
                     if should_retry and attempt < max_retries - 1:
-                        print(f"🔄 Retry attempt {attempt + 2}/{max_retries}")
+                        logger.info(f"Retry attempt {attempt + 2}/{max_retries}")
                         continue
                     else:
                         # Clean up driver on final failure
                         driver.quit()
                         return None
     except Exception as e:
-        error_msg = f"🛑 Error creating web driver: {e}"
-        print(error_msg)
+        error_msg = f"Error creating web driver: {e}"
+        logger.error(
+            error_msg,
+            extra={"exception_type": type(e).__name__, "exception_message": str(e)},
+        )
 
         if config.chrome.non_interactive:
             raise DriverInitializationError(error_msg)
@@ -169,7 +175,7 @@ def login_to_linkedin(driver: webdriver.Chrome) -> bool:
         raise CredentialsNotFoundError("No credentials available")
 
     # Login to LinkedIn using enhanced linkedin-scraper
-    print("🔑 Logging in to LinkedIn...")
+    logger.info("Logging in to LinkedIn...")
 
     from linkedin_scraper import actions  # type: ignore
 
@@ -182,7 +188,7 @@ def login_to_linkedin(driver: webdriver.Chrome) -> bool:
             interactive=not config.chrome.non_interactive,
         )
 
-        print("✅ Successfully logged in to LinkedIn")
+        logger.info("Successfully logged in to LinkedIn")
         return True
 
     except Exception:
@@ -203,7 +209,7 @@ def login_to_linkedin(driver: webdriver.Chrome) -> bool:
 
         elif "feed" in current_url or "mynetwork" in current_url:
             # Actually logged in successfully despite the exception
-            print("✅ Successfully logged in to LinkedIn")
+            logger.info("Successfully logged in to LinkedIn")
             return True
 
         else:
@@ -232,10 +238,10 @@ def handle_login_error(error: Exception) -> bool:
     """
     config = get_config()
 
-    print(f"\n❌ {str(error)}")
+    logger.error(f"\n❌ {str(error)}")
 
     if config.chrome.headless:
-        print(
+        logger.info(
             "🔍 Try running with visible browser window: uv run main.py --no-headless"
         )
 
@@ -252,8 +258,8 @@ def handle_login_error(error: Exception) -> bool:
         )
         if retry and retry.get("retry", False):
             clear_credentials_from_keyring()
-            print("✅ Credentials cleared from keyring.")
-            print("🔄 Retrying with new credentials...")
+            logger.info("✅ Credentials cleared from keyring.")
+            logger.info("🔄 Retrying with new credentials...")
             return True
 
     return False
@@ -266,31 +272,33 @@ def initialize_driver() -> None:
     config = get_config()
 
     if config.server.lazy_init:
-        print("Using lazy initialization - driver will be created on first tool call")
+        logger.info(
+            "Using lazy initialization - driver will be created on first tool call"
+        )
         if config.linkedin.email and config.linkedin.password:
-            print("LinkedIn credentials found in configuration")
+            logger.info("LinkedIn credentials found in configuration")
         else:
-            print(
+            logger.info(
                 "No LinkedIn credentials found - will look for stored credentials on first use"
             )
         return
 
     # Validate chromedriver can be found
     if config.chrome.chromedriver_path:
-        print(f"✅ ChromeDriver found at: {config.chrome.chromedriver_path}")
+        logger.info(f"✅ ChromeDriver found at: {config.chrome.chromedriver_path}")
         os.environ["CHROMEDRIVER"] = config.chrome.chromedriver_path
     else:
-        print("⚠️ ChromeDriver not found in common locations.")
-        print("⚡ Continuing with automatic detection...")
-        print(
+        logger.info("⚠️ ChromeDriver not found in common locations.")
+        logger.info("⚡ Continuing with automatic detection...")
+        logger.info(
             "💡 Tip: install ChromeDriver and set the CHROMEDRIVER environment variable"
         )
 
     # Create driver and log in
     try:
         driver = get_or_create_driver()
         if driver:
-            print("✅ Web driver initialized successfully")
+            logger.info("✅ Web driver initialized successfully")
         else:
             # Driver creation failed - always raise an error
             raise DriverInitializationError("Failed to initialize web driver")
@@ -310,7 +318,7 @@ def initialize_driver() -> None:
             raise DriverInitializationError(
                 f"Failed to initialize web driver: {str(e)}"
             )
-        print(f"❌ Failed to initialize web driver: {str(e)}")
+        logger.error(f"❌ Failed to initialize web driver: {str(e)}")
         handle_driver_error()
 
 
@@ -322,7 +330,9 @@ def handle_driver_error() -> None:
 
     # Skip interactive handling in non-interactive mode
     if config.chrome.non_interactive:
-        print("❌ ChromeDriver is required for this application to work properly.")
+        logger.error(
+            "❌ ChromeDriver is required for this application to work properly."
+        )
         sys.exit(1)
 
     questions = [
@@ -347,24 +357,28 @@ def handle_driver_error() -> None:
             # Update config with the new path
             config.chrome.chromedriver_path = path
             os.environ["CHROMEDRIVER"] = path
-            print(f"✅ ChromeDriver path set to: {path}")
-            print("💡 Please restart the application to use the new ChromeDriver path.")
-            print("   Example: uv run main.py")
+            logger.info(f"✅ ChromeDriver path set to: {path}")
+            logger.info(
+                "💡 Please restart the application to use the new ChromeDriver path."
+            )
+            logger.info("   Example: uv run main.py")
             sys.exit(0)
         else:
-            print(f"⚠️ Warning: The specified path does not exist: {path}")
-            print("💡 Please check the path and restart the application.")
+            logger.warning(f"⚠️ Warning: The specified path does not exist: {path}")
+            logger.info("💡 Please check the path and restart the application.")
             sys.exit(1)
 
     elif answers["chromedriver_action"] == "help":
-        print("\n📋 ChromeDriver Installation Guide:")
-        print("1. Find your Chrome version: Chrome menu > Help > About Google Chrome")
-        print(
+        logger.info("\n📋 ChromeDriver Installation Guide:")
+        logger.info(
+            "1. Find your Chrome version: Chrome menu > Help > About Google Chrome"
+        )
+        logger.info(
             "2. Download matching ChromeDriver: https://chromedriver.chromium.org/downloads"
         )
-        print("3. Place ChromeDriver in a location on your PATH")
-        print("   - macOS/Linux: /usr/local/bin/ is recommended")
-        print(
+        logger.info("3. Place ChromeDriver in a location on your PATH")
+        logger.info("   - macOS/Linux: /usr/local/bin/ is recommended")
+        logger.info(
             "   - Windows: Add to a directory in your PATH or specify the full path\n"
         )
 
@@ -373,5 +387,5 @@ def handle_driver_error() -> None:
         )["try_again"]:
             initialize_driver()
 
-    print("❌ ChromeDriver is required for this application to work properly.")
+    logger.error("❌ ChromeDriver is required for this application to work properly.")
     sys.exit(1)
diff --git a/linkedin_mcp_server/server.py b/linkedin_mcp_server/server.py
@@ -5,6 +5,7 @@
 This module creates the MCP server and registers all the LinkedIn tools.
 """
 
+import logging
 from typing import Any, Dict
 
 from fastmcp import FastMCP
@@ -14,6 +15,8 @@
 from linkedin_mcp_server.tools.job import register_job_tools
 from linkedin_mcp_server.tools.person import register_person_tools
 
+logger = logging.getLogger(__name__)
+
 
 def create_mcp_server() -> FastMCP:
     """Create and configure the MCP server with all LinkedIn tools."""
@@ -59,4 +62,11 @@ def shutdown_handler() -> None:
             driver.quit()
             del active_drivers[session_id]
         except Exception as e:
-            print(f"❌ Error closing driver during shutdown: {e}")
+            logger.error(
+                f"Error closing driver during shutdown: {e}",
+                extra={
+                    "session_id": session_id,
+                    "exception_type": type(e).__name__,
+                    "exception_message": str(e),
+                },
+            )
diff --git a/linkedin_mcp_server/tools/company.py b/linkedin_mcp_server/tools/company.py
@@ -5,13 +5,16 @@
 This module provides tools for scraping LinkedIn company profiles.
 """
 
+import logging
 from typing import Any, Dict, List
 
 from fastmcp import FastMCP
 from linkedin_scraper import Company
 
 from linkedin_mcp_server.error_handler import handle_tool_error, safe_get_driver
 
+logger = logging.getLogger(__name__)
+
 
 def register_company_tools(mcp: FastMCP) -> None:
     """
@@ -38,9 +41,9 @@ async def get_company_profile(
         try:
             driver = safe_get_driver()
 
-            print(f"🏢 Scraping company: {linkedin_url}")
+            logger.info(f"Scraping company: {linkedin_url}")
             if get_employees:
-                print("⚠️ Fetching employees may take a while...")
+                logger.info("Fetching employees may take a while...")
 
             company = Company(
                 linkedin_url,
diff --git a/linkedin_mcp_server/tools/job.py b/linkedin_mcp_server/tools/job.py
@@ -5,6 +5,7 @@
 This module provides tools for scraping LinkedIn job postings and searches.
 """
 
+import logging
 from typing import Any, Dict, List
 
 from fastmcp import FastMCP
@@ -16,6 +17,8 @@
     safe_get_driver,
 )
 
+logger = logging.getLogger(__name__)
+
 
 def register_job_tools(mcp: FastMCP) -> None:
     """
@@ -46,7 +49,7 @@ async def get_job_details(job_url: str) -> Dict[str, Any]:
         try:
             driver = safe_get_driver()
 
-            print(f"💼 Scraping job: {job_url}")
+            logger.info(f"Scraping job: {job_url}")
             job = Job(job_url, driver=driver, close_on_complete=False)
 
             # Convert job object to a dictionary
@@ -68,7 +71,7 @@ async def search_jobs(search_term: str) -> List[Dict[str, Any]]:
         try:
             driver = safe_get_driver()
 
-            print(f"🔍 Searching jobs: {search_term}")
+            logger.info(f"Searching jobs: {search_term}")
             job_search = JobSearch(driver=driver, close_on_complete=False, scrape=False)
             jobs = job_search.search(search_term)
 
@@ -88,7 +91,7 @@ async def get_recommended_jobs() -> List[Dict[str, Any]]:
         try:
             driver = safe_get_driver()
 
-            print("📋 Getting recommended jobs")
+            logger.info("Getting recommended jobs")
             job_search = JobSearch(
                 driver=driver,
                 close_on_complete=False,
diff --git a/linkedin_mcp_server/tools/person.py b/linkedin_mcp_server/tools/person.py
diff --git a/main.py b/main.py
