Add a script for extracting error codes #6882

keyz · 2016-05-26T06:04:16Z

As we talked in #6874, this is the first step that extracts error codes to a JSON file. The script adds any new error messages to the end of the file without changing existing codes. The traversal order of files is determined by their path names so that the result is stable.

I added babel-traverse and babylon as new dev dependencies, but they are already required by babel-core so we actually just lifted them up.

Thanks for reviewing! CC @spicyj

A few things left:

Rename files
~~Require glob patterns rather than copy them~~ Use gulp

ghost · 2016-05-26T18:39:28Z

@keyanzhang updated the pull request.

iamdustan · 2016-05-27T10:59:13Z

scripts/error-extractor/parseJSFile.js

+  var source = fs.readFileSync(filePath, 'utf8');
+  return babylon.parse(source, {
+    sourceType: 'module',
+    plugins: [


should this use the same config from 'babel-preset-fbjs' in #6876?

Hey, thanks for catching this! This is kinda tricky -- as a parser, babylon has its own options here and it's different from babel's so we can't directly import/require it. All our syntax (parser)-related configs are specified here in fbjs. I'll update this one to make sure they are the same.

facebook-github-bot · 2016-05-27T12:36:46Z

@keyanzhang updated the pull request.

keyz · 2016-05-27T12:38:56Z

@zpao the tests pass locally but not on travis. Could this be a caching-related issue? https://travis-ci.org/facebook/react/jobs/133367229

sophiebits · 2016-05-31T20:56:17Z

package.json

@@ -95,6 +97,7 @@
    "testPathDirs": [
      "<rootDir>/eslint-rules",
      "<rootDir>/mocks",
+      "<rootDir>/scripts/error-extractor",


Let's just add all of scripts here in case we want to add more later.

facebook-github-bot · 2016-05-31T22:50:57Z

@keyanzhang updated the pull request.

sophiebits · 2016-05-31T23:32:40Z

scripts/error-codes/extractErrors.js

+
+var evalToString = require('./evalToString');
+var invertObject = require('./invertObject');
+var safeParseJSON = require('./safeParseJSON');


As discussed in person, let's move this back inline – but move all the logic in this file into top-level functions and then just call it at the end of the file.

facebook-github-bot · 2016-06-01T00:15:26Z

@keyanzhang updated the pull request.

keyz · 2016-06-01T02:57:26Z

@zpao @spicyj I rewrote the script to a gulp plugin. Would you take a look and let me know what you think? Thanks!

facebook-github-bot · 2016-06-01T03:18:35Z

@keyanzhang updated the pull request.

sophiebits · 2016-06-01T17:37:43Z

This looks great. Two things:

Can we call the directory "error-codes" not "error-code"?
Can we make Travis run the gulp script to make sure it runs without crashing? You can add it after this git checkout line:

react/.travis.yml

Line 83 in 51f8b1b

git checkout -- src/renderers/dom/shared/ReactDOMFeatureFlags.js

.

Otherwise this looks great – feel free to merge whenever.

zpao · 2016-06-01T18:02:58Z

scripts/error-codes/gulp-extract-errors.js

+  function flush(cb) {
+    fs.writeFile(
+      errorMapFilePath,
+      JSON.stringify(invertObject(existingErrorMap), null, 2) + os.EOL,


I think we probably actually want to just use '\n' so we generate the same file on Windows. Or even just leave off the newline.

ghost · 2016-06-01T18:03:56Z

@keyanzhang updated the pull request.

ghost · 2016-06-01T18:26:57Z

@keyanzhang updated the pull request.

(cherry picked from commit bfd1531)

…help from 1d0c1b1 to get the basic gulp setup (0.14 beta v2 code), and took a lot of dependency wrangling. `grunt extract-errors` should run the script now. I'm starting with a fresh codes.json because these will never match up with the official ones unfortunately. Things skipped: - travis integration. I don't know anything about travis so don't know if / how to hook this up for it. - inserting this as part of a full build process. It looks like it's a oneoff in master too fwiw

* Remove es3-ify and es5-shim * adding our own readme * Update version references * Rename readme to markdown * Update the build process to build react-debug.js and react-with-addons-debug.js, which are going to be a hybrid dev/prod build that is faster than the dev version but still has most of the production error messages * Replace some choice instances of __DEV__ with __DEBUG__, including - use of factory on React.DOM members - use of analytics plugin (maybe don't need this...) Avoided (these are still __DEV__) - freezing objects - propType checking - lots of small checks like warnings of whether style names are valid. * keep warning messages in debug builds * Add a hook for registering a callback on warnings * update dropbox readme with instructions for how to the custom react gets loaded into metaserver * Fix bug in WarningHandlers * update README_DROPBOX with info I've learned * Make warning handlers actually work instead of crash * This backports bfd1531 from react 15.2 (facebook#6882); it took some help from 1d0c1b1 to get the basic gulp setup (0.14 beta v2 code), and took a lot of dependency wrangling. `grunt extract-errors` should run the script now. I'm starting with a fresh codes.json because these will never match up with the official ones unfortunately. Things skipped: - travis integration. I don't know anything about travis so don't know if / how to hook this up for it. - inserting this as part of a full build process. It looks like it's a oneoff in master too fwiw * backport rewriting to error codes working for debug & prod builds from 1abce16 * minor README_DROPBOX tweak * add space to invariant error message * Add debug warnings for ReactClass * Keep some DEV only warnings in DEBUG * Re-extract error codes * Include instructions on prod version in dropbox readme * Fix warning handlers * Remove instruction to copy over production React. Instead we should use the official build for prod. * Revert inclusion of prop mutations to DEV builds We probably want to include them later on since they're immensely useful for upgrading to future versions. But for the (at least) initial 0.13.3 we can live without them. * Include debug warning about `componentShouldUpdate` * Update .eslintrc with DEBUG global

ghost added GH Review: review-needed CLA Signed labels May 26, 2016

added an error extractor script and an error map

8367c5a

keyz force-pushed the error-extractor branch from a50100b to 8367c5a Compare May 26, 2016 18:19

iamdustan reviewed May 27, 2016
View reviewed changes

added classProperties to babylon config

c15fad4

sophiebits reviewed May 31, 2016
View reviewed changes

refactored and inlined functions

092b9fc

sophiebits reviewed May 31, 2016
View reviewed changes

refactored extract-errors

ad17422

using gulp

46529c5

sophiebits added GH Review: accepted and removed GH Review: review-needed labels Jun 1, 2016

renamed folder and added travis

4a2a18e

zpao reviewed Jun 1, 2016
View reviewed changes

changed EOL

6e8bbd2

keyz merged commit bfd1531 into facebook:master Jun 1, 2016

keyz deleted the error-extractor branch June 1, 2016 18:21

This was referenced Jun 1, 2016

[Docs] Error Codes Page #6946

Merged

RFC: Error code system #6874

Closed

keyz added a commit that referenced this pull request Jun 7, 2016

Add a gulp script for extracting error codes (#6882)

6aacfdb

(cherry picked from commit bfd1531)

zpao added this to the 15-next milestone Jun 8, 2016

keyz mentioned this pull request Jun 8, 2016

15-next #7000

Closed

7 tasks

zpao pushed a commit that referenced this pull request Jun 14, 2016

Add a gulp script for extracting error codes (#6882)

cb10a45

(cherry picked from commit bfd1531)

zpao modified the milestones: 15-next, 15.2.0 Jun 14, 2016

keyz mentioned this pull request Jun 17, 2016

Error reporting in production #2686

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a script for extracting error codes #6882

Add a script for extracting error codes #6882

keyz commented May 26, 2016 •

edited

Loading

ghost commented May 26, 2016

iamdustan May 27, 2016

keyz May 27, 2016 •

edited

Loading

facebook-github-bot commented May 27, 2016

keyz commented May 27, 2016

sophiebits May 31, 2016

facebook-github-bot commented May 31, 2016

sophiebits May 31, 2016

facebook-github-bot commented Jun 1, 2016

keyz commented Jun 1, 2016

facebook-github-bot commented Jun 1, 2016

sophiebits commented Jun 1, 2016

zpao Jun 1, 2016

ghost commented Jun 1, 2016

ghost commented Jun 1, 2016

Add a script for extracting error codes #6882

Add a script for extracting error codes #6882

Conversation

keyz commented May 26, 2016 • edited Loading

ghost commented May 26, 2016

iamdustan May 27, 2016

Choose a reason for hiding this comment

keyz May 27, 2016 • edited Loading

Choose a reason for hiding this comment

facebook-github-bot commented May 27, 2016

keyz commented May 27, 2016

sophiebits May 31, 2016

Choose a reason for hiding this comment

facebook-github-bot commented May 31, 2016

sophiebits May 31, 2016

Choose a reason for hiding this comment

facebook-github-bot commented Jun 1, 2016

keyz commented Jun 1, 2016

facebook-github-bot commented Jun 1, 2016

sophiebits commented Jun 1, 2016

zpao Jun 1, 2016

Choose a reason for hiding this comment

ghost commented Jun 1, 2016

ghost commented Jun 1, 2016

keyz commented May 26, 2016 •

edited

Loading

keyz May 27, 2016 •

edited

Loading