Alternate fix for env variable in lib/config.js
#23
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
Expectiaton: the `env` variable can be one of three possible values: 'production', 'staging' or 'cam'. Reality: Due to the nature of the environment the code runs in, this line... ``` var envFromShell = process.env.NODE_ENV; ``` ...can return any number of different values, from 'staging' to 'development', etc. This will cause issues when we have... ``` var env = envFromBrowser || envFromShell || DEFAULT_ENV; ``` ...as `env` will now take on an invalid value. Fix: See the code.
| @@ -37,6 +37,11 @@ var envFromShell = process.env.NODE_ENV; | |||
|
|
|||
| var env = envFromBrowser || envFromShell || DEFAULT_ENV; | |||
|
|
|||
| if (!env.match(/^(production|staging|cam)$/)) { | |||
| throw 'Panoptes Javascript Client Error: Invalid Environment; ' + | |||
There was a problem hiding this comment.
This throws a string, which is generally unexpected. Try throw new Error('...').
|
Acknowledged; whitelist now updated to throw an Error instead of a string. |
brian-c
added a commit
that referenced
this pull request
Feb 5, 2016
Alternate fix for `env` variable in lib/config.js
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.
Bugfix: 'env' variable in config.js was returning invalid values.
This PR (a whitelist+fail dangerous fix) is an alternative to PR #22 (a fallback+failsafe fix). Please close PR #22 if this PR is merged, or vice versa.
Symptoms:
Uncaught SugarClient.host is not definedAnalysis:
envvariable in lib/config.js doesn't always have one the valid values, i.e. 'production', 'staging' or 'cam'.Actions:
envvar cannot be invalid; throw an error otherwise.@brian-c , this is based on our discussion in #22 (comment) and is ready for yor review, arigato.