feat: Add graph metrics getter in graph db interface and adapters [COG-1082] #483

alekszievr · 2025-01-29T13:30:15Z

Dummy implementation of graph metrics to demonstrate how the interface will look like

Description

DCO Affirmation

I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin

Summary by CodeRabbit

New Features
- Introduced asynchronous functionality for retrieving comprehensive graph metrics, including counts and connectivity details, across different systems.
Refactor
- Streamlined metrics processing and storage by shifting to direct retrieval from the graph engine.
- Updated naming conventions for the GraphMetrics database table and reorganized module imports to enhance internal consistency.
Chores
- Removed dataset deletion functionalities while introducing the ability to store descriptive metrics.

…oken-counting

…-tokens-to-metric-table

…add-num-tokens-to-metric-table

coderabbitai · 2025-01-29T13:30:22Z

Walkthrough

The changes introduce a new asynchronous method get_graph_metrics in multiple database adapter classes and the corresponding abstract interface. Additionally, the GraphMetrics model’s table name has been modified and its export updated. The import for store_descriptive_metrics has been shifted to a different module, and its implementation has been refactored to obtain metrics directly by calling graph_engine.get_graph_metrics() and persisting the results as a new GraphMetrics object in the database.

Changes

File(s)	Change Summary
`cognee/infrastructure/databases/graph/graph_db_interface.py`	Added new async abstract method `get_graph_metrics` that raises a `NotImplementedError`.
`cognee/infrastructure/databases/graph/neo4j_driver/adapter.py`, `cognee/infrastructure/databases/graph/networkx/adapter.py`	Introduced an async method `get_graph_metrics` returning a dictionary of graph metrics with placeholder values (`-1`).
`cognee/modules/data/models/GraphMetrics.py`, `cognee/modules/data/models/__init__.py`	Updated `__tablename__` of `GraphMetrics` from `"graph_metrics_table"` to `"graph_metrics"`; added an import for `GraphMetrics` in the package.
`cognee/api/v1/cognify/cognify_v2.py`	Modified the import for `store_descriptive_metrics` from the storage module to the data methods module.
`cognee/modules/data/methods/store_descriptive_metrics.py`	Removed the `calculate_graph_metrics` function and refactored `store_descriptive_metrics` to call `await graph_engine.get_graph_metrics()`, create a `GraphMetrics` object, and commit it to the database.
`cognee/modules/data/methods/__init__.py`	Removed imports for `delete_dataset` and `delete_data`; added import for `store_descriptive_metrics`.

Sequence Diagram(s)

sequenceDiagram
    participant S as store_descriptive_metrics
    participant GE as Graph Engine
    participant DB as Database
    S->>GE: await get_graph_metrics()
    GE-->>S: Return metrics dictionary (values: -1)
    S->>DB: Create & commit GraphMetrics object

Suggested labels

do not merge

Suggested reviewers

borisarzentar

Poem

I’m a bunny in the code, so light,
Hopping through metrics in the night.
New methods sprout like carrots bright,
Data blooms in lines so right.
I cheer in ASCII, a happy sight!
🐇✨
CodeRabbit leaps with delight!

✨ Finishing Touches

📝 Generate Docstrings (Beta)

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.

cognee/modules/data/models/GraphMetrics.py

coderabbitai

Actionable comments posted: 3

🧹 Nitpick comments (1)

cognee/infrastructure/databases/graph/graph_db_interface.py (1)
57-60: Add return type hint for better type safety.

The new abstract method should specify its return type for better type safety and documentation.
     @abstractmethod
-    async def get_graph_metrics(self):
+    async def get_graph_metrics(self) -> dict[str, float]:
         raise NotImplementedError

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a79f713 and 48a51a3.

📒 Files selected for processing (4)

cognee/infrastructure/databases/graph/graph_db_interface.py (1 hunks)
cognee/infrastructure/databases/graph/neo4j_driver/adapter.py (1 hunks)
cognee/infrastructure/databases/graph/networkx/adapter.py (1 hunks)
cognee/tasks/storage/descriptive_metrics.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (20)

GitHub Check: run_simple_example_test / test
GitHub Check: run_multimedia_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_simple_example_test / test
GitHub Check: run_dynamic_steps_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: windows-latest
GitHub Check: docker-compose-test
GitHub Check: profiler

cognee/infrastructure/databases/graph/networkx/adapter.py

cognee/infrastructure/databases/graph/neo4j_driver/adapter.py

cognee/tasks/storage/descriptive_metrics.py

cognee/modules/data/models/GraphMetrics.py

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

cognee/modules/data/methods/store_descriptive_metrics.py (1)

28-52: Consider adding metrics validation and logging.

The function would benefit from additional validation and logging to track metrics over time.

Consider:

Adding range validation for metrics (e.g., non-negative values)

Adding logging to track metrics changes

Adding comparison with previous metrics for monitoring trends

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 57fb338 and 735c2a8.

📒 Files selected for processing (3)

cognee/api/v1/cognify/cognify_v2.py (1 hunks)
cognee/modules/data/methods/store_descriptive_metrics.py (2 hunks)
cognee/modules/data/models/__init__.py (1 hunks)

✅ Files skipped from review due to trivial changes (2)

cognee/api/v1/cognify/cognify_v2.py
cognee/modules/data/models/init.py

⏰ Context from checks skipped due to timeout of 90000ms (18)

GitHub Check: run_notebook_test / test
GitHub Check: run_dynamic_steps_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: run_simple_example_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: windows-latest
GitHub Check: test
GitHub Check: test
GitHub Check: docker-compose-test
GitHub Check: profiler

🔇 Additional comments (1)

cognee/modules/data/methods/store_descriptive_metrics.py (1)

10-10: LGTM!

The import statement change looks appropriate for the module organization.

cognee/modules/data/methods/store_descriptive_metrics.py

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

cognee/modules/data/methods/store_descriptive_metrics.py (2)
33-50: Consider using a transaction context manager.

The database operations should be wrapped in a transaction to ensure atomicity. If any operation fails, all changes should be rolled back.

Apply this diff to add transaction handling:
-    async with db_engine.get_async_session() as session:
+    async with db_engine.get_async_session() as session:
+        async with session.begin():
             metrics = GraphMetrics(
                 # ... existing metrics initialization ...
             )
             session.add(metrics)
-            await session.commit()
28-52: Implementation provides a good foundation for graph metrics collection.

The implementation successfully demonstrates the interface by collecting standard graph metrics (nodes, edges, clustering, etc.). This provides a solid foundation for future enhancements.

Consider these future enhancements:

Add caching for expensive metrics calculations

Implement batch processing for large graphs

Add metric calculation timeouts

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 735c2a8 and 05138fa.

📒 Files selected for processing (4)

cognee/api/v1/cognify/cognify_v2.py (1 hunks)
cognee/modules/data/methods/__init__.py (1 hunks)
cognee/modules/data/methods/store_descriptive_metrics.py (2 hunks)
cognee/modules/data/models/__init__.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

cognee/modules/data/models/init.py
cognee/api/v1/cognify/cognify_v2.py

⏰ Context from checks skipped due to timeout of 90000ms (18)

GitHub Check: run_notebook_test / test
GitHub Check: windows-latest
GitHub Check: run_simple_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: run_dynamic_steps_example_test / test
GitHub Check: test
GitHub Check: docker-compose-test
GitHub Check: test
GitHub Check: profiler

🔇 Additional comments (2)

cognee/modules/data/methods/store_descriptive_metrics.py (2)

31-31: Add error handling for graph metrics retrieval.

The direct call to get_graph_metrics() should be wrapped in a try-catch block to handle potential errors gracefully.

34-47: Add validation and type hints for graph metrics.

The code assumes all required metrics exist in the dictionary without validation. Also, type hints would improve code clarity.

cognee/modules/data/methods/__init__.py

cognee/modules/data/methods/store_descriptive_metrics.py

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

cognee/modules/data/methods/store_descriptive_metrics.py (2)

11-23: Add error handling for token count retrieval.

The function should handle edge cases where the token count might be null or when database errors occur.

Apply this diff to improve error handling:

 async def fetch_token_count(db_engine) -> int:
     """
     Fetches and sums token counts from the database.
 
     Returns:
         int: The total number of tokens across all documents.
+
+    Raises:
+        RuntimeError: If token count retrieval fails
     """
 
     async with db_engine.get_async_session() as session:
-        token_count_sum = await session.execute(select(func.sum(Data.token_count)))
-        token_count_sum = token_count_sum.scalar()
+        try:
+            token_count_sum = await session.execute(select(func.sum(Data.token_count)))
+            token_count_sum = token_count_sum.scalar() or 0  # Handle NULL case
+        except Exception as e:
+            raise RuntimeError(f"Failed to retrieve token count: {str(e)}") from e
 
     return token_count_sum

26-26: Add docstring to explain function purpose and parameters.

The function lacks documentation explaining its purpose, parameters, and return value.

Apply this diff to add documentation:

 async def store_descriptive_metrics(data_points: list[DataPoint]):
+    """
+    Store descriptive metrics about the graph structure and token usage.
+    
+    This function retrieves graph metrics from the graph engine and token count
+    from the relational database, then stores them as a new GraphMetrics entry.
+    
+    Args:
+        data_points: List of DataPoint objects being processed
+        
+    Returns:
+        list[DataPoint]: The input data_points list unchanged
+        
+    Note:
+        This function is part of the metrics collection pipeline and stores
+        various graph metrics like node count, edge density, clustering, etc.
+    """

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05138fa and 268d778.

📒 Files selected for processing (4)

cognee/api/v1/cognify/cognify_v2.py (1 hunks)
cognee/modules/data/methods/__init__.py (1 hunks)
cognee/modules/data/methods/store_descriptive_metrics.py (1 hunks)
cognee/modules/data/models/__init__.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

cognee/modules/data/models/init.py
cognee/modules/data/methods/init.py
cognee/api/v1/cognify/cognify_v2.py

⏰ Context from checks skipped due to timeout of 90000ms (18)

GitHub Check: run_dynamic_steps_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_notebook_test / test
GitHub Check: run_simple_example_test / test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: run_notebook_test / test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: windows-latest
GitHub Check: test
GitHub Check: test
GitHub Check: test
GitHub Check: docker-compose-test
GitHub Check: profiler

🔇 Additional comments (1)

cognee/modules/data/methods/store_descriptive_metrics.py (1)

29-29: Add error handling for graph metrics retrieval.

The direct call to get_graph_metrics() should be wrapped in a try-catch block to handle potential errors gracefully.

alekszievr and others added 14 commits January 28, 2025 12:11

Count the number of tokens in documents

458eeac

Merge branch 'COG-970-refactor-tokenizing' into feat/cog-1071-input-t…

51eadef

…oken-counting

Merge branch 'COG-970-refactor-tokenizing' into feat/cog-1071-input-t…

ba608a4

…oken-counting

save token count to relational db

f6663ab

Merge branch 'COG-970-refactor-tokenizing' into feat/cog-1132-add-num…

9182be8

…-tokens-to-metric-table

Add metrics to metric table

72dfec4

Merge branch 'dev' into feat/cog-1071-input-token-counting

9bd5917

Merge branch 'feat/cog-1071-input-token-counting' into feat/cog-1132-…

227d94e

…add-num-tokens-to-metric-table

Store list as json instead of array in relational db table

22b6459

Merge branch 'dev' into feat/cog-1132-add-num-tokens-to-metric-table

9764441

Sum in sql instead of python

100e7d7

Unify naming

c182d47

Return data_points in descriptive metric calculation task

44fa2cd

Graph metrics getter template in graph db interface and adapters

06030ff

alekszievr self-assigned this Jan 29, 2025

alekszievr changed the title ~~Graph metrics getter template in graph db interface and adapters~~ Graph metrics getter template in graph db interface and adapters [COG-1082] Jan 29, 2025

alekszievr requested a review from lxobr January 29, 2025 20:05

Base automatically changed from feat/cog-1132-add-num-tokens-to-metric-table to dev January 30, 2025 11:39

borisarzentar reviewed Jan 30, 2025

View reviewed changes

cognee/modules/data/models/GraphMetrics.py Outdated Show resolved Hide resolved

Merge branch 'dev' into feat/cog-1082-metrics-in-graphdb-interface

48a51a3

coderabbitai bot reviewed Jan 30, 2025

View reviewed changes

cognee/infrastructure/databases/graph/networkx/adapter.py Show resolved Hide resolved

cognee/infrastructure/databases/graph/neo4j_driver/adapter.py Show resolved Hide resolved

cognee/tasks/storage/descriptive_metrics.py Show resolved Hide resolved

remove _table from table name

9a94db8

alekszievr requested a review from borisarzentar January 30, 2025 16:48

alekszievr added the run-checks label Jan 31, 2025

Merge branch 'dev' into feat/cog-1082-metrics-in-graphdb-interface

57fb338

borisarzentar changed the title ~~Graph metrics getter template in graph db interface and adapters [COG-1082]~~ feat: Add graph metrics getter in graph db interface and adapters [COG-1082] Jan 31, 2025

Merge branch 'dev' into feat/cog-1082-metrics-in-graphdb-interface

e8dcef1

lxobr reviewed Feb 1, 2025

View reviewed changes

cognee/modules/data/models/GraphMetrics.py Show resolved Hide resolved

Merge branch 'dev' into feat/cog-1082-metrics-in-graphdb-interface

b0f6ba7

coderabbitai bot reviewed Feb 3, 2025

View reviewed changes

cognee/modules/data/methods/store_descriptive_metrics.py Show resolved Hide resolved

cognee/modules/data/methods/store_descriptive_metrics.py Show resolved Hide resolved

alekszievr force-pushed the feat/cog-1082-metrics-in-graphdb-interface branch from 735c2a8 to 05138fa Compare February 3, 2025 10:39

coderabbitai bot reviewed Feb 3, 2025

View reviewed changes

cognee/modules/data/methods/__init__.py Show resolved Hide resolved

borisarzentar reviewed Feb 3, 2025

View reviewed changes

cognee/modules/data/methods/store_descriptive_metrics.py Outdated Show resolved Hide resolved

Use modules for adding to db instead of infrastructure

268d778

alekszievr force-pushed the feat/cog-1082-metrics-in-graphdb-interface branch from 05138fa to 268d778 Compare February 3, 2025 13:15

coderabbitai bot reviewed Feb 3, 2025

View reviewed changes

alekszievr requested a review from borisarzentar February 3, 2025 14:14

lxobr approved these changes Feb 3, 2025

View reviewed changes

alekszievr merged commit 5119992 into dev Feb 3, 2025
27 checks passed

alekszievr deleted the feat/cog-1082-metrics-in-graphdb-interface branch February 3, 2025 14:25

This was referenced Feb 3, 2025

feat: Calculate graph metrics for networkx graph [COG-1082] #484

Merged

feat: metrics in neo4j adapter [COG-1082] #487

Merged

Test: test descriptive graph metric calculation in neo4j and networkx adapters [COG-1188] #500

Merged

coderabbitai bot mentioned this pull request Apr 17, 2025

feat: Add Memgraph integration #751

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add graph metrics getter in graph db interface and adapters [COG-1082] #483

feat: Add graph metrics getter in graph db interface and adapters [COG-1082] #483

Uh oh!

alekszievr commented Jan 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

feat: Add graph metrics getter in graph db interface and adapters [COG-1082] #483

feat: Add graph metrics getter in graph db interface and adapters [COG-1082] #483

Uh oh!

Conversation

alekszievr commented Jan 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

DCO Affirmation

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alekszievr commented Jan 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)