fix: NOOP spans when context is missing

[nidhi-nair]

Description

When auto-commits are triggered, the execution starts with no MDC context established. The observation helper assumed that this context would always be present and would hence error out during such events. This PR handles scenarios when context is absent by skipping the span entirely.

If we wish to log auto-commit related spans, we will need to take that up separately by figuring out which trace we'd like to attach the span to.

Fixes #30721

Automation

/ok-to-test tags="@tag.Git"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8846591111
Commit: 50ad334
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

• Yes
• No

Summary by CodeRabbit

• Refactor
  • Improved error handling in span creation by checking for specific keys before generating trace contexts, enhancing robustness and reliability.
• Tests
  • Added test cases to verify the behavior of span creation under various conditions.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates in the Appsmith server project focus on enhancing the robustness of span creation within the ObservationHelperImpl class. The modifications ensure that trace context creation checks for necessary keys in the context map before proceeding, thereby improving error handling. Additionally, the associated tests verify the behavior under various contexts.

Changes

File Path	Summary of Changes
.../appsmith-server/src/main/java/com/appsmith/server/helpers/ObservationHelperImpl.java	Updated to handle creation of spans more robustly by checking context map for specific keys before creating a trace context.
.../appsmith-server/src/test/java/com/appsmith/server/helpers/ObservationHelperTest.java	Contains test cases for verifying the new behavior of span creation under different MDC contexts.

Assessment against linked issues

Objective	Addressed	Explanation
[#30721]: Auto commit not running on git import of old version	❌	The changes in this pull request are related to span creation and error handling in tracing and do not address issues related to git import or auto commit functionality in the application.

The current changes focus solely on the tracing and logging aspects of the server's functionality and do not intersect with the git import or commit processes described in the linked issue.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 50ad334 and d83e25d.

Files selected for processing (1)

• app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/ObservationHelperImpl.java (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/ObservationHelperImpl.java

---

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

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/helpers/ObservationHelperImpl.java (1)

30-42: The modifications to handle missing MDC context keys before span creation are well-implemented.

Consider adding a comment before line 41 explaining why Span.NOOP is returned when the context keys are missing. This can improve code readability and maintainability.

[sondermanish]

nit pick: let's flip the conditional?