Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Resolve profiler issue with partial and recursive logger imports #420

Merged
merged 4 commits into from
Jan 9, 2025

Conversation

dexters1
Copy link
Collaborator

@dexters1 dexters1 commented Jan 9, 2025

Resolve issue for profiler with partial and recursive logger imports

Summary by CodeRabbit

  • Chores

    • Updated logging mechanism across multiple repository processing modules
    • Standardized logging approach using Python's built-in logging module
    • Removed custom logger imports and replaced with logging.getLogger(__name__)
  • Documentation

    • Improved error and warning logging for better visibility of processing issues

Resolve issue for profiler with partial and recursive logger imports
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces a standardized logging approach across multiple modules in the cognee/tasks/repo_processor directory. The changes involve replacing custom logger imports with Python's built-in logging module, using logging.getLogger(__name__) for dynamic logger initialization. This modification enhances logging consistency, allows for more flexible log configuration, and improves error and warning reporting across different files. Additionally, a GitHub workflow configuration for profiling has had several steps commented out, potentially modifying the profiling process.

Changes

File Change Summary
.github/workflows/profiling.yaml Commented out steps for profiling head branch and comparing results
cognee/tasks/repo_processor/__init__.py Removed logging import and logger initialization
cognee/tasks/repo_processor/expand_dependency_graph.py Replaced custom logger with logging.getLogger(__name__), updated logging statements
cognee/tasks/repo_processor/extract_code_parts.py Introduced standard logging module, added logging for warnings and errors
cognee/tasks/repo_processor/get_local_dependencies.py Replaced logger with logging.getLogger(__name__), updated error logging
cognee/tasks/repo_processor/get_source_code_chunks.py Changed logger name to __name__, enhanced error logging
cognee/tasks/repo_processor/top_down_repo_parse.py Transitioned to built-in logging module, updated error handling

Poem

🐰 Logging Leap, a Rabbit's Tale

From custom logs to Python's way,
Standardized tracking, hip hooray!
Errors whisper, warnings sing,
A cleaner code on logger's wing
Hop, hop, hurrah! 🌟

Finishing Touches

  • 📝 Generate Docstrings

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dexters1 dexters1 marked this pull request as ready for review January 9, 2025 11:42
@dexters1 dexters1 requested a review from Vasilije1990 January 9, 2025 11:42
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
cognee/tasks/repo_processor/get_local_dependencies.py (1)

Line range hint 78-78: Remove commented-out code.

The commented-out logging statement is no longer needed since it's been replaced with the new logging approach.

-    # logging.warning(f"Failed to analyze code entity {code_entity['name']}: {e}")
cognee/tasks/repo_processor/get_source_code_chunks.py (2)

Line range hint 47-53: Consider enhancing error context for better debugging.

While the error handling is good, consider including the source code length or first few characters (sanitized) in the warning message. This would help distinguish between truly empty files and parsing failures.

-        logger.error(f"Error parsing source code: {e}")
+        logger.error(f"Error parsing source code (length={len(source_code)}): {e}")
-        logger.warning("Parsed module has no children (empty or invalid source code).")
+        logger.warning(f"Parsed module has no children. First 50 chars: {source_code[:50]!r}")

Line range hint 142-157: Consider structuring error handling more specifically.

The current error handling could be enhanced in several ways:

  1. Use specific exception types instead of catching all exceptions
  2. Add structured logging for better error tracking
  3. Consider adding debug logs for successful processing

Example improvement:

         try:
             yield data_point
             if not isinstance(data_point, CodeFile):
                 continue
             if not data_point.contains:
-                logger.warning(f"CodeFile {data_point.id} contains no code parts")
+                logger.warning("Empty CodeFile", extra={
+                    "file_id": data_point.id,
+                    "file_type": type(data_point).__name__
+                })
                 continue
             for code_part in data_point.contains:
                 try:
                     yield code_part
                     for source_code_chunk in get_source_code_chunks_from_code_part(
                         code_part, model_name=embedding_model
                     ):
                         yield source_code_chunk
-                except Exception as e:
-                    logger.error(f"Error processing code part: {e}")
+                except (ValueError, parso.ParserSyntaxError) as e:
+                    logger.error("Failed to process code part", extra={
+                        "error": str(e),
+                        "code_part_id": code_part.id
+                    })
-        except Exception as e:
-            logger.error(f"Error processing data point: {e}")
+        except (TypeError, AttributeError) as e:
+            logger.error("Failed to process data point", extra={
+                "error": str(e),
+                "data_point_type": type(data_point).__name__
+            })
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fb9b05 and 2ae66c2.

📒 Files selected for processing (7)
  • .github/workflows/profiling.yaml (1 hunks)
  • cognee/tasks/repo_processor/__init__.py (0 hunks)
  • cognee/tasks/repo_processor/expand_dependency_graph.py (1 hunks)
  • cognee/tasks/repo_processor/extract_code_parts.py (1 hunks)
  • cognee/tasks/repo_processor/get_local_dependencies.py (1 hunks)
  • cognee/tasks/repo_processor/get_source_code_chunks.py (1 hunks)
  • cognee/tasks/repo_processor/top_down_repo_parse.py (1 hunks)
💤 Files with no reviewable changes (1)
  • cognee/tasks/repo_processor/init.py
✅ Files skipped from review due to trivial changes (1)
  • .github/workflows/profiling.yaml
🧰 Additional context used
🪛 GitHub Actions: test | profiling
cognee/tasks/repo_processor/extract_code_parts.py

[error] Circular import detected: Cannot import 'logger' from 'cognee.tasks.repo_processor' due to circular dependency

🔇 Additional comments (5)
cognee/tasks/repo_processor/extract_code_parts.py (1)

4-6: LGTM! Logging setup looks good.

The change from custom logger to Python's built-in logging module resolves the circular dependency issue.

🧰 Tools
🪛 GitHub Actions: test | profiling

[error] Circular import detected: Cannot import 'logger' from 'cognee.tasks.repo_processor' due to circular dependency

cognee/tasks/repo_processor/expand_dependency_graph.py (1)

8-10: LGTM! Logging setup and usage are appropriate.

The implementation uses proper log levels:

  • Debug for non-critical information
  • Warning for potential issues
  • Error for exceptions
cognee/tasks/repo_processor/get_local_dependencies.py (1)

13-15: LGTM! Logging setup looks good.

The change from custom logger to Python's built-in logging module is implemented correctly.

cognee/tasks/repo_processor/top_down_repo_parse.py (1)

7-9: LGTM! Comprehensive logging implementation.

The implementation uses all appropriate log levels:

  • Info for general information
  • Debug for detailed information
  • Warning for potential issues
  • Error for exceptions
cognee/tasks/repo_processor/get_source_code_chunks.py (1)

11-11: Excellent improvement to logger initialization!

Using logging.getLogger(__name__) instead of a hardcoded string is the recommended approach. This change:

  • Ensures unique logger names based on the module's location in the package hierarchy
  • Prevents potential circular dependencies during profiling
  • Allows for more granular log configuration

@dexters1 dexters1 merged commit 51b2094 into dev Jan 9, 2025
23 of 24 checks passed
@dexters1 dexters1 deleted the fix-profiler branch January 9, 2025 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants