Skip to content

Conversation

@tadasbar
Copy link
Collaborator

@tadasbar tadasbar commented Mar 11, 2025

This PR addresses the issues with job names submitted to Google Batch that are too long or have incorrect characters.

Closes #57 and #55.

Summary by CodeRabbit

  • New Features

    • Enhanced job name processing now automatically sanitizes names, ensuring they comply with external naming restrictions for a smoother experience.
  • Chores

    • Updated the automated testing workflow to replace legacy cloud authentication with streamlined MinIO setup.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2025

📝 Walkthrough

Walkthrough

This update adds a new method fix_job_name to the GoogleBatchExecutor class for sanitizing job names by replacing illegal symbols and truncating them to 50 characters. The method is then used in both get_labels and generate_jobid to ensure that job names meet Google Batch API requirements. Additionally, the GitHub Actions workflow for testing has been modified by removing Google Cloud authentication and SDK setup steps, and by adding steps to set up MinIO.

Changes

File Change Summary
snakemake_executor_plugin_googlebatch/executor.py Added a new method fix_job_name to standardize job names; updated get_labels and generate_jobid to use the sanitized job name.
.github/workflows/ci_mocked_api.yaml Removed Google Cloud authentication and SDK setup steps; added steps to set up MinIO with specified access and secret keys and a port configuration.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Job Submission
    participant Executor as GoogleBatchExecutor
    participant Fixer as fix_job_name

    Client->>Executor: Submit job (with name)
    Executor->>Fixer: Call fix_job_name(job.name)
    Fixer-->>Executor: Return sanitized name
    Executor->>Executor: Generate labels/jobid using sanitized name
    Executor->>Client: Return processed job data
Loading

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 73c93d4 and 485415d.

📒 Files selected for processing (1)
  • .github/workflows/ci_mocked_api.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/ci_mocked_api.yaml
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: testing-mocked-api

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

@tadasbar tadasbar moved this from In review to In progress in Snakemake Hackathon March 2025 Mar 11, 2025
@tadasbar tadasbar self-assigned this Mar 11, 2025
@tadasbar tadasbar marked this pull request as ready for review March 11, 2025 18:11
Copy link
Contributor

@jakevc jakevc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tadasbar tadasbar moved this from In progress to In review in Snakemake Hackathon March 2025 Mar 14, 2025
@tadasbar tadasbar merged commit 3a37591 into main Apr 3, 2025
5 checks passed
@tadasbar tadasbar deleted the fix-multirule-group-job-id branch April 3, 2025 05:00
@github-project-automation github-project-automation bot moved this from In review to Done in Snakemake Hackathon March 2025 Apr 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

Malformed batch job ID with long rule names in group job

5 participants