Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
w3nl
force-pushed
the
feature/cache-api-docs-v1
branch
from
b7dd9bb to
300074a
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR implements HTTP caching for the API documentation endpoint to improve performance by allowing clients to cache the docs and avoid unnecessary data transfer when the specification hasn't changed.
- Adds ETag and Cache-Control headers to the
/api-docsendpoint - Implements conditional request handling with 304 Not Modified responses
- Updates test to verify caching behavior and header presence
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/api.js | Implements ETag generation and conditional request handling for API docs endpoint |
| src/server.test.js | Updates test to verify caching headers and 304 response behavior |
| package.json | Updates @trojs/lint dependency version |
Comment on lines
+99
to
+113
| const apiDocsString = JSON.stringify(this.specification) | ||
| const etag = `"${Buffer.from(apiDocsString).toString('base64')}"` | ||
|
|
||
| router.get('/api-docs', (request, response) => { | ||
| // Check for If-None-Match header | ||
| const ifNoneMatchHeader = request.headers['if-none-match'] | ||
| if (ifNoneMatchHeader) { | ||
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | ||
| if (etags.includes('*') || etags.includes(etag)) { | ||
| response.status(304).end() | ||
| return | ||
| } | ||
| } | ||
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | ||
| response.setHeader('ETag', etag) |
There was a problem hiding this comment.
Computing the ETag on every route registration is inefficient. The ETag should be computed once when the specification is set or changed, and stored as an instance variable to avoid repeated base64 encoding operations.
Suggested change
| const apiDocsString = JSON.stringify(this.specification) | |
| const etag = `"${Buffer.from(apiDocsString).toString('base64')}"` | |
| router.get('/api-docs', (request, response) => { | |
| // Check for If-None-Match header | |
| const ifNoneMatchHeader = request.headers['if-none-match'] | |
| if (ifNoneMatchHeader) { | |
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | |
| if (etags.includes('*') || etags.includes(etag)) { | |
| response.status(304).end() | |
| return | |
| } | |
| } | |
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | |
| response.setHeader('ETag', etag) | |
| router.get('/api-docs', (request, response) => { | |
| // Check for If-None-Match header | |
| const ifNoneMatchHeader = request.headers['if-none-match'] | |
| if (ifNoneMatchHeader) { | |
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | |
| if (etags.includes('*') || etags.includes(this.etag)) { | |
| response.status(304).end() | |
| return | |
| } | |
| } | |
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | |
| response.setHeader('ETag', this.etag) |
Comment on lines
+98
to
114
| // Generate an ETag for the specification (simple hash or JSON string) | ||
| const apiDocsString = JSON.stringify(this.specification) | ||
| const etag = `"${Buffer.from(apiDocsString).toString('base64')}"` | ||
|
|
||
| router.get('/api-docs', (request, response) => { | ||
| // Check for If-None-Match header | ||
| const ifNoneMatchHeader = request.headers['if-none-match'] | ||
| if (ifNoneMatchHeader) { | ||
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | ||
| if (etags.includes('*') || etags.includes(etag)) { | ||
| response.status(304).end() | ||
| return | ||
| } | ||
| } | ||
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | ||
| response.setHeader('ETag', etag) | ||
| response.json(this.specification) |
There was a problem hiding this comment.
JSON.stringify is called on every route registration which is unnecessary. This should be computed once and cached when the specification is available.
Suggested change
| // Generate an ETag for the specification (simple hash or JSON string) | |
| const apiDocsString = JSON.stringify(this.specification) | |
| const etag = `"${Buffer.from(apiDocsString).toString('base64')}"` | |
| router.get('/api-docs', (request, response) => { | |
| // Check for If-None-Match header | |
| const ifNoneMatchHeader = request.headers['if-none-match'] | |
| if (ifNoneMatchHeader) { | |
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | |
| if (etags.includes('*') || etags.includes(etag)) { | |
| response.status(304).end() | |
| return | |
| } | |
| } | |
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | |
| response.setHeader('ETag', etag) | |
| response.json(this.specification) | |
| router.get('/api-docs', (request, response) => { | |
| // Check for If-None-Match header | |
| const ifNoneMatchHeader = request.headers['if-none-match'] | |
| if (ifNoneMatchHeader) { | |
| const etags = ifNoneMatchHeader.split(',').map((tag) => tag.trim()) | |
| if (etags.includes('*') || etags.includes(this._cachedEtag)) { | |
| response.status(304).end() | |
| return | |
| } | |
| } | |
| response.setHeader('Cache-Control', 'public, max-age=3600, must-revalidate') | |
| response.setHeader('ETag', this._cachedEtag) | |
| response.json(JSON.parse(this._cachedApiDocsString)) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.