-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: unify error handling behavior (#6755)
* refactor: unify error handling behavior * revert * normalize paths * test... * change * does this work... * fix... * maybe fix * maybe fix * fix * fix...
- Loading branch information
Showing
58 changed files
with
1,123 additions
and
299 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /** | ||
| * 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. | ||
| */ | ||
| /* eslint-disable import/no-extraneous-dependencies */ | ||
|
|
||
| // Forked from https://github.com/tribou/jest-serializer-path/blob/master/lib/index.js | ||
| // Added some project-specific handlers | ||
|
|
||
| const _ = require('lodash'); | ||
| const {escapePath} = require('@docusaurus/utils'); | ||
| const os = require('os'); | ||
| const path = require('path'); | ||
| const fs = require('fs'); | ||
|
|
||
| module.exports = { | ||
| print(val, serialize) { | ||
| let normalizedValue = val; | ||
|
|
||
| if (_.isError(normalizedValue)) { | ||
| const message = normalizePaths(normalizedValue.message); | ||
| const error = new Error(message); | ||
|
|
||
| // Clone hidden props | ||
| const ownProps = Object.getOwnPropertyNames(error); | ||
| // eslint-disable-next-line no-restricted-syntax | ||
| for (const index in ownProps) { | ||
| if (Object.prototype.hasOwnProperty.call(ownProps, index)) { | ||
| const key = ownProps[index]; | ||
|
|
||
| error[key] = normalizePaths(normalizedValue[key]); | ||
| } | ||
| } | ||
|
|
||
| // Clone normal props | ||
| // eslint-disable-next-line no-restricted-syntax | ||
| for (const index in normalizedValue) { | ||
| if (Object.prototype.hasOwnProperty.call(normalizedValue, index)) { | ||
| error[index] = normalizePaths(normalizedValue[index]); | ||
| } | ||
| } | ||
|
|
||
| normalizedValue = error; | ||
| } else if (typeof normalizedValue === 'object') { | ||
| normalizedValue = _.cloneDeep(normalizedValue); | ||
|
|
||
| Object.keys(normalizedValue).forEach((key) => { | ||
| normalizedValue[key] = normalizePaths(normalizedValue[key]); | ||
| }); | ||
| } else { | ||
| normalizedValue = normalizePaths(normalizedValue); | ||
| } | ||
|
|
||
| return serialize(normalizedValue); | ||
| }, | ||
| test(val) { | ||
| let has = false; | ||
|
|
||
| if (val && typeof val === 'object') { | ||
| // val.message is non-enumerable in an error | ||
| if (val.message && shouldUpdate(val.message)) { | ||
| has = true; | ||
| } | ||
|
|
||
| Object.keys(val).forEach((key) => { | ||
| if (shouldUpdate(val[key])) { | ||
| has = true; | ||
| } | ||
| }); | ||
| } else if (shouldUpdate(val)) { | ||
| has = true; | ||
| } | ||
|
|
||
| return has; | ||
| }, | ||
| normalizePaths, | ||
| getRealPath, | ||
| }; | ||
|
|
||
| /** | ||
| * Normalize paths across platforms. | ||
| * Filters must be ran on all platforms to guard against false positives | ||
| */ | ||
| function normalizePaths(value) { | ||
| if (typeof value !== 'string') { | ||
| return value; | ||
| } | ||
|
|
||
| const cwd = process.cwd(); | ||
| const cwdReal = getRealPath(cwd); | ||
| const tempDir = os.tmpdir(); | ||
| const tempDirReal = getRealPath(tempDir); | ||
| const homeDir = os.homedir(); | ||
| const homeDirReal = getRealPath(homeDir); | ||
|
|
||
| const homeRelativeToTemp = path.relative(tempDir, homeDir); | ||
| const homeRelativeToTempReal = path.relative(tempDirReal, homeDir); | ||
| const homeRealRelativeToTempReal = path.relative(tempDirReal, homeDirReal); | ||
| const homeRealRelativeToTemp = path.relative(tempDir, homeDirReal); | ||
|
|
||
| const runner = [ | ||
| // Replace process.cwd with <PROJECT_ROOT> | ||
| (val) => val.split(cwdReal).join('<PROJECT_ROOT>'), | ||
| (val) => val.split(cwd).join('<PROJECT_ROOT>'), | ||
|
|
||
| // Replace home directory with <TEMP_DIR> | ||
| (val) => val.split(tempDirReal).join('<TEMP_DIR>'), | ||
| (val) => val.split(tempDir).join('<TEMP_DIR>'), | ||
|
|
||
| // Replace home directory with <HOME_DIR> | ||
| (val) => val.split(homeDirReal).join('<HOME_DIR>'), | ||
| (val) => val.split(homeDir).join('<HOME_DIR>'), | ||
|
|
||
| // handle HOME_DIR nested inside TEMP_DIR | ||
| (val) => | ||
| val | ||
| .split(`<TEMP_DIR>${path.sep + homeRelativeToTemp}`) | ||
| .join('<HOME_DIR>'), | ||
| (val) => | ||
| val | ||
| .split(`<TEMP_DIR>${path.sep + homeRelativeToTempReal}`) | ||
| .join('<HOME_DIR>'), // untested | ||
| (val) => | ||
| val | ||
| .split(`<TEMP_DIR>${path.sep + homeRealRelativeToTempReal}`) | ||
| .join('<HOME_DIR>'), | ||
| (val) => | ||
| val | ||
| .split(`<TEMP_DIR>${path.sep + homeRealRelativeToTemp}`) | ||
| .join('<HOME_DIR>'), // untested | ||
|
|
||
| // In case the CWD is escaped | ||
| (val) => val.split(escapePath(cwd)).join('<PROJECT_ROOT>'), | ||
|
|
||
| // Remove win32 drive letters, C:\ -> \ | ||
| (val) => val.replace(/[a-zA-Z]:\\/g, '\\'), | ||
|
|
||
| // Remove duplicate backslashes created from escapePath | ||
| (val) => val.replace(/\\\\/g, '\\'), | ||
|
|
||
| // Convert win32 backslash's to forward slashes, \ -> /; | ||
| // ignore some that look like escape sequences. | ||
| (val) => val.replace(/\\(?!["])/g, '/'), | ||
| ]; | ||
|
|
||
| let result = value; | ||
| runner.forEach((current) => { | ||
| result = current(result); | ||
| }); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| function shouldUpdate(value) { | ||
| if (typeof value !== 'string') { | ||
| return false; | ||
| } | ||
|
|
||
| // return true if value is different from normalized value | ||
| return normalizePaths(value) !== value; | ||
| } | ||
|
|
||
| function getRealPath(pathname) { | ||
| try { | ||
| // eslint-disable-next-line no-restricted-properties | ||
| const realPath = fs.realpathSync(pathname); | ||
|
|
||
| return realPath; | ||
| } catch (error) { | ||
| return pathname; | ||
| } | ||
| } |
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
2 changes: 2 additions & 0 deletions
2
...ages/docusaurus-mdx-loader/src/remark/toc/__tests__/__fixtures__/inline-code.md
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
1 change: 1 addition & 0 deletions
1
...urus-mdx-loader/src/remark/transformImage/__tests__/__fixtures__/invalid-img.md
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Oops, something went wrong.