8000 Link language debugging by lucksus · Pull Request #611 · coasys/ad4m · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Link language debugging #611

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 14 commits into
base: dev
Choose a base branch
from
Open

Link language debugging #611

wants to merge 14 commits into from

Conversation

lucksus
Copy link
Member
@lucksus lucksus commented Jun 18, 2025

Add Debug Strings Functionality for Language Development and Debugging

Overview

This PR adds comprehensive debug strings functionality to AD4M, enabling language developers and field testers to monitor and debug language operations in real-time. The implementation includes backend debug string generation through a new callback interface, storage and retrieval systems, and a complete UI for viewing and analyzing debug information.

Features Added

🔧 Backend Implementation

LinkSyncAdapter Interface Extension

  • New Callback Interface: Added addDebugStringCallback to LinkSyncAdapter interface
  • Language Integration: Languages can now emit debug strings during operations
  • Operation Tracking: Debug strings include operation type (merge, pull, commit, etc.) and timestamps

Runtime Service Integration

  • Storage System: In-memory storage with configurable limits (100 entries max, FIFO)
  • GraphQL API: Added runtimeDebugStrings query with optional language address filtering
  • Rust Service Layer: Full integration with RuntimeService for debug string management

P-Diff-Sync Implementation

  • Callback Implementation: P-diff-sync now generates debug strings for key operations
  • DOT Graph Generation: Network topology visualizations in Graphviz DOT format
  • Operation Coverage: Debug strings for merge, pull, commit, and pull-info operations

🎨 Frontend Implementation

Debug Strings Component

  • Reusable Component: New DebugStrings.tsx for displaying debug information across the app
  • DOT Graph Visualization: Automatic detection and SVG rendering of Graphviz DOT syntax
  • Responsive Design: Modal interface with scrollable content and proper error handling

UI Integration

  • Language Cards: Debug buttons on all language cards in the Languages tab
  • Perspective Cards: Debug buttons on neighborhood perspective cards (for link languages)
  • Performance Optimized: Lazy loading - debug strings only fetched when modal opens

Technical Implementation

Backend Changes

LinkSyncAdapter Interface

export interface LinkSyncAdapter {
  // ... existing methods
  addDebugStringCallback?: (callback: DebugStringObserver) => void;
}

export type DebugStringObserver = (debugString: string, operation: string) => void;

Runtime Service

// Storage and retrieval
impl RuntimeService {
    pub fn add_debug_string(language_address: String, debug_string: String, operation: String) {
        // Store with timestamp and FIFO management
    }
    
    pub fn get_debug_strings(language_address: Option<String>) -> Vec<DebugStringEntry> {
        // Retrieve with optional filtering
    }
}

P-Diff-Sync Integration

// In p-diff-sync LinkSyncAdapter implementation
addDebugStringCallback(callback) {
    this.debugCallback = callback;
}

// During operations
this.debugCallback?.(
    `digraph { ${nodeConnections} }`,
    "merge"
);

Frontend Changes

RuntimeClient Extension

// get debug info for a specific language
const debugEntries = await ad4m.runtime.debugStrings(languageAddress);

// or all languages
const allDebugEntries = await ad4m.runtime.debugStrings();

User Experience

For Language Developers

  • 🐛 Development Debugging: Real-time visibility into language operations
  • 📊 Visual Network Topology: Automatic DOT graph rendering for p-diff-sync operations
  • 🔍 Operation Tracking: See exactly when and how language operations execute
  • 📝 Detailed Logging: Full debug information with timestamps and operation context

For Field Testers

  • 🚀 Easy Access: Clear debug buttons on language and perspective cards
  • 🔄 Manual Refresh: Update debug information on demand
  • 📈 Performance Monitoring: Monitor language behavior in real-world scenarios
  • 🎯 Language-Specific: Filter debug information by specific languages

Implementation Details

Debug String Flow

  1. Language Operation: P-diff-sync performs merge/pull/commit operation
  2. Debug Generation: Language calls debugCallback with DOT graph and operation type
  3. Storage: Runtime service stores debug string with timestamp and language address
  4. UI Display: User clicks debug button, modal fetches and displays debug strings
  5. Visualization: DOT graphs automatically rendered as SVG, others as raw text

Performance Considerations

  • Lazy Loading: Debug strings only fetched when modal opens
  • Memory Management: FIFO storage with 100-entry limit
  • Efficient Filtering: Language-specific queries reduce data transfer
  • No Polling: Manual refresh only, no automatic subscriptions

Dependencies Added

  • @viz-js/viz: Lightweight DOT graph rendering library for Graphviz visualization

Testing

  • ✅ Integration tests for debug string generation in p-diff-sync operations
  • ✅ UI component compilation and build verification
  • ✅ Manual testing of debug string display and graph rendering
  • ✅ Performance testing with multiple languages and debug entries
  • ✅ Cross-browser compatibility for DOT graph rendering

Breaking Changes

None. This is a purely additive feature:

  • New optional callback in LinkSyncAdapter interface
  • Existing languages continue to work without debug strings
  • No changes to existing API contracts

Future Enhancements

  • Real-time subscriptions for automatic debug string updates
  • Advanced filtering and search capabilities within debug strings
  • Export functionality for debug data analysis
  • Integration with external debugging tools
  • Configurable debug string retention policies

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 18, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • 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? Create a ticket on our support page 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 docstrings to generate docstrings for this 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.

@lucksus lucksus changed the base branch from hc-debug-info to dev June 18, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
3F46
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lucksus
0