Fix interference bug

[jan-janssen]

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of resource dictionaries to prevent unintended modifications.
  • Clarified core allocation logic when submitting tasks.

These changes enhance the stability and reliability of task submissions within the application.

[coderabbitai]

Walkthrough

The changes in this pull request focus on the _submit_function_to_separate_process method within the executorlib/interactive/shared.py file. A copy of the resource_dict is created when it is popped from task_dict, preventing unintended modifications. Additionally, the logic for determining the number of cores to use has been clarified, ensuring that resource_dict["cores"] is explicitly set based on executor_kwargs["cores"] when certain conditions are met. No other significant changes were made to the logic or structure of the code.

Changes

File	Change Summary
executorlib/interactive/shared.py	Modified _submit_function_to_separate_process to use .copy() on resource_dict and clarified core allocation logic.

Possibly related PRs

• Fix resource dict in interactive jobs #482: Fix resource dict in interactive jobs - This PR modifies the resource_dict handling in the same file (executorlib/interactive/shared.py) and is directly related to the changes made in the _submit_function_to_separate_process method regarding resource management.

🐰 In the code where bunnies hop,
A copy made, no need to stop.
Cores aligned, clear as day,
Resource handling's here to stay!
With every task, we leap and bound,
In shared.py, joy is found! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c8648ed and 897309e.

📒 Files selected for processing (1)

• executorlib/interactive/shared.py (1 hunks)

🔇 Additional comments (1)

executorlib/interactive/shared.py (1)

517-517: Good fix for preventing resource dictionary interference!

The addition of .copy() when popping resource_dict prevents unintended modifications to the original dictionary, fixing potential interference between tasks. This is particularly important in concurrent execution scenarios.

Consider adding a comment explaining why the copy is necessary to prevent future regressions:

-    resource_dict = task_dict.pop("resource_dict").copy()
+    # Create a copy to prevent modifications from affecting the original dictionary
+    # This prevents interference between tasks sharing the same resource dictionary
+    resource_dict = task_dict.pop("resource_dict").copy()

Let's verify if there are any other places in the codebase where resource dictionaries might need similar protection:

✅ Verification successful

Resource dictionary protection is consistently implemented

The codebase already follows best practices for handling resource dictionaries:

• In executorlib/cache/shared.py, task resource dictionaries are copied before modification
• In executorlib/interactive/shared.py, the reviewed change aligns with existing patterns
• Other modifications to resource dictionaries occur on already-copied or newly created instances

The added .copy() in the review is consistent with the codebase's approach to preventing dictionary interference.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other instances of resource dictionary usage
rg "resource_dict.*=.*task_dict" -A 2

Length of output: 770

---

Script:

#!/bin/bash
# Let's check the context of these usages to understand their purpose
rg "resource_dict.*=.*task_dict" -B 5 -A 5

# Also check for any other direct modifications to resource_dict
rg "resource_dict\[.*\].*=|resource_dict\.update" -B 2 -A 2

Length of output: 6890

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.