docs: add client connection closure guidance

[crStiv]

Add important note about properly closing client connections in the Golang
client library tutorial. This helps prevent resource leaks when using
the client, especially with WebSocket connections.

• Add section about client.Close()
• Include code example with defer statement

Summary by CodeRabbit

• Documentation
  • Updated Golang client library tutorial with a critical note about closing client connections to prevent resource leaks.
  • Added guidance on proper resource management with a code snippet demonstrating defer client.Close().

[coderabbitai]

Walkthrough

The pull request updates the Golang client tutorial documentation by introducing a critical note on resource management. A new section emphasizes the necessity of closing the client connection to prevent resource leaks, demonstrated by adding the defer client.Close() statement in multiple function implementations. The changes ensure proper closure of client connections in the SubmitBlob, SubscribeBlobs, SubscribeHeaders, and GetEDS functions, while the rest of the document remains unchanged.

Changes

File	Change Summary
tutorials/golang-client-tutorial.md	Added a new section highlighting the importance of closing client connections using defer client.Close() in SubmitBlob, SubscribeBlobs, SubscribeHeaders, and GetEDS functions to prevent resource leaks.

Possibly related PRs

• wip: golang client tut #1559: The changes in this PR involve the SubmitBlob, SubscribeHeaders, and GetEDS functions, which are also modified in the main PR to include resource management practices, indicating a direct connection in the tutorial content related to these functions.

Poem

🐰 A Rabbit's Resource Management Rhyme 🔗
Defer and close, oh client so bright,
Prevent those leaks with all your might!
Resources freed, connections clean,
A tutorial tip that's rarely seen.
Code flows smoothly, no memory strain.

---

📜 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 f135771 and 971c51d.

📒 Files selected for processing (1)

• tutorials/golang-client-tutorial.md (5 hunks)

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

• tutorials/golang-client-tutorial.md

---

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>, 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

tutorials/golang-client-tutorial.md (1)

21-25: Consider enhancing the existing code examples with connection closure.

While the new section effectively introduces the concept, it would be beneficial to demonstrate this practice in all the code examples throughout the tutorial. This would reinforce the importance of proper connection management and provide consistent examples.

Here's how the SubmitBlob example could be updated:

 func SubmitBlob(ctx context.Context, url string, token string) error {
 	client, err := client.NewClient(ctx, url, token)
 	if err != nil {
 		return err
 	}
+	defer client.Close()

Similar updates should be made to SubscribeBlobs, SubscribeHeaders, and GetEDS functions.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a68870a and f135771.

📒 Files selected for processing (1)

• tutorials/golang-client-tutorial.md (1 hunks)

🔇 Additional comments (1)

tutorials/golang-client-tutorial.md (1)

21-25: LGTM! Great addition to prevent resource leaks.

The added note about closing client connections is crucial for proper resource management, especially when dealing with WebSocket connections.

[nuke-web3]

Nice spot, there is precedence for this pattern upstream

I would want to update snippets and examples despite @coderabbitai liking it:

This addition provides developers with guidance on best practices for managing client connections in the tutorial, without modifying the existing code examples or functionality.

Here and upstream in the OpenRPC README too. Perhaps looking for other low handing defer inclusions in them (plus a comment if needed to say why)

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@nuke-web3 I agree with updating the code examples. Here are the locations where we should add defer client.Close() right after client creation:

1. In golang-client-tutorial.md:

   • SubmitBlob function
   • SubscribeBlobs function
   • SubscribeHeaders function
   • GetEDS function

2. In prompt-scavenger.md:

   • main function (already has it)
   • SubmitBlob function

3. In submit-data.md:

   • SubmitBlob example in "The celestia-node API golang client" section

Additionally, we should update the OpenRPC README as you suggested. Would you like me to open a GitHub issue to track these changes as a follow-up task?

🔗 Analysis chain

---

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find and examine the tutorial file
fd "golang-client-tutorial.md" --exec cat {}

# Try to find any other relevant Go files with examples
fd -e go -e md . --exec grep -l "NewClient"

Length of output: 6708

---

Script:

#!/bin/bash
# Check the content of the other files
echo "=== prompt-scavenger.md ==="
cat ./tutorials/prompt-scavenger.md
echo -e "\n=== submit-data.md ==="
cat ./how-to-guides/submit-data.md

Length of output: 29175

---

✏️ Learnings added

Learnt from: nuke-web3
URL: https://github.com/celestiaorg/docs/pull/1860

Timestamp: 2025-01-16T23:44:32.472Z
Learning: Always include `defer client.Close()` immediately after creating a new client connection using `client.NewClient()` to prevent resource leaks, especially with WebSocket connections.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

[crStiv]

Nice spot, there is precedence for this pattern upstream

I would want to update snippets and examples despite @coderabbitai liking it:

This addition provides developers with guidance on best practices for managing client connections in the tutorial, without modifying the existing code examples or functionality.

Here and upstream in the OpenRPC README too. Perhaps looking for other low handing defer inclusions in them (plus a comment if needed to say why)

@nuke-web3 made an update, does that seem right?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@crStiv Yes, the changes look perfect! You've added defer client.Close() to all the relevant functions (SubmitBlob, SubscribeBlobs, SubscribeHeaders, and GetEDS) and included helpful comments explaining the importance of closing the connections. The addition of the prominent note at the beginning of the tutorial about connection closure is also a great touch.

🔗 Analysis chain

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the current state of the tutorial file
echo "=== golang-client-tutorial.md ==="
fd "golang-client-tutorial.md" --exec cat {}

# Check if the changes include defer client.Close() in all functions
echo -e "\n=== Checking for client.Close() usage ==="
fd "golang-client-tutorial.md" --exec grep -A 5 "NewClient" {}

Length of output: 8165

---

If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!