fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker #28628

hoxyq · 2024-03-25T17:58:30Z

This should fix the failing backwards-compatibility tests on CI:

Started failing after #27991.

Brief summary:

Revert changes to profilingCache-test in Disable legacy context #27991.
Scope previous test to react versions 16.9 - 18.2
Add a new test for react versions > 18.2 (includes testing react from souce), which is also gated with !disableLegacyContext.

Important

@gate pragma expects the test to throw. Jest doesn't throw any exceptions when snapshots are mismatched, this is why I've migrated test from toMatchInlineSnapshot checker to toEqual.
If the test doesn't throw, we will fail it manually:

react/scripts/jest/setupTests.js

Lines 291 to 295 in 5a75f9e

    
           if (!didError) { 
        
             // The test did not error like we expected it to. Report this to Jest as 
        
             // a failure. 
        
             throw errorToThrowIfTestSucceeds; 
        
           }

…ions and toEqual checker

eps1lon · 2024-03-26T07:53:39Z

packages/react-devtools-shared/src/__tests__/profilingCache-test.js

@@ -630,6 +620,381 @@ describe('ProfilingCache', () => {
    }
  });

+  // @reactVersion > 18.2
+  // @gate !disableLegacyContext
+  it('should record changed props/state/context/hooks for React version (18.2; ∞) with legacy context enabled', () => {


Let's hope we don't have legacy context enabled indefinitely 😅

Hopefully this will be removed together with disableLegacyContext flag

…ions and toEqual checker (facebook#28628) This should fix the failing backwards-compatibility tests on CI: - https://app.circleci.com/pipelines/github/facebook/react/51347/workflows/9d319db5-7a29-4e9a-a3a0-8d49a24ee9bd/jobs/809381 - https://app.circleci.com/pipelines/github/facebook/react/51347/workflows/9d319db5-7a29-4e9a-a3a0-8d49a24ee9bd/jobs/809386 Started failing after facebook#27991. Brief summary: 1. Revert changes to `profilingCache-test` in facebook#27991. 2. Scope previous test to react versions 16.9 - 18.2 3. Add a new test for react versions > 18.2 (includes testing react from souce), which is also gated with `!disableLegacyContext`. > [!IMPORTANT] > `@gate` pragma expects the test to throw. Jest doesn't throw any exceptions when snapshots are mismatched, this is why I've migrated test from `toMatchInlineSnapshot` checker to `toEqual`. > If the test doesn't throw, we will fail it manually: > https://github.com/facebook/react/blob/5a75f9e78544fa6d052aff7fe99607e48f35b979/scripts/jest/setupTests.js#L291-L295

Full list of changes: * Look for a ReactMemoCacheSentinel on state ([gsathya](https://github.com/gsathya) in [#28831](#28831)) * Use use() in the Cache if available ([sebmarkbage](https://github.com/sebmarkbage) in [#28793](#28793)) * feat[devtools-fusebox]: support theme option ([hoxyq](https://github.com/hoxyq) in [#28832](#28832)) * feat[devtools]: add package for fusebox integration ([hoxyq](https://github.com/hoxyq) in [#28553](#28553)) * feat[devtools]: add method for connecting backend with custom messaging protocol ([hoxyq](https://github.com/hoxyq) in [#28552](#28552)) * Rename SECRET INTERNALS to `__CLIENT_INTERNALS_DO_NOT_USE_OR_WARN_USERS_THEY_CANNOT_UPGRADE` ([sebmarkbage](https://github.com/sebmarkbage) in [#28789](#28789)) * Flatten ReactSharedInternals ([sebmarkbage](https://github.com/sebmarkbage) in [#28783](#28783)) * feat[devtools]: ship source maps for content scripts and ignore list installHook script ([hoxyq](https://github.com/hoxyq) in [#28730](#28730)) * Track Owner for Server Components in DEV ([sebmarkbage](https://github.com/sebmarkbage) in [#28753](#28753)) * Move ReactDOMLegacy implementation into RootFB ([sebmarkbage](https://github.com/sebmarkbage) in [#28656](#28656)) * Reland #28672: Remove IndeterminateComponent ([gnoff](https://github.com/gnoff) in [#28681](#28681)) * Remove reference to deleted <Cache> in un-linted file ([josephsavona](https://github.com/josephsavona) in [#28715](#28715)) * [be] Remove unshipped experimental <Cache> element type ([josephsavona](https://github.com/josephsavona) in [#28698](#28698)) * Revert "Remove module pattern function component support" ([rickhanlonii](https://github.com/rickhanlonii) in [#28670](#28670)) * Remove module pattern function component support ([gnoff](https://github.com/gnoff) in [#27742](#27742)) * [RTR] Enable warning flag ([jackpope](https://github.com/jackpope) in [#28419](#28419)) * Update error messages ([rickhanlonii](https://github.com/rickhanlonii) in [#28652](#28652)) * fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker ([hoxyq](https://github.com/hoxyq) in [#28628](#28628)) * Guard against legacy context not being supported in DevTools fixture ([eps1lon](https://github.com/eps1lon) in [#28596](#28596)) * Use `declare const` instead of `declare var` ([kassens](https://github.com/kassens) in [#28599](#28599)) * Update isConcurrent RTR option usage ([jackpope](https://github.com/jackpope) in [#28546](#28546)) * Disable legacy context ([kassens](https://github.com/kassens) in [#27991](#27991)) * Remove invokeGuardedCallback and replay trick ([sebmarkbage](https://github.com/sebmarkbage) in [#28515](#28515)) * Remove remaining usages of ReactTestUtils in tests unrelated to `react-dom/test-util` ([eps1lon](https://github.com/eps1lon) in [#28534](#28534)) * fix[devtools/e2e]: fixed source inspection in e2e tests ([hoxyq](https://github.com/hoxyq) in [#28518](#28518)) * Devtools: Display actual pending state when inspecting `useTransition` ([eps1lon](https://github.com/eps1lon) in [#28499](#28499))

fix[devtools/ci]: split profiling cache test for different react vers…

1a8964e

…ions and toEqual checker

hoxyq requested review from kassens and rickhanlonii March 25, 2024 17:58

facebook-github-bot added CLA Signed React Core Team Opened by a member of the React Core Team labels Mar 25, 2024

eps1lon approved these changes Mar 26, 2024

View reviewed changes

hoxyq merged commit 75de4ff into facebook:main Mar 26, 2024
38 checks passed

hoxyq deleted the react-devtools/fix-profiling-cache-test-after-disabling-legacy-context branch March 26, 2024 10:55

hoxyq mentioned this pull request Apr 15, 2024

React DevTools 5.0.2 -> 5.1.0 #28840

Merged

eps1lon mentioned this pull request Apr 19, 2024

Update React from 14898b6a9 to c3048aab4 vercel/next.js#64798

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker #28628

fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker #28628

hoxyq commented Mar 25, 2024

eps1lon Mar 26, 2024

hoxyq Mar 26, 2024

	if (!didError) {
	// The test did not error like we expected it to. Report this to Jest as
	// a failure.
	throw errorToThrowIfTestSucceeds;
	}

fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker #28628

fix[devtools/ci]: split profiling cache test for different react versions and toEqual checker #28628

Conversation

hoxyq commented Mar 25, 2024

eps1lon Mar 26, 2024

Choose a reason for hiding this comment

hoxyq Mar 26, 2024

Choose a reason for hiding this comment