Skip to content

Perform the null check right after the memory allocation#885

Merged
lucacome merged 2 commits intoopentracing-contrib:masterfrom
Anchels:patch-1
Aug 18, 2025
Merged

Perform the null check right after the memory allocation#885
lucacome merged 2 commits intoopentracing-contrib:masterfrom
Anchels:patch-1

Conversation

@Anchels
Copy link
Copy Markdown
Contributor

@Anchels Anchels commented Jun 26, 2025

Closes #876

Summary by CodeRabbit

  • Refactor
    • Improved initialization logic for better reliability during configuration setup.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 26, 2025

Walkthrough

The code change reorders the null pointer check and structure initialization in the create_opentracing_main_conf function. Now, the function checks if the memory allocation succeeded before initializing the opentracing_main_conf_t structure, preventing a potential null dereference.

Changes

File(s) Change Summary
opentracing/src/ngx_http_opentracing_module.cpp Reordered null check and structure initialization in config creation.

Assessment against linked issues

Objective Addressed Explanation
Check for null after memory allocation before dereferencing ( #876 )

Suggested labels

enhancement


📜 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 e23ec9a and f1ae6ad.

📒 Files selected for processing (1)
  • opentracing/src/ngx_http_opentracing_module.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: Build Binaries (1.27.5)
  • GitHub Check: Build Binaries (1.18.0)
  • GitHub Check: Build Binaries (1.28.0)
  • GitHub Check: Build Binaries (1.27.3)
  • GitHub Check: Build Binaries (1.27.4)
  • GitHub Check: Build Binaries (1.27.0)
  • GitHub Check: Build Binaries (1.21.6)
  • GitHub Check: Build Binaries (1.26.1)
  • GitHub Check: Build Binaries (1.26.2)
  • GitHub Check: Build Binaries (1.23.4)
  • GitHub Check: Build Binaries (1.16.1)
  • GitHub Check: Build Binaries (1.17.10)
  • GitHub Check: Build Binaries (1.15.12)
  • GitHub Check: System Testing
  • GitHub Check: Build Docker Image (alpine)
  • GitHub Check: Build Docker Image (debian)
  • GitHub Check: Build Docker Image
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
opentracing/src/ngx_http_opentracing_module.cpp (1)

252-259: Excellent safety improvement - prevents potential null pointer dereference.

The reordering ensures that structure initialization only occurs after confirming the memory allocation succeeded. This change aligns with the pattern already used in create_opentracing_loc_conf and follows defensive programming best practices.

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

@lucacome lucacome requested a review from Copilot June 26, 2025 23:29
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors create_opentracing_main_conf to perform a null check immediately after memory allocation, preventing a potential null dereference.

  • Moves the default initialization (*main_conf = opentracing_main_conf_t()) below the null check.
  • Ensures nullptr is returned if ngx_pcalloc fails.
Comments suppressed due to low confidence (1)

opentracing/src/ngx_http_opentracing_module.cpp:255

  • [nitpick] Move this comment to just before the assignment on line 257 so it accurately describes the default initialization step and does not precede the null check.
  // Default initialize members.

@lucacome lucacome enabled auto-merge (squash) August 16, 2025 02:07
@lucacome lucacome disabled auto-merge August 18, 2025 15:21
@lucacome lucacome merged commit a0b2b1d into opentracing-contrib:master Aug 18, 2025
38 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Potential null dereference at ngx_http_opentracing_module.cpp

3 participants