-
Notifications
You must be signed in to change notification settings - Fork 46.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Jest serializer for Hooks (to sanitize source location)
- Loading branch information
Brian Vaughn
committed
Jun 25, 2021
1 parent
5cb562d
commit cf8a93a
Showing
4 changed files
with
131 additions
and
29 deletions.
There are no files selected for viewing
60 changes: 60 additions & 0 deletions
60
packages/react-devtools-shared/src/__tests__/hookSerializer.js
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,60 @@ | ||
| function hasAbsoluteFileName(hook) { | ||
| const fileName = hook.hookSource ? hook.hookSource.fileName : null; | ||
| if (fileName == null) { | ||
| return false; | ||
| } else { | ||
| return fileName.indexOf('/react-devtools-shared/') > 0; | ||
| } | ||
| } | ||
|
|
||
| function serializeHook(hook) { | ||
| if (!hook.hookSource) return hook; | ||
|
|
||
| // Remove user-specific portions of this file path. | ||
| let fileName = hook.hookSource.fileName; | ||
| const index = fileName.lastIndexOf('/react-devtools-shared/'); | ||
| fileName = fileName.substring(index + 1); | ||
|
|
||
| let subHooks = hook.subHooks; | ||
| if (subHooks) { | ||
| subHooks = subHooks.map(serializeHook); | ||
| } | ||
|
|
||
| return { | ||
| ...hook, | ||
| hookSource: { | ||
| ...hook.hookSource, | ||
| fileName, | ||
|
|
||
| // Otherwise changes in any test case or formatting might invalidate other tests. | ||
| columnNumber: 'removed by Jest serializer', | ||
| lineNumber: 'removed by Jest serializer', | ||
| }, | ||
| subHooks, | ||
| }; | ||
| } | ||
|
|
||
| // test() is part of Jest's serializer API | ||
| export function test(maybeHook) { | ||
| if (maybeHook === null || typeof maybeHook !== 'object') { | ||
| return false; | ||
| } | ||
|
|
||
| const hasOwnProperty = Object.prototype.hasOwnProperty.bind(maybeHook); | ||
|
|
||
| return ( | ||
| hasOwnProperty('id') && | ||
| hasOwnProperty('isStateEditable') && | ||
| hasOwnProperty('name') && | ||
| hasOwnProperty('subHooks') && | ||
| hasOwnProperty('value') && | ||
| // Don't re-process an already printed hook. | ||
| hasAbsoluteFileName(maybeHook) | ||
| ); | ||
| } | ||
|
|
||
| // print() is part of Jest's serializer API | ||
| export function print(hook, serialize, indent) { | ||
| // Don't stringify this object; that would break nested serializers. | ||
| return serialize(serializeHook(hook)); | ||
| } |
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