Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add warning when using react-error-overlay in production #3264

Merged
merged 3 commits into from
Oct 11, 2017
Merged

Add warning when using react-error-overlay in production #3264

merged 3 commits into from
Oct 11, 2017

Conversation

Timer
Copy link
Contributor

@Timer Timer commented Oct 11, 2017 •
edited
Loading

This logs a warning when the overlay is included in an envified production build or strictly minified build.

@Timer Timer added this to the 1.0.x milestone Oct 11, 2017
Timer
Timer commented Oct 11, 2017
View reviewed changes
packages/react-error-overlay/src/index.js Outdated
);
}
} else {
console.warn(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this could be more severe with console.error, or perhaps throw.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it makes more sense to go with warn as it's technically not an error.

@react-scripts-dangerous
Copy link

Hello! I'm a bot that helps facilitate testing pull requests.

Your pull request (commit 2410af7) has been released on npm for testing purposes.

npm i [email protected]
# or
yarn add [email protected]
# or
create-react-app [email protected] folder/

Note that the package has not been reviewed or vetted by the maintainers. Only install it at your own risk!

Thanks for your contribution!

gaearon
gaearon reviewed Oct 11, 2017
View reviewed changes
Copy link
Contributor

@gaearon gaearon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below.

Also, are we bundling with production version of React? We should.

packages/react-error-overlay/src/index.js Outdated
const warningText =
'When deploying an application, `react-error-overlay` should be excluded ' +
'as it is a heavy dependency meant for development.\n\n' +
'Consider adding an error boundary to your tree to customize error ' +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need the error boundary text here? Doesn't seem very relevant.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone was purposely including react-error-overlay for production errors, though I know most cases would be accidental.

We can remove this.

packages/react-error-overlay/src/index.js Outdated

if (process.env.NODE_ENV !== 'production') {
var testFunc = function testFn() {};
if ((testFunc.name || testFunc.toString()).indexOf('testFn') === -1) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

toString() is not guaranteed to be safe. I'd opt to remove this branch completely and for now just assume process.env.NODE_ENV is correct. We have detection in React DevTools for other cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this would probably error out if they did not envify variables, so I agree.

@Timer Timer mentioned this pull request Oct 11, 2017
Merged
@Timer Timer merged commit 9ce144e into facebook:master Oct 11, 2017
@Timer Timer deleted the prod-warning branch October 11, 2017 18:20
datchley pushed a commit to Tandemly/create-react-app that referenced this pull request Oct 13, 2017
@backstroke-bot @dmatchley
Update from upstream repo facebookincubator/create-react-app@master (#3)
ae3fa51 
* `react-error-overlay` has no dependencies now (facebook#3263)

* `react-error-overlay` has no dependencies now (it's bundled)

* Use babel 6 for now

* Add external links to deployment services (facebook#3265)

* Add warning when using `react-error-overlay` in production (facebook#3264)

* Add a warning when running minified

* Add more robust check

* Update index.js

* Use production React version for bundled overlay (facebook#3267)

* Use production React version

* We cannot strip our own checks if production

* Keep the sourcemap during minify

* Prevent devtools pollution

* Add some comments

* sigh
datchley pushed a commit to Tandemly/create-react-app that referenced this pull request Oct 17, 2017
@backstroke-bot @dmatchley
Update from upstream repo facebookincubator/create-react-app@master (#4)
0cbbf89 
* `react-error-overlay` has no dependencies now (facebook#3263)

* `react-error-overlay` has no dependencies now (it's bundled)

* Use babel 6 for now

* Add external links to deployment services (facebook#3265)

* Add warning when using `react-error-overlay` in production (facebook#3264)

* Add a warning when running minified

* Add more robust check

* Update index.js

* Use production React version for bundled overlay (facebook#3267)

* Use production React version

* We cannot strip our own checks if production

* Keep the sourcemap during minify

* Prevent devtools pollution

* Add some comments

* sigh

* Fix dead link to Jest "expect" docs (facebook#3289)

Closes facebook#3291
matart15 pushed a commit to matart15/create-react-app that referenced this pull request Oct 19, 2017
Merge branch 'master' of https://github.com/facebookincubator/create-…
24dfb58 
…react-app

* 'master' of https://github.com/facebookincubator/create-react-app:
  Update README.md
  Fix dead link to Jest "expect" docs (facebook#3289)
  Use production React version for bundled overlay (facebook#3267)
  Add warning when using `react-error-overlay` in production (facebook#3264)
  Add external links to deployment services (facebook#3265)
  `react-error-overlay` has no dependencies now (facebook#3263)
  Add click-to-open support for build errors (facebook#3100)
  Update style-loader and disable inclusion of its HMR code in builds (facebook#3236)
  Update url-loader to 0.6.2 for mime ReDoS vuln (facebook#3246)
@gaearon gaearon mentioned this pull request Oct 30, 2017
Merged
@dependencies dependencies bot mentioned this pull request Oct 31, 2017
Merged
datchley pushed a commit to Tandemly/create-react-app that referenced this pull request Dec 20, 2017
@backstroke-bot @dmatchley
Update from upstream repo facebookincubator/create-react-app@master (#3)
f5aa200 
* `react-error-overlay` has no dependencies now (facebook#3263)

* `react-error-overlay` has no dependencies now (it's bundled)

* Use babel 6 for now

* Add external links to deployment services (facebook#3265)

* Add warning when using `react-error-overlay` in production (facebook#3264)

* Add a warning when running minified

* Add more robust check

* Update index.js

* Use production React version for bundled overlay (facebook#3267)

* Use production React version

* We cannot strip our own checks if production

* Keep the sourcemap during minify

* Prevent devtools pollution

* Add some comments

* sigh
suutari-ai referenced this pull request in andersinno/create-react-app-ai Jan 25, 2018
@suutari-ai
Merge branch 'master' of https://github.com/wmonk/create-react-app-ty…
7227b64 
…pescript

* 'master' of https://github.com/wmonk/create-react-app-typescript: (265 commits)
  fix typo in changelog
  Update README For 2.13.0
  v2.13.0
  Remove tslint-loader from prod build (again)
  Include TypeScript as devDependency in boilerplate output
  Documented how to define custom module formats for the TypeScript compiler so that you can import images and other files (references wmonk#172)
  v2.12.0
  Update README For 2.12.0
  Update typescript to 2.6.2
  v2.11.0
  Update changelog for 2.11.0
  Fixed problem with tsconfig.json baseUrl and paths
  Update createJestConfig.js
  Update changelog for 2.10.0
  v2.10.0
  Readd transformIgnorePatterns
  Update react-dev-utils
  Update package.json dependencies
  Readd Missing raf Package
  Update JestConfig Creation
  Fix
  Fix Missing Variable
  Fix package.json
  Merge pull request wmonk#204 from StefanSchoof/patch-1
  Merge pull request wmonk#201 from StefanSchoof/patch-1
  Merge pull request wmonk#199 from DorianGrey/master
  Merge pull request wmonk#165 from johnnyreilly/master
  Publish
  Add 1.0.17 changelog (#3402)
  Use new WebpackDevServer option (#3401)
  Fix grammar in README (#3394)
  Add link to VS Code troubleshooting guide (#3399)
  Update VS Code debug configuration (#3400)
  Update README.md (#3392)
  Publish
  Reorder publishing instructions
  Changelog for 1.0.16 (#3376)
  Update favicon description (#3374)
  Changelog for 1.0.15 (#3357)
  Replace template literal; fixes #3367 (#3368)
  [email protected]
  Publish
  Add preflight CWD check for npm (#3355)
  Stop using `npm link` in tests (#3345)
  Fix for add .gitattributes file #3080 (#3122)
  Mention that start_url needs to be "." for client side routing
  start using npm-run-all to build scss and js (#2957)
  Updating the Service Worker opt-out documentation (#3108)
  Remove an useless negation in registerServiceWorker.js (#3150)
  Remove output.path from dev webpack config (#3158)
  Add `.mjs` support (#3239)
  Add documentation for Enzyme 3 integration (#3286)
  Make uglify work in Safari 10.0 - fixes #3280 (#3281)
  Fix favicon sizes value in manifest (#3287)
  Bump dependencies (#3342)
  recommend react-snap; react-snapshot isn't upgraded for React 16 (#3328)
  Update appveyor.cleanup-cache.txt
  Polyfill rAF in test environment (#3340)
  Use React 16 in development
  Use a simpler string replacement for the overlay
  Clarify the npm precompilation advice
  --no-edit
  Update `eslint-plugin-react` (#3146)
  Add jest coverage configuration docs (#3279)
  Update link to Jest Expect docs (#3303)
  Update README.md
  Fix dead link to Jest "expect" docs (#3289)
  v2.8.0
  Use production React version for bundled overlay (#3267)
  Add warning when using `react-error-overlay` in production (#3264)
  Add external links to deployment services (#3265)
  `react-error-overlay` has no dependencies now (#3263)
  Add click-to-open support for build errors (#3100)
  Update style-loader and disable inclusion of its HMR code in builds (#3236)
  Update url-loader to 0.6.2 for mime ReDoS vuln (#3246)
  Make error overlay to run in the context of the iframe (#3142)
  Upgrade to typescript 2.5.3
  Fix Windows compatibility (#3232)
  Fix package management link in README (#3227)
  Watch for changes in `src/**/node_modules` (#3230)
  More spec compliant HTML template (#2914)
  Minor change to highlight dev proxy behaviour (#3075)
  Correct manual proxy documentation (#3185)
  Improve grammar in README (#3211)
  Publish
  Fix license comments
  Changelog for 1.0.14
  BSD+Patents -> MIT (#3189)
  Add link to active CSS modules discussion (#3163)
  Update webpack-dev-server to 2.8.2 (#3157)
  Part of class fields to stage 3 (#2908)
  Update unclear wording in webpack config docs (#3160)
  Display pid in already running message (#3131)
  Link local react-error-overlay package in kitchensink test
  Resolved issue #2971 (#2989)
  Revert "run npm 5.4.0 in CI (#3026)" (#3107)
  Updated react-error-overlay to latest Flow (0.54.0) (#3065)
  Auto-detect running editor on Linux for error overlay (#3077)
  Clean target directory before compiling overlay (#3102)
  Rerun prettier and pin version (#3058)
  ...
This was referenced Feb 2, 2018
Open
Closed
@lock lock bot locked and limited conversation to collaborators Jan 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gaearon gaearon gaearon left review comments

@tharakawj tharakawj tharakawj approved these changes

Assignees
No one assigned
Labels
CLA Signed tag: internal
Projects
None yet
Milestone
1.0.x
Development

Successfully merging this pull request may close these issues.
5 participants
@Timer @react-scripts-dangerous @gaearon @tharakawj @facebook-github-bot