docs: Improve ctx.Locals method description and example #3030
Conversation
WalkthroughThe update enhances Fiber's Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FiberApp
participant Ctx
participant Handler
User->>FiberApp: Send Request
FiberApp->>Ctx: Store variable with Locals(key, value)
FiberApp->>Handler: Process Request
Handler->>Ctx: Retrieve variable with Locals(key)
Handler->>FiberApp: Return Response
FiberApp->>Ctx: Remove stored variable and call Close if io.Closer
Ctx->>FiberApp: Confirm Cleanup
FiberApp->>User: Send Response
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/api/ctx.md (1 hunks)
Additional context used
LanguageTool
docs/api/ctx.md
[uncategorized] ~242-~242: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...aw()) // []byte("user=john") }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~262-~262: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...dy()) // []byte("user=john") }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~316-~316: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...lhost:3000/?name=john&pass=doe" ``` > _Returned value is only valid within the handler....
[style] ~373-~373: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... information from a ClientHello message in order to guide application logic in the GetCerti...
[typographical] ~396-~396: Consider adding a comma here. (PLEASE_COMMA)
Context: ...text() *fasthttp.RequestCtx ``` :::info Please read the [Fasthttp Documentation](https...
[uncategorized] ~486-~486: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...y", "doe") // "doe" // ... }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~576-~576: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... or "" if not exist // .. }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~581-~581: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...icate that the client cache is now stale and the full response should be sent. When...
[uncategorized] ~612-~612: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ..., "john") // "john" // .. }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~623-~623: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...eqHeaders() map[string][]string ``` > _Returned value is only valid within the handler....
[uncategorized] ~647-~647: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ..., "john") // "john" // .. }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~658-~658: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...spHeaders() map[string][]string ``` > _Returned value is only valid within the handler....
[uncategorized] ~704-~704: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...() // "google.com" // ... }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~1051-~1051: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...earch?q=something" // ... }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~1055-~1055: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...e..._](../#zero-allocation) ## Params Method can be used to get the route parameters...
[uncategorized] ~1100-~1100: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...f the first wildcard segment }) ``` > _Returned value is only valid within the handler....
[uncategorized] ~1104-~1104: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...._](../#zero-allocation) ## ParamsInt Method can be used to get an integer from the ...
[grammar] ~1191-~1191: Did you mean “are” or “were”? (SENT_START_NNS_IS)
Context: ..." // ... }) ``` ## Queries Queries is a function that returns an object conta...
[uncategorized] ~1277-~1277: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... "nike") // "nike" // ... }) ``` > _Returned value is only valid within the handler....
[typographical] ~1409-~1409: Consider adding a comma here. (PLEASE_COMMA)
Context: ...t" ``` :::info For more parser settings please look here Config :::...
[uncategorized] ~1503-~1503: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...ects back to refer URL. It redirects to fallback URL if refer header doesn't exists, wit...
[uncategorized] ~1503-~1503: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...er URL. It redirects to fallback URL if refer header doesn't exists, with specified s...
[grammar] ~1503-~1503: The auxiliary verb ‘do’ requires the base form of the verb. (DID_BASEFORM)
Context: ...to fallback URL if refer header doesn't exists, with specified status, a positive inte...
[uncategorized] ~1529-~1529: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ... data and sends atext/htmlresponse. By defaultRenderuses the default [**Go Templat...
[style] ~1529-~1529: To make your writing clearer, consider a more direct alternative. (TAKE_A_LOOK)
Context: ...want to use another View engine, please take a look at our [Template middleware](h...
[grammar] ~1537-~1537: Please check the verb form. (SHE_LIVE)
Context: ....string) error ``` ## Request Request return the [*fasthttp.Request](https://godoc....
[style] ~1537-~1537: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...Request Request return the [*fasthttp.Request](https://godoc.org/github.com/valyala/f...
[grammar] ~1587-~1587: Please check the verb form. (SHE_LIVE)
Context: ...s: shoe,hat" ``` ## Response Response return the [*fasthttp.Response](https://godoc...
[style] ~1587-~1587: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...sponse Response return the [*fasthttp.Response](https://godoc.org/github.com/valyala/f...
[uncategorized] ~1603-~1603: There should be no space here. (EG_SPACE)
Context: ...y be helpful after overriding the path, i. e. an internal redirect. Note that handler...
[uncategorized] ~1603-~1603: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Note that handlers might be executed again which could result in an infinite loop....
[uncategorized] ~1657-~1657: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... return err } } ``` ## SaveFile Method is used to save any multipart file ...
[uncategorized] ~1690-~1690: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...n err } }) ``` ## SaveFileToStorage Method is used to save any multipart file ...
[uncategorized] ~1794-~1794: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...fo If the file contains an url specific character you have to escape it before passing th...
Markdownlint
docs/api/ctx.md
1201-1201: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1202-1202: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1203-1203: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1204-1204: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1205-1205: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1213-1213: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1214-1214: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1215-1215: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1223-1223: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1224-1224: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1225-1225: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1226-1226: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1234-1234: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1235-1235: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1236-1236: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1244-1244: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1245-1245: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1246-1246: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1247-1247: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1248-1248: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1249-1249: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1298-1298: Column: 1 (MD010, no-hard-tabs)
Hard tabs
1399-1399: Column: 1 (MD010, no-hard-tabs)
Hard tabs
Additional comments not posted (1)
docs/api/ctx.md (1)
903-924: The documentation and example forctx.Localsmethod have been significantly improved to enhance clarity and prevent common mistakes like unintentional resource closures. The addition of type assertions and the use of non-exported types as keys are best practices that help avoid potential runtime errors and key collisions, respectively. These changes align well with the PR's objectives to enhance clarity and safety in usingctx.Locals.
Description
Improve the
ctx.Localsdocumentation to clarify the behavior of stored variables and their lifecycle to avoid unintentional resource closures, and provide best practices with keys and values.Changes Introduced
io.Closerinterface, itsClosemethod will be called before it's removed.Details
docs/api/ctx.mdLocalsmethod documentation.ctx.Localsregarding variable removal andio.Closerinterface handling.These changes aim to prevent issues with unintentional resource closures, such as database connections, and enhance the clarity and safety of using
ctx.Localsinfasthttp.