Fixes Otel Shutdown by kans · Pull Request #353 · ConductorOne/baton-sdk

kans · 2025-04-10T23:10:26Z

Summary by CodeRabbit

Bug Fixes
- Enhanced shutdown error handling by ensuring cleanup tasks only run when safely initialized, improving system stability and reducing the risk of runtime issues.
New Features
- Introduced a timeout for the OpenTelemetry shutdown process, ensuring it completes within a defined period.

coderabbitai · 2025-04-10T23:10:33Z

Walkthrough

The pull request modifies the shutdown logic for the OpenTelemetry (otel) process in two files: pkg/cli/lambda_server__added.go and pkg/cli/commands.go. It introduces conditional checks to ensure that otelShutdown is not nil before invoking it, preventing potential nil pointer dereferences. Additionally, a context with a 5-second deadline is created for the shutdown calls, enhancing error handling during the shutdown process.

Changes

File Path	Change Summary
pkg/cli/lambda_server__added.go	Modified the `OptionallyAddLambdaCommand` function to include a nil check for `otelShutdown` before deferring its call.
pkg/cli/commands.go	Added a constant `otelShutdownTimeout` set to 5 seconds and updated `MakeMainCommand` and `MakeGRPCServerCommand` to create a context with a deadline for `otelShutdown`, including a nil check before calling it.

Sequence Diagram(s)

sequenceDiagram
    participant F as OptionallyAddLambdaCommand
    participant S as otelShutdown

    F->>F: Begin execution of OptionallyAddLambdaCommand
    alt otelShutdown is initialized
        F->>F: Defer execution of otelShutdown
    else otelShutdown not initialized
        F->>F: Skip deferring shutdown
    end
    F->>F: Continue with function execution and exit (trigger deferred calls if any)

Poem

I hop through code with joyful cheer,
Conditional checks now keep danger clear.
No more nil to halt my stride,
Safe shutdown now rides by my side.
With careful care, our code is bright—
Hop on, dear friend, into the night!
🐇✨

📜 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 666adc6 and f36f90a.

📒 Files selected for processing (2)

pkg/cli/commands.go (4 hunks)
pkg/cli/lambda_server__added.go (2 hunks)

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

pkg/cli/commands.go
pkg/cli/lambda_server__added.go

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: go-test (1.23.x, windows-latest)

🪧 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 plan to trigger planning for file edits and PR creation.
@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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

pkg/cli/lambda_server__added.go (1)
82-82: Consider using the existing context.

You're creating a new background context for the shutdown operation rather than using the existing runCtx. While this works, using the existing context would maintain any timeout or cancellation signals that might be important during shutdown.
-        err := otelShutdown(context.Background())
+        err := otelShutdown(runCtx)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b63aa1 and 420180a.

📒 Files selected for processing (1)

pkg/cli/lambda_server__added.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: go-test (1.23.x, windows-latest)

🔇 Additional comments (1)

pkg/cli/lambda_server__added.go (1)

80-87: Good defensive programming to prevent a nil pointer dereference.

This change properly checks if otelShutdown is not nil before attempting to defer its execution, preventing a potential runtime panic. This is an important bug fix, especially since initOtel could return an error while keeping otelShutdown as nil.

pquerna · 2025-04-10T23:18:22Z

pkg/cli/lambda_server__added.go

-		}()
+		if otelShutdown != nil {
+			defer func() {
+				err := otelShutdown(context.Background())


should this itself have a 5 second shutdown or something?

ggreer · 2025-04-10T23:48:07Z

pkg/cli/lambda_server__added.go

 				zap.L().Error("error shutting down otel", zap.Error(err))
 			}
-		}()
+		}()	}


I'm pretty sure this is a syntax error but I guess we don't lint this file?

coderabbitai bot reviewed Apr 10, 2025

View reviewed changes

kans enabled auto-merge (squash) April 10, 2025 23:15

pquerna reviewed Apr 10, 2025

View reviewed changes

kans force-pushed the kans/otel-shutdown branch 2 times, most recently from 2b3da51 to 666adc6 Compare April 10, 2025 23:30

ggreer reviewed Apr 10, 2025

View reviewed changes

the shutdown function may be nil

f36f90a

kans force-pushed the kans/otel-shutdown branch from 666adc6 to f36f90a Compare April 10, 2025 23:50

ggreer approved these changes Apr 10, 2025

View reviewed changes

kans merged commit 8395fee into main Apr 10, 2025
4 checks passed

kans deleted the kans/otel-shutdown branch April 10, 2025 23:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes Otel Shutdown #353

Fixes Otel Shutdown #353
kans merged 1 commit intomainfrom
kans/otel-shutdown

kans commented Apr 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 10, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pquerna Apr 10, 2025

Uh oh!

kans Apr 10, 2025

Uh oh!

ggreer Apr 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

kans commented Apr 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

pquerna Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

kans Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

ggreer Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kans commented Apr 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)