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

Include full error messages in React Native build #15363

Merged
merged 1 commit into from
Apr 9, 2019
Merged

Include full error messages in React Native build #15363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/error-codes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ provide a better debugging support in production. Check out the blog post
can test it by running `yarn build -- --extract-errors`, but you should only
commit changes to this file when running a release. (The release tool will
perform this step automatically.)
- [`minify-error-codes`](https://github.com/facebook/react/blob/master/scripts/error-codes/minify-error-codes)
- [`transform-error-messages`](https://github.com/facebook/react/blob/master/scripts/error-codes/transform-error-messages)
is a Babel pass that rewrites error messages to IDs for a production
(minified) build.
11 changes: 11 additions & 0 deletions ...snapshots__/minify-error-messages.js.snap → ...pshots__/transform-error-messages.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,14 @@ import invariant from 'shared/invariant';
}
})();"
`;

exports[`error transform should support noMinify option 1`] = `
"import _ReactError from 'shared/ReactError';

import invariant from 'shared/invariant';
Copy link
Member

Choose a reason for hiding this comment

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

Is this supposed to remove the import or does some other dead code elimination step do that?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah that happens in a subsequent step of the Rollup script

(function () {
if (!condition) {
throw _ReactError(\`Do not override existing functions.\`);
}
})();"
`;
18 changes: 15 additions & 3 deletions ...-codes/__tests__/minify-error-messages.js → ...des/__tests__/transform-error-messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
'use strict';

let babel = require('babel-core');
let devExpressionWithCodes = require('../minify-error-messages');
let devExpressionWithCodes = require('../transform-error-messages');

function transform(input) {
function transform(input, options = {}) {
return babel.transform(input, {
plugins: [devExpressionWithCodes],
plugins: [[devExpressionWithCodes, options]],
}).code;
}

Expand Down Expand Up @@ -82,4 +82,16 @@ invariant(condition, 'What\\'s up?');
`)
).toMatchSnapshot();
});

it('should support noMinify option', () => {
expect(
transform(
`
import invariant from 'shared/invariant';
invariant(condition, 'Do not override existing functions.');
`,
{noMinify: true}
)
).toMatchSnapshot();
});
});
3 changes: 2 additions & 1 deletion scripts/error-codes/minify-error-messages.js → ...s/error-codes/transform-error-messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ module.exports = function(babel) {
visitor: {
CallExpression(path, file) {
const node = path.node;
const noMinify = file.opts.noMinify;
if (path.get('callee').isIdentifier({name: 'invariant'})) {
// Turns this code:
//
Expand Down Expand Up @@ -66,7 +67,7 @@ module.exports = function(babel) {
const errorMap = invertObject(existingErrorMap);

let prodErrorId = errorMap[errorMsgLiteral];
if (prodErrorId === undefined) {
if (prodErrorId === undefined || noMinify) {
// There is no error code for this message. We use a lint rule to
// enforce that messages can be minified, so assume this is
// intentional and exit gracefully.
Expand Down
2 changes: 1 addition & 1 deletion scripts/jest/preprocessor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const pathToBabel = path.join(
'package.json'
);
const pathToBabelPluginDevWithCode = require.resolve(
'../error-codes/minify-error-messages'
'../error-codes/transform-error-messages'
);
const pathToBabelPluginWrapWarning = require.resolve(
'../babel/wrap-warning-with-env-check'
Expand Down
9 changes: 7 additions & 2 deletions scripts/rollup/build.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ function getBabelConfig(updateBabelOptions, bundleType, filename) {
return Object.assign({}, options, {
plugins: options.plugins.concat([
// Minify invariant messages
require('../error-codes/minify-error-messages'),
require('../error-codes/transform-error-messages'),
// Wrap warning() calls in a __DEV__ check so they are stripped from production.
require('../babel/wrap-warning-with-env-check'),
]),
Expand All @@ -126,6 +126,11 @@ function getBabelConfig(updateBabelOptions, bundleType, filename) {
case RN_FB_PROFILING:
return Object.assign({}, options, {
plugins: options.plugins.concat([
[
require('../error-codes/transform-error-messages'),
// Preserve full error messages in React Native build
{noMinify: true},
],
// Wrap warning() calls in a __DEV__ check so they are stripped from production.
require('../babel/wrap-warning-with-env-check'),
]),
Expand All @@ -141,7 +146,7 @@ function getBabelConfig(updateBabelOptions, bundleType, filename) {
// Use object-assign polyfill in open source
path.resolve('./scripts/babel/transform-object-assign-require'),
// Minify invariant messages
require('../error-codes/minify-error-messages'),
require('../error-codes/transform-error-messages'),
// Wrap warning() calls in a __DEV__ check so they are stripped from production.
require('../babel/wrap-warning-with-env-check'),
]),
Expand Down
48 changes: 24 additions & 24 deletions scripts/rollup/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,57 +578,57 @@
"filename": "ReactNativeRenderer-dev.js",
"bundleType": "RN_FB_DEV",
"packageName": "react-native-renderer",
"size": 645983,
"gzip": 137694
"size": 720540,
"gzip": 154199
},
{
"filename": "ReactNativeRenderer-prod.js",
"bundleType": "RN_FB_PROD",
"packageName": "react-native-renderer",
"size": 252030,
"gzip": 44064
"size": 252865,
"gzip": 44240
},
{
"filename": "ReactNativeRenderer-dev.js",
"bundleType": "RN_OSS_DEV",
"packageName": "react-native-renderer",
"size": 645895,
"gzip": 137660
"size": 720452,
"gzip": 154169
},
{
"filename": "ReactNativeRenderer-prod.js",
"bundleType": "RN_OSS_PROD",
"packageName": "react-native-renderer",
"size": 252044,
"gzip": 44061
"size": 252879,
"gzip": 44238
},
{
"filename": "ReactFabric-dev.js",
"bundleType": "RN_FB_DEV",
"packageName": "react-native-renderer",
"size": 634566,
"gzip": 134983
"size": 709123,
"gzip": 151511
},
{
"filename": "ReactFabric-prod.js",
"bundleType": "RN_FB_PROD",
"packageName": "react-native-renderer",
"size": 245276,
"gzip": 42773
"size": 246002,
"gzip": 42956
},
{
"filename": "ReactFabric-dev.js",
"bundleType": "RN_OSS_DEV",
"packageName": "react-native-renderer",
"size": 634470,
"gzip": 134930
"size": 709027,
"gzip": 151463
},
{
"filename": "ReactFabric-prod.js",
"bundleType": "RN_OSS_PROD",
"packageName": "react-native-renderer",
"size": 245282,
"gzip": 42767
"size": 246008,
"gzip": 42950
},
{
"filename": "ReactTestRenderer-dev.js",
Expand Down Expand Up @@ -725,15 +725,15 @@
"filename": "ReactNativeRenderer-profiling.js",
"bundleType": "RN_OSS_PROFILING",
"packageName": "react-native-renderer",
"size": 258447,
"gzip": 45443
"size": 259040,
"gzip": 45588
},
{
"filename": "ReactFabric-profiling.js",
"bundleType": "RN_OSS_PROFILING",
"packageName": "react-native-renderer",
"size": 250755,
"gzip": 44122
"size": 251432,
"gzip": 44320
},
{
"filename": "Scheduler-dev.js",
Expand Down Expand Up @@ -774,15 +774,15 @@
"filename": "ReactNativeRenderer-profiling.js",
"bundleType": "RN_FB_PROFILING",
"packageName": "react-native-renderer",
"size": 258428,
"gzip": 45445
"size": 259021,
"gzip": 45590
},
{
"filename": "ReactFabric-profiling.js",
"bundleType": "RN_FB_PROFILING",
"packageName": "react-native-renderer",
"size": 250744,
"gzip": 44126
"size": 251421,
"gzip": 44324
},
{
"filename": "react.profiling.min.js",
Expand Down