📚 Doc: Update intro.md to make clear fiber.Ctx is not thread-safe.

[omaskery]

Description

Documentation change in intro.md to make it clear that fiber.Ctx is not thread-safe.

Fixes #3012

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

• Benchmarks: Describe any performance benchmarks and improvements related to the changes.
• Documentation Update: Detail the updates made to the documentation and links to the changed files.
• Changelog/What's New: Include a summary of the additions for the upcoming release notes.
• Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
• API Alignment with Express: Explain how the changes align with the Express API.
• API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
• Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)
• Enhancement (improvement to existing features and functionality)
• Documentation update (changes to documentation)
• Performance improvement (non-breaking change which improves efficiency)
• Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

• Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
• Conducted a self-review of the code and provided comments for complex or critical parts.
• Updated the documentation in the /docs/ directory for Fiber's documentation.
• Added or updated unit tests to validate the effectiveness of the changes or new features.
• Ensured that new and existing unit tests pass locally with the changes.
• Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
• Aimed for optimal performance with minimal allocations in the new code.
• Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

[welcome]

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The changes in docs/intro.md focus on clarifying the handling of fiber.Ctx within the Fiber framework to emphasize its non-immutable nature and the need for caution against reusability across requests. Additionally, the updates stress the non-thread-safe nature of fiber.Ctx, suggesting it should not be accessed concurrently by multiple goroutines. New references to related GitHub issues provide more comprehensive documentation for developers.

Changes

File	Change Summary
docs/intro.md	Clarified that values from fiber.Ctx are not immutable and can be reused across requests, highlighted thread safety concerns with fiber.Ctx, and provided new issue references.

Sequence Diagram(s)

Changes were documentation updates only, so no sequence diagrams are provided.

Assessment against linked issues

Objective	Addressed	Explanation
Document that fiber.Ctx is not thread-safe (#3012)	✅
Clarify that values from fiber.Ctx are non-immutable and reused (#3012)	✅
Provide references to related GitHub issues (#3012)	✅

Poem

In Fiber's realm, where data flows,
Beware, dear dev, as fiber.Ctx shows,
Non-immutable, the values glide,
Across requests, they take a ride.
Thread safety's mark, it cannot claim,
Handle with care, avoid the flame.
With wisdom now, your code will gleam,
Amidst the Fiber, rise supreme. 🚀

---

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.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fca62c1 and aaf5450.

Files selected for processing (1)

• docs/intro.md (2 hunks)

Additional Context Used

LanguageTool (2)

docs/intro.md (2)

Near line 14: Often, this adverbial phrase is redundant. Consider using an alternative.
Context: ... March XX, 2024. ### Installation First of all, download and ins...
Rule ID: FIRST_OF_ALL

---

Near line 119: The preposition ‘to’ seems more likely in this position.
Context: ...POST, etc. - path is a virtual path on the server - func(fiber.Ctx) error is...
Rule ID: AI_HYDRA_LEO_REPLACE_ON_TO

Markdownlint (24)

docs/intro.md (24)

61: Column: 1
Hard tabs

---

62: Column: 1
Hard tabs

---

64: Column: 1
Hard tabs

---

72: Column: 1
Hard tabs

---

88: Column: 1
Hard tabs

---

90: Column: 1
Hard tabs

---

91: Column: 1
Hard tabs

---

92: Column: 1
Hard tabs

---

94: Column: 1
Hard tabs

---

127: Column: 1
Hard tabs

---

137: Column: 1
Hard tabs

---

138: Column: 1
Hard tabs

---

148: Column: 1
Hard tabs

---

149: Column: 1
Hard tabs

---

150: Column: 1
Hard tabs

---

151: Column: 1
Hard tabs

---

152: Column: 1
Hard tabs

---

162: Column: 1
Hard tabs

---

163: Column: 1
Hard tabs

---

23: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

---

122: null
Emphasis used instead of a heading

---

131: null
Emphasis used instead of a heading

---

142: null
Emphasis used instead of a heading

---

156: null
Emphasis used instead of a heading

Additional comments not posted (2)

docs/intro.md (2)

24-28: Clarify thread safety of fiber.Ctx in the documentation.

The added documentation clearly states that fiber.Ctx is not thread-safe and provides guidance on how to handle context values safely. This should effectively address the concerns raised in issue #3012 and prevent misuse of fiber.Ctx in concurrent environments.

---

76-76: Link to related issues for further context.

Including links to related GitHub issues is a good practice as it provides users with more context and background information about the decisions made in the documentation.

[welcome]

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

[omaskery]

Hi, sorry I never got around to this, thanks @ReneWerner87 for doing this for me :)