Skip to content

fix panic when digger is misconfigured #1975

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

Merged
merged 3 commits into from
Jun 13, 2025

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Jun 13, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling for invalid types in the "run" and "shell" fields when processing YAML files, preventing potential crashes and providing clearer error messages.
  • Tests
    • Added tests to ensure errors are raised when the "run" step or its "shell" attribute are misconfigured with incorrect types.

Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

Walkthrough

The UnmarshalYAML method of the StepYaml struct was updated to add explicit type checking and error handling for both the "run" and "shell" keys during YAML unmarshalling. Two new tests were added to verify that misconfigured run steps and misconfigured shell attributes produce appropriate error messages.

Changes

File(s) Change Summary
libs/digger_config/yaml.go Added type assertions with error handling for "run" and "shell" keys in StepYaml.UnmarshalYAML method.
libs/digger_config/digger_config_test.go Added tests verifying errors are returned when run is a map instead of string, and when shell is a list instead of string.

Poem

In the warren where configs are spun,
A rabbit checked types for each "run".
No more panics in the night,
Errors now handled just right.
With careful code and gentle paws,
Bugs retreat from rabbit laws! 🐇✨
Shells and runs now safe and sound,
In YAML fields, peace is 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 414b8fc and 823066a.

📒 Files selected for processing (2)
  • libs/digger_config/digger_config_test.go (1 hunks)
  • libs/digger_config/yaml.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • libs/digger_config/yaml.go
  • libs/digger_config/digger_config_test.go
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/panic-when-run-misconfigured
  • Post Copyable Unit Tests in Comment

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 auto-generate unit tests to generate unit tests 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.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Added robust error handling for YAML configuration parsing in libs/digger_config/yaml.go to prevent panics when users misconfigure workflow steps.

  • Enhanced StepYaml.UnmarshalYAML method with proper type validation for the 'run' field, replacing potential panic with descriptive error messages

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 41932ae and d62ac75.

📒 Files selected for processing (1)
  • libs/digger_config/yaml.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
🔇 Additional comments (1)
libs/digger_config/yaml.go (1)

3-6: Import addition looks good

fmt is now required for the new error message – import is correctly added and will be kept in-order by goimports.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
libs/digger_config/digger_config_test.go (2)

322-358: Condense the two assertions into assert.ErrorContains for clarity

You already check that an error is returned and that its text matches a substring.
assert.ErrorContains captures both intentions in a single call and avoids the extra err.Error() dereference.

-	_, _, _, err := LoadDiggerConfig(tempDir, true, nil)
-	assert.Error(t, err, "expected error to be raised")
-	assert.Contains(t, err.Error(), "step.run must be a string")
+	_, _, _, err := LoadDiggerConfig(tempDir, true, nil)
+	assert.ErrorContains(t, err, "step.run must be a string")

322-322: Rename test to follow Go error-centric wording

Go code “returns an error” rather than “throws”.
Consider TestProjectWithMisconfiguredRunStepReturnsError to stay consistent with Go idioms and the rest of the file.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d62ac75 and 414b8fc.

📒 Files selected for processing (1)
  • libs/digger_config/digger_config_test.go (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
libs/digger_config/digger_config_test.go (1)
libs/digger_config/digger_config.go (1)
  • LoadDiggerConfig (214-243)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build

@motatoes motatoes merged commit 567d04f into develop Jun 13, 2025
12 checks passed
@motatoes motatoes deleted the fix/panic-when-run-misconfigured branch June 13, 2025 01:40
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