-
Notifications
You must be signed in to change notification settings - Fork 508
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add error code extract and transform (#138)
* Add error code extract and transform * Add flag --extractErrors flag * Make error extraction opt-in * fix small reference to React * catch extractErrors * small fix for a comment * fix readFileSync bug * add in basic docs * Move to errors directory * Move everything to errors directory out of source
- Loading branch information
1 parent
37d7664
commit a20429d
Showing
13 changed files
with
580 additions
and
47 deletions.
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| export function evalToString(ast: any): string { | ||
| switch (ast.type) { | ||
| case 'StringLiteral': | ||
| return ast.value; | ||
| case 'BinaryExpression': // `+` | ||
| if (ast.operator !== '+') { | ||
| throw new Error('Unsupported binary operator ' + ast.operator); | ||
| } | ||
| return evalToString(ast.left) + evalToString(ast.right); | ||
| default: | ||
| throw new Error('Unsupported type ' + ast.type); | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| import fs from 'fs-extra'; | ||
| import * as babylon from 'babylon'; | ||
| import traverse from 'babel-traverse'; | ||
| import { invertObject } from './invertObject'; | ||
| import { evalToString } from './evalToString'; | ||
| import { paths } from '../constants'; | ||
| import { safeVariableName } from '../utils'; | ||
| import pascalCase from 'pascal-case'; | ||
|
|
||
| const babylonOptions = { | ||
| sourceType: 'module', | ||
| // As a parser, babylon has its own options and we can't directly | ||
| // import/require a babel preset. It should be kept **the same** as | ||
| // the `babel-plugin-syntax-*` ones specified in | ||
| // https://github.com/facebook/fbjs/blob/master/packages/babel-preset-fbjs/configure.js | ||
| plugins: [ | ||
| 'classProperties', | ||
| 'flow', | ||
| 'jsx', | ||
| 'trailingFunctionCommas', | ||
| 'objectRestSpread', | ||
| ], | ||
| }; | ||
|
|
||
| export function extractErrors(opts: any) { | ||
| if (!opts || !('errorMapFilePath' in opts)) { | ||
| throw new Error( | ||
| 'Missing options. Ensure you pass an object with `errorMapFilePath`.' | ||
| ); | ||
| } | ||
|
|
||
| if (!opts.name || !('name' in opts)) { | ||
| throw new Error('Missing options. Ensure you pass --name flag to tsdx'); | ||
| } | ||
|
|
||
| if (typeof opts.extractErrors === 'boolean') { | ||
| throw new Error( | ||
| 'No url passed to extractErrors flag.' + | ||
| 'Ensure you pass a url, eg. `--extractErrors=https://reactjs.org/docs/error-decoder.html?invariant=`.' | ||
| ); | ||
| } | ||
|
|
||
| const errorMapFilePath = opts.errorMapFilePath; | ||
| let existingErrorMap: any; | ||
| try { | ||
| // Using `fs.readFileSync` instead of `require` here, because `require()` | ||
| // calls are cached, and the cache map is not properly invalidated after | ||
| // file changes. | ||
| existingErrorMap = JSON.parse(fs.readFileSync(errorMapFilePath, 'utf8')); | ||
| } catch (e) { | ||
| existingErrorMap = {}; | ||
| } | ||
|
|
||
| const allErrorIDs = Object.keys(existingErrorMap); | ||
| let currentID: any; | ||
|
|
||
| if (allErrorIDs.length === 0) { | ||
| // Map is empty | ||
| currentID = 0; | ||
| } else { | ||
| currentID = Math.max.apply(null, allErrorIDs as any) + 1; | ||
| } | ||
|
|
||
| // Here we invert the map object in memory for faster error code lookup | ||
| existingErrorMap = invertObject(existingErrorMap); | ||
|
|
||
| function transform(source: string) { | ||
| const ast = babylon.parse(source, babylonOptions); | ||
|
|
||
| traverse(ast, { | ||
| CallExpression: { | ||
| exit(astPath: any) { | ||
| if (astPath.get('callee').isIdentifier({ name: 'invariant' })) { | ||
| const node = astPath.node; | ||
|
|
||
| // error messages can be concatenated (`+`) at runtime, so here's a | ||
| // trivial partial evaluator that interprets the literal value | ||
| const errorMsgLiteral = evalToString(node.arguments[1]); | ||
| addToErrorMap(errorMsgLiteral); | ||
| } | ||
| }, | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| function addToErrorMap(errorMsgLiteral: any) { | ||
| if (existingErrorMap.hasOwnProperty(errorMsgLiteral)) { | ||
| return; | ||
| } | ||
| existingErrorMap[errorMsgLiteral] = '' + currentID++; | ||
| } | ||
|
|
||
| function flush(cb?: any) { | ||
| const prettyName = pascalCase(safeVariableName(opts.name)); | ||
| // Output messages to ./codes.json | ||
| fs.writeFileSync( | ||
| errorMapFilePath, | ||
| JSON.stringify(invertObject(existingErrorMap), null, 2) + '\n', | ||
| 'utf-8' | ||
| ); | ||
|
|
||
| // Ensure that the ./src/errors directory exists or create it | ||
| fs.ensureDirSync(paths.appRoot + '/errors'); | ||
|
|
||
| // Write the error files, unless they already exist | ||
| fs.writeFileSync( | ||
| paths.appRoot + '/errors/ErrorDev.js', | ||
| ` | ||
| function ErrorDev(message) { | ||
| const error = new Error(message); | ||
| error.name = 'Invariant Violation'; | ||
| return error; | ||
| } | ||
| export default ErrorDev; | ||
| `, | ||
| 'utf-8' | ||
| ); | ||
|
|
||
| fs.writeFileSync( | ||
| paths.appRoot + '/errors/ErrorProd.js', | ||
| `// Do not require this module directly! Use a normal error constructor with | ||
| // template literal strings. The messages will be converted to ErrorProd during | ||
| // build, and in production they will be minified. | ||
| function ErrorProd(code) { | ||
| let url = '${opts.extractErrors}' + code; | ||
| for (let i = 1; i < arguments.length; i++) { | ||
| url += '&args[]=' + encodeURIComponent(arguments[i]); | ||
| } | ||
| return new Error( | ||
| \`Minified ${prettyName} error #\$\{code\}; visit \$\{url\} for the full message or \` + | ||
| 'use the non-minified dev environment for full errors and additional \' + | ||
| 'helpful warnings. ' | ||
| ); | ||
| } | ||
| export default ErrorProd; | ||
| `, | ||
| 'utf-8' | ||
| ); | ||
| } | ||
|
|
||
| return function extractErrors(source: any) { | ||
| transform(source); | ||
| flush(); | ||
| }; | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /** | ||
| * turns | ||
| * { 'MUCH ERROR': '0', 'SUCH WRONG': '1' } | ||
| * into | ||
| * { 0: 'MUCH ERROR', 1: 'SUCH WRONG' } | ||
| */ | ||
|
|
||
| type Dict = { [key: string]: any }; | ||
|
|
||
| export function invertObject( | ||
| targetObj: Dict /* : ErrorMap */ | ||
| ) /* : ErrorMap */ { | ||
| const result: Dict = {}; | ||
| const mapKeys = Object.keys(targetObj); | ||
|
|
||
| // eslint-disable-next-line no-for-of-loops/no-for-of-loops | ||
| for (const originalKey of mapKeys) { | ||
| const originalVal = targetObj[originalKey]; | ||
|
|
||
| result[originalVal] = originalKey; | ||
| } | ||
|
|
||
| return result; | ||
| } |
Oops, something went wrong.