Skip to content
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

Fixes a panic in the wasm executor when entrypoint is not known #3779

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

rossjones
Copy link
Contributor

Currently we try to reference the ExportedFunction which is documented as returning nil when the name is not found. Instead it returns a non-nil object with an inner nil field which will cause a panic when Call-ed.

This commit instead looks up the function before referencing it to ensure it exists, returning an error early if not. This allows us to remove the call to recover which was handling the panic() for us.

Fixes #3753

Copy link

coderabbitai bot commented Apr 11, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@rossjones rossjones requested a review from simonwo April 11, 2024 16:01
Comment on lines 67 to 73
if r := recover(); r != nil {
h.logger.Error().
Str("recover", fmt.Sprintf("%v", r)).
Msg("execution recovered from panic")
// TODO don't do this.
h.result = &models.RunCommandResult{}
}
Copy link
Member

Choose a reason for hiding this comment

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

If we are 100% sure the code called below here won't panic then I am for removing this defer statement, otherwise I'd find it safer to leave it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we leave it, then I'd suggest we change it to returning an error instead as at the moment it makes it look like the execution succeeded.

Copy link
Member

Choose a reason for hiding this comment

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

That sounds good to me. Basically do what was done here:

	h.result = executor.NewFailedResult(
			fmt.Sprintf("unable to find the entrypoint '%s' in the WASM module", h.arguments.EntryPoint),
		)
		return

but change the error message to state a panic occurred?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 94b9c8e

Currently we try to reference the `ExportedFunction` which is documented
as returning nil when the name is not found. Instead it returns a
non-nil object with an inner nil field which will cause a panic when
`Call`-ed.

This commit instead looks up the function before referencing it to
ensure it exists, returning an error early if not. This allows us to
remove the call to recover which was handling the panic() for us.
@rossjones rossjones enabled auto-merge (squash) April 12, 2024 08:01
@rossjones rossjones merged commit af44504 into main Apr 12, 2024
12 checks passed
@rossjones rossjones deleted the 3753-fix-wasm-panic branch April 12, 2024 08:14
aronchick pushed a commit that referenced this pull request Apr 27, 2024
Currently we try to reference the `ExportedFunction` which is documented
as returning nil when the name is not found. Instead it returns a
non-nil object with an inner nil field which will cause a panic when
`Call`-ed.

This commit instead looks up the function before referencing it to
ensure it exists, returning an error early if not. This allows us to
remove the call to recover which was handling the panic() for us.

Fixes #3753
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.

Failure to run a WASM job does not produce a job error
3 participants