status-im
/
metro
mirror of https://github.com/status-im/metro.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Use `error.message` to set the `description` property of a nested error payload 

Summary:
Depends on #124.

 ---

**Summary**
Metro reports errors using a JSON payload that has an `errors` array. Each item in this array has a `description` field. For transform errors, this field was set using the value in `error.description` -- however, JS Error objects only have a `message` field. (Grepping the Metro code, no errors (except in one test) ever get a `description` field.) This commit uses `error.message` instead of `error.description` when creating JSON payloads.

```
$ git grep description -- 'packages/**/*.js'
packages/metro/src/JSTransformer/__tests__/Transformer-test.js:        babelError.description = message;
packages/metro/src/lib/formatBundlingError.js:    description: string,
packages/metro/src/lib/formatBundlingError.js:): {type: string, message: string, errors: Array<{description: string}>} {
packages/metro/src/lib/formatBundlingError.js:      errors: [{description: message}],
packages/metro/src/lib/formatBundlingError.js:        description: error.message,
packages/metro/src/node-haste/__tests__/Module-test.js:  description: "A require('foo') story",
```

**Test Plan**
Added a unit test to check that the description field is set for transform errors (with the delta bundler).

Also in a test RN app, inspected the error payload that is received by RN when there's a syntax error with HMR turned on and verified that `data.body.errors[0].description` was set.
Closes https://github.com/facebook/metro/pull/125

Differential Revision: D6730671

Pulled By: rafeca

fbshipit-source-id: 58311462db9223d65580d77748203d8ea0ea1ac7
This commit is contained in:
James Ide 2018-01-16 17:08:30 -08:00 committed by Facebook Github Bot
parent b7248380a6
commit bb93e339fa
4 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/metro/src/HmrServer/__tests__/HmrServer-test.js
View File

@ -158,6 +158,7 @@ describe('HmrServer', () => {
message: 'test syntax error', message: 'test syntax error',
errors: [ errors: [
{ {
description: 'test syntax error',
filename: 'EntryPoint.js', filename: 'EntryPoint.js',
lineNumber: 123, lineNumber: 123,
}, },

1
packages/metro/src/JSTransformer/__tests__/Transformer-test.js
View File

@ -87,7 +87,6 @@ describe('Transformer', function() {
const babelError = new SyntaxError(message); const babelError = new SyntaxError(message);
babelError.type = 'SyntaxError'; babelError.type = 'SyntaxError';
babelError.description = message;
babelError.loc = {line: 2, column: 15}; babelError.loc = {line: 2, column: 15};
babelError.codeFrame = snippet; babelError.codeFrame = snippet;

1
packages/metro/src/Server/__tests__/Server-test.js
View File

@ -320,6 +320,7 @@ describe('processRequest', () => {
message: 'test syntax error', message: 'test syntax error',
}); });
expect(body.errors).toContainEqual({ expect(body.errors).toContainEqual({
description: 'test syntax error',
filename: 'testFile.js', filename: 'testFile.js',
lineNumber: 123, lineNumber: 123,
}); });

3
packages/metro/src/lib/formatBundlingError.js
View File

@ -24,7 +24,6 @@ const {
export type CustomError = Error & {| export type CustomError = Error & {|
status?: number, status?: number,
type?: string, type?: string,
description?: string,
filename?: string, filename?: string,
lineNumber?: number, lineNumber?: number,
errors?: Array<{ errors?: Array<{
@ -63,7 +62,7 @@ function formatBundlingError(
) { ) {
error.errors = [ error.errors = [
{ {
description: error.description, description: error.message,
filename: error.filename, filename: error.filename,
lineNumber: error.lineNumber, lineNumber: error.lineNumber,
}, },