fix: update via code change correctly #48

Hocnonsense · 2025-06-22T13:50:50Z

will fix #47

Summary by CodeRabbit

Bug Fixes
- Improved responsiveness to Snakemake file changes by handling document edits, saves, and openings more reliably.
Chores
- Enhanced internal event handling for better document update management.

coderabbitai · 2025-06-22T13:50:56Z

📝 Walkthrough

Walkthrough

The activation function in the extension now listens to three VSCode workspace events: text document changes, saves, and opens. The event handlers pass the relevant TextDocument to the SnakemakeManager.onDocumentChange method, which has been updated to accept a TextDocument instead of an event object. The SnakemakeManager class is now exported.

Changes

File(s)	Change Summary
src/extension.ts	Activation now subscribes to onDidChangeTextDocument, onDidSaveTextDocument, and onDidOpenTextDocument. Event handlers updated to pass `TextDocument` to `onDocumentChange`. `SnakemakeManager` class exported. `onDocumentChange` method signature changed to accept `TextDocument`. Internal references updated.

Sequence Diagram(s)

sequenceDiagram
    participant VSCode
    participant Extension
    participant SnakemakeManager

    VSCode->>Extension: onDidChangeTextDocument / onDidSaveTextDocument / onDidOpenTextDocument (TextDocument)
    Extension->>SnakemakeManager: onDocumentChange(document)
    SnakemakeManager->>SnakemakeManager: Process document change (debounced update)

Assessment against linked issues

Objective	Addressed	Explanation
Ensure link and outline are updated on document open, save, or change (#47)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f62ee17 and e0ed493.

📒 Files selected for processing (1)

src/extension.ts (2 hunks)

🔇 Additional comments (4)

src/extension.ts (4)

11-13: Good improvement to handle all document lifecycle events.

Adding handlers for document open and save events ensures proper processing in scenarios where the original change-only handler might have missed updates. The debounce mechanism should handle any redundant calls efficiently.

55-55: Good change for modularity.

Exporting the class enables external usage and testing, which improves the extensibility of the codebase.

61-70: Clean method signature simplification.

The change from accepting a TextDocumentChangeEvent to just a TextDocument is well-executed. All internal references have been updated consistently, and no functionality is lost since the method only used the document from the original event.

11-13: Well-coordinated changes that improve document handling.

The changes work together effectively to fix the document change handling issue:

Comprehensive event coverage: Now handles document open, change, and save events

Cleaner method interface: Simplified signature focuses on what's actually needed

Proper debouncing: The 200ms timeout prevents excessive processing from multiple rapid events

Better modularity: Exporting the class enables external usage

These changes should properly address the issue described in PR #47 regarding correct document updates.

Also applies to: 55-55, 61-70

✨ Finishing Touches

📝 Generate Docstrings

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.

Hocnonsense · 2025-07-04T03:27:10Z

@johanneskoester Dear Professor, sorry for the mistake I made in the last PR. This PR should fix that. Would you mind to have a look? Thanks!

Copilot

Pull Request Overview

This PR enhances document event handling for Snakemake files by listening to additional VS Code events and updating the manager API accordingly.

Added onDidSaveTextDocument and onDidOpenTextDocument subscriptions alongside change events
Exported SnakemakeManager and refactored onDocumentChange to take a TextDocument
Debounced manager updates with a 200 ms delay

Comments suppressed due to low confidence (2)

src/extension.ts:61

[nitpick] The method name onDocumentChange now handles change, save, and open events. Consider renaming it to something like handleDocumentEvent or scheduleDocumentUpdate to better reflect its broader responsibility.

    onDocumentChange(document: vscode.TextDocument) {

src/extension.ts:12

New handlers for save and open events have been added; consider adding unit or integration tests to verify that updates are triggered correctly for onDidSaveTextDocument and onDidOpenTextDocument.

        vscode.workspace.onDidSaveTextDocument((document) => snakemakeManager.onDocumentChange(document)),

Copilot · 2025-07-14T13:52:01Z

src/extension.ts

+        this.updateTimeout.set(document.uri.toString(), setTimeout(() => {
+            this.update(document);
+            this.updateTimeout.delete(document.uri.toString());
        }, 200));


[nitpick] The hardcoded debounce delay of 200 ms could be extracted into a named constant (e.g., UPDATE_DEBOUNCE_DELAY_MS) to make the purpose clear and simplify future adjustments.

Suggested change

}, 200));

}, UPDATE_DEBOUNCE_DELAY_MS));

fix: update via code change correctly

e0ed493

Hocnonsense requested a review from Copilot July 14, 2025 13:51

Copilot AI reviewed Jul 14, 2025

View reviewed changes

Hocnonsense requested a review from johanneskoester August 25, 2025 14:01

cademirch approved these changes Sep 30, 2025

View reviewed changes

cademirch merged commit 8a08dc6 into master Sep 30, 2025
4 checks passed

cademirch deleted the fix/updated branch September 30, 2025 14:14

github-actions bot mentioned this pull request Sep 30, 2025

chore(master): release 0.7.1 #50

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: update via code change correctly #48

fix: update via code change correctly #48

Uh oh!

Hocnonsense commented Jun 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 22, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Hocnonsense commented Jul 4, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fix: update via code change correctly #48

fix: update via code change correctly #48

Uh oh!

Conversation

Hocnonsense commented Jun 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Hocnonsense commented Jul 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Hocnonsense commented Jun 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)