Skip to content

Implementation of Enhanced Visualization UI with Selection Row #133

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

Draft
wants to merge 114 commits into
base: develop
Choose a base branch
from

Conversation

codegen-sh[bot]
Copy link

@codegen-sh codegen-sh bot commented May 17, 2025

This PR implements an enhanced visualization UI with a selection row that shows corresponding methods when selecting Symbols, Files, Functions, or Classes.

Features Implemented

  1. Selection Row UI Component: Added a new UI component that displays information about the selected element, including its methods and related elements.

  2. Interactive Selection: Implemented functionality to select elements in the visualization and display their details in the selection row.

  3. Relationship Visualization: Added support for visualizing relationships between selected elements.

  4. Navigation Features: Implemented interactive features to navigate between related elements.

Implementation Details

Backend Changes

  • Enhanced VisualizationManager with selection functionality
  • Added new data classes and enums for representing selected elements
  • Implemented utility functions for working with selected elements
  • Created API endpoints for the visualization frontend

Frontend Components

  • Created a main visualization component (VisualizationUI.tsx)
  • Implemented a selection row component (SelectionRow.tsx)
  • Added styles for the visualization UI

Documentation and Tests

  • Added comprehensive documentation for the enhanced visualization features
  • Implemented unit tests for the visualization manager and API

How to Use

The enhanced visualization UI can be accessed through the Codegen web interface. Users can:

  1. Select elements in the visualization by clicking on them
  2. View the methods and related elements of the selected element in the selection row
  3. Navigate to related elements by clicking on them in the selection row

Closes ZAM-421.


💻 View my workAbout Codegen

Summary by Sourcery

Implement interactive selection functionality in the code visualization system by adding a selection row UI with method and related-element tabs, extending the VisualizationManager and API to track and persist selected elements, and providing utility functions for element metadata.

New Features:

  • Add SelectionRow component to display selected element’s type, name, methods, and related elements in the frontend UI
  • Enable interactive selection, deselection, and clearing of symbols, files, functions, or classes in the visualization with corresponding backend support
  • Introduce API endpoints for fetching graph data, retrieving selection state, and selecting/deselecting elements

Enhancements:

  • Extend VisualizationManager to maintain and serialize selected element state to disk
  • Add viz_utils helpers for computing element types, methods, and relationships
  • Define a SelectedElement data class and ElementType enum to model selection data

Documentation:

  • Add user‐facing documentation for enhanced visualization features including selection row behavior and navigation

Tests:

  • Introduce unit tests for VisualizationManager selection methods and visualization API endpoints

Chores:

  • Format package.json release branches and lock package manager version

clee-codegen and others added 30 commits February 26, 2025 23:54
# Motivation

The **Codegen on OSS** package provides a pipeline that:

- **Collects repository URLs** from different sources (e.g., CSV files
or GitHub searches).
- **Parses repositories** using the codegen tool.
- **Profiles performance** and logs metrics for each parsing run.
- **Logs errors** to help pinpoint parsing failures or performance
bottlenecks.

<!-- Why is this change necessary? -->

# Content

<!-- Please include a summary of the change -->
see
[codegen-on-oss/README.md](https://github.com/codegen-sh/codegen-sdk/blob/acfe3dc07b65670af33b977fa1e7bc8627fd714e/codegen-on-oss/README.md)

# Testing

<!-- How was the change tested? -->
`uv run modal run modal_run.py`
No unit tests yet 😿 

# Please check the following before marking your PR as ready for review

- [ ] I have added tests for my changes
- [x] I have updated the documentation or added new documentation as
needed
Original commit by Tawsif Kamal: Revert "Revert "Adding Schema for Tool Outputs"" (codegen-sh#894)

Reverts codegen-sh#892

---------

Co-authored-by: Rushil Patel <[email protected]>
Co-authored-by: rushilpatel0 <[email protected]>
Original commit by Ellen Agarwal: fix: Workaround for relace not adding newlines (codegen-sh#907)
Copy link

sourcery-ai bot commented May 17, 2025

Reviewer's Guide

Introduces interactive selection support in the visualization system by extending the backend manager with selection state, utility functions, and API endpoints, and adding corresponding frontend components, styles, tests, and documentation for the new selection row UI.

Sequence Diagram for Initial Data Loading in Visualization UI

sequenceDiagram
    participant VUI as VisualizationUI (Frontend)
    participant API as VisualizationAPI (Backend)
    participant FS as Filesystem

    VUI->>API: GET /api/visualization/graph
    API->>FS: Read graph.json
    FS-->>API: graph.json content
    API-->>VUI: Respond with graph data

    VUI->>API: GET /api/visualization/selection
    API->>FS: Read selection.json (if exists)
    FS-->>API: selection.json content
    API-->>VUI: Respond with selection data

    VUI->>VUI: Set graphData & selectedElement state
    VUI->>VUI: Render graph & SelectionRow
Loading

Updated Class Diagram for Visualization Backend Components

classDiagram
    class VisualizationManager {
        +RepoOperator op
        +Dict~str, SelectedElement~ selected_elements
        +str viz_path
        +str viz_file_path
        +str selection_file_path
        +__init__(op: RepoOperator)
        +clear_graphviz_data() void
        +write_graphviz_data(G, root) void
        +select_element(element: Editable) SelectedElement
        +deselect_element(element_id: str) void
        +clear_selection() void
        +get_selected_elements() Dict~str, SelectedElement~
        +get_selected_element(element_id: str) SelectedElement
        +get_selected_element_methods(element_id: str) List~str~
        +get_selected_element_related(element_id: str) List~str~
        -_write_selection_data() void
    }
    note for VisualizationManager "Manages visualization graph and selection state.\nNew attributes: selected_elements, selection_file_path.\nNew methods for selection management."

    class SelectedElement {
        +ElementType type
        +str id
        +str name
        +list~str~ methods
        +list~str~ related_elements
    }
    note for SelectedElement "New dataclass to represent a selected element in the UI."

    class ElementType {
        <<Enumeration>>
        SYMBOL
        FILE
        FUNCTION
        CLASS
    }
    note for ElementType "New enum for types of selectable elements."

    VisualizationManager "1" *-- "0..*" SelectedElement : stores/manages
    SelectedElement "1" *-- "1" ElementType : has type
Loading

File-Level Changes

Change Details Files
Extend VisualizationManager with selection state and operations
  • Add selected_elements field and reset in clear_graphviz_data
  • Implement select, deselect, clear_selection, and getters
  • Persist selection data to selection.json
  • Expose selection_file_path property
src/codegen/visualizations/visualization_manager.py
Add enums and utility functions for building SelectedElement objects
  • Define ElementType and SelectedElement dataclass
  • Implement get_element_type, get_element_methods, get_related_elements
  • Create and serialize SelectedElement via create_selected_element, selected_element_to_json
src/codegen/visualizations/viz_utils.py
src/codegen/visualizations/enums.py
Introduce API endpoints for graph and selection management
  • GET /graph and /selection to read JSON files
  • POST /select, /deselect, /clear-selection handlers
  • Hook into request.state for viz_manager and codebase
src/codegen/visualizations/api/visualization_api.py
Build frontend components for visualization and selection row
  • Create VisualizationUI.tsx with data fetching, polling, and selection calls
  • Implement SelectionRow.tsx with tabs for methods and related elements
  • Add corresponding CSS styles
src/codegen/visualizations/frontend/VisualizationUI.tsx
src/codegen/visualizations/frontend/SelectionRow.tsx
src/codegen/visualizations/frontend/VisualizationUI.css
src/codegen/visualizations/frontend/SelectionRow.css
Add comprehensive unit tests
  • Test select, deselect, clear, getters in VisualizationManager
  • Test REST endpoints for graph, selection, select/deselect/clear-selection
tests/unit/codegen/visualizations/test_visualization_manager.py
tests/unit/codegen/visualizations/test_visualization_api.py
Document enhanced visualization features
  • Outline selection row UI, interactive selection, navigation
  • Detail backend usage, utility functions, API endpoints, and frontend components
docs/visualization_features.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

korbit-ai bot commented May 17, 2025

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

Copy link

coderabbitai bot commented May 17, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

Copy link
Author

codegen-sh bot commented May 17, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

Copy link
Author

codegen-sh bot commented May 17, 2025

I'm looking into the failing mypy check on PR #133. Let me examine the logs to identify the specific issue and fix it.

💻 View my work

Copy link
Author

codegen-sh bot commented May 17, 2025

I'm continuing to work on fixing the failing check for PR #133. I'll identify and fix the specific mypy type checking issues.

💻 View my work

Copy link
Author

codegen-sh bot commented May 17, 2025

✅ Fixed the failing mypy check in this commit.

The issue was a type annotation problem in the SelectedElement class in enums.py. The methods and related_elements fields were annotated as list[str] but initialized with None, which caused a type mismatch. I've updated the annotations to list[str] | None to properly reflect that these fields can be either a list of strings or None.

The changes have been pushed to the PR branch and should resolve the mypy check failure.

💻 View my work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants