Improve development/test env error messages for Stitches #114
Conversation
This file contains 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
zorab47
commented
Nov 9, 2023
lib/stitches/api_key.rb
Outdated
| message = "no authorization header" | ||
|
|
||
| if Rails.env.test? || Rails.env.development? | ||
| message += "(Development/Test Env Hint: Stitches issue; confirm your API key header is set OR check the `allowlist_regex` for this path)" |
There was a problem hiding this comment.
I also considered including the regex for reference. 🤔
zorab47
requested review from
brettfishman,
bwebster and
a team
as code owners
zorab47
force-pushed
the
improve-stitches-unauthorized-message-for-dev-test-envs
branch
from
eb7da01
to
56086eb
Compare
linux2647
reviewed
Nov 9, 2023
zorab47
force-pushed
the
improve-stitches-unauthorized-message-for-dev-test-envs
branch
from
56086eb
to
85fc6f2
Compare
ebarendt
approved these changes
Nov 9, 2023
The current error message isn't helpful for development, so provide a helpful hint in the Rails development and test environments.
zorab47
force-pushed
the
improve-stitches-unauthorized-message-for-dev-test-envs
branch
from
85fc6f2
to
773dccd
Compare
AddieEli
approved these changes
Nov 10, 2023
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.
Problem
The current error message isn't helpful for developers during local development. It is always a confusing experience when the following is displayed unless you're familiar with Stitches:
Solution
Provide a helpful hint in the Rails development and test environments pointing to missing headers or mismatched
allowlist_regex.