chore(server): document why crossOriginEmbedderPolicy is disabled (#350)#351
Merged
Merged
Conversation
The helmet config disables `crossOriginEmbedderPolicy` alongside the documented `contentSecurityPolicy: false`, but the COEP=false line had no comment explaining why. A future contributor reading the block could either assume it was an oversight (and try to re-enable it) or copy the pattern into a different app without understanding the constraint. Add the rationale: Swagger UI at /docs loads theme assets cross-origin, and helmet's default `require-corp` value blocks any sub-resource that doesn't explicitly opt into CORP/CORS. Since this API has no other browser-facing HTML, leaving COEP off is the lower-risk choice; operators adding embedded dashboards should configure helmet directly rather than re-enabling COEP at this layer. Comment-only — no behavior change, tests stay green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #350.
Summary
Adds an inline rationale comment for
crossOriginEmbedderPolicy: falseinserver.js's helmet config. Comment-only.Test plan
npm run lint && npm test— 793 passing (no behavior change).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/