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.

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

[react devtools] Don't check for NODE_ENV==='test' because it never is #25186

Merged
merged 1 commit into from
Sep 9, 2022
Merged

[react devtools] Don't check for NODE_ENV==='test' because it never is #25186

merged 1 commit into from
Sep 9, 2022

Conversation

rbalicki2
Copy link
Contributor

Summary

  • In renderer.js, we check if (process.env.NODE_ENV !== 'test') { and attempt to only patch the console if we're not running a test
  • Turns out, process.env.NODE_ENV === 'development' for tests.

Why not fix the condition? (e.g. check JEST_WORKER_ID != null)

  • That broke ~50 tests in console-test.

How did you test this change?

  • Removing this check affects no tests.
  • Adding an else block that threw broke no tests.

@@ -810,32 +810,28 @@ export function attach(
// Patching the console enables DevTools to do a few useful things:
// * Append component stacks to warnings and error messages
// * Disable logging during re-renders to inspect hooks (see inspectHooksOfFiber)
//
// Don't patch in test environments because we don't want to interfere with Jest's own console overrides.
if (process.env.NODE_ENV !== 'test') {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This condition never evaluates to true

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah good catch. We probably want to do if (!__TEST__) here instead

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This breaks these tests:

Test Suites: 7 failed, 27 passed, 34 total
Tests:       49 failed, 6 skipped, 383 passed, 438 total
Snapshots:   97 failed, 566 passed, 663 total

I haven't looked into why, but it looks like many tests assume that registerRendererWithConsole(renderer); will be called. Do you have any thoughts on whether we want registerRendererWithConsole to be called here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah it should be OK to move registerRendererWithConsole out of the test because we're not actually overriding the console at all there, just adding some functions for the console override methods to use

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like wrapping any section in if (!__TEST__) breaks at least that many tests. Thoughts on landing this as is?

Copy link
Contributor

@lunaruan lunaruan Sep 8, 2022

Choose a reason for hiding this comment

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

Sure do it :) Curious to know the tests that are breaking though, and why. Do you think you could figure that out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I think when I explore making changes to not use window.__REACT_DEVTOOLS_GLOBAL_FOO__-type variables, I should be able to figure it out

Copy link
Contributor

@lunaruan lunaruan left a comment

Choose a reason for hiding this comment

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

Could you look into why the tests are failing and if we need some sort of check?

* yarn test is not broken.
* And, I added an else clause which was never hit in a test.
@rbalicki2 rbalicki2 merged commit 425f9fb into facebook:main Sep 9, 2022
sammy-SC pushed a commit that referenced this pull request Sep 11, 2022
rickhanlonii pushed a commit that referenced this pull request Oct 5, 2022
rickhanlonii pushed a commit that referenced this pull request Oct 5, 2022
GrinZero added a commit to GrinZero/react that referenced this pull request Nov 7, 2022
* 'main' of ssh://github.com/GrinZero/react: (51 commits)
  Flow: add simple explicit export types to Devtools (facebook#25251)
  [react devtools][easy] Centralize calls to patchConsoleUsingWindowValues (facebook#25222)
  Unwind the current workInProgress if it's suspended (facebook#25247)
  Add early exit to strict mode (facebook#25235)
  fix: prettier ignore removed and fixed (facebook#24811)
  Flow: enable unsafe-addition error (facebook#25242)
  Flow: upgrade to 0.132 (facebook#25244)
  Flow: fix Fiber typed as any (facebook#25241)
  Flow: ReactFiberHotReloading recursive type (facebook#25225)
  Add some test coverage for some error cases (facebook#25240)
  experimental_use(context) for server components and ssr (facebook#25226)
  Flow: upgrade to 0.131 (facebook#25224)
  Prevent infinite re-renders in StrictMode + Offscreen (facebook#25203)
  Flow: remove explicit object syntax (facebook#25223)
  Flow: upgrade to 0.127 (facebook#25221)
  Flow: enable exact_by_default (facebook#25220)
  [react devtools] Don't check for NODE_ENV==='test' because it never is (facebook#25186)
  [react devtools][easy] Change variable names, etc. (facebook#25211)
  Bump async from 2.6.3 to 2.6.4 in /fixtures/concurrent/time-slicing (facebook#24443)
  Flow: implicit-inexact-object=error (facebook#25210)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants