feat(v13): enable concurrent rendering by default (#1692)

* feat!: enable concurrent rendering by default * chore: tweaks
callstack · Oct 25, 2024 · 383c241 · 383c241
1 parent 3abeac3
commit 383c241
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -47,7 +47,7 @@ jobs:
   test:
     needs: [install-cache-deps]
     runs-on: ubuntu-latest
-    name: Test
+    name: Test (concurrent by default)
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -61,11 +61,10 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
 
-
-  test-concurrent:
+  test-legacy:
     needs: [install-cache-deps]
     runs-on: ubuntu-latest
-    name: Test (concurrent mode)
+    name: Test (legacy)
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -74,7 +73,7 @@ jobs:
         uses: ./.github/actions/setup-deps
 
       - name: Test in concurrent mode
-        run: CONCURRENT_MODE=1 yarn test:ci
+        run: CONCURRENT_MODE=0 yarn test:ci
 
   test-website:
     runs-on: ubuntu-latest

diff --git a/jest-setup.ts b/jest-setup.ts
@@ -3,7 +3,7 @@ import './src/matchers/extend-expect';
 
 beforeEach(() => {
   resetToDefaults();
-  if (process.env.CONCURRENT_MODE === '1') {
-    configure({ concurrentRoot: true });
+  if (process.env.CONCURRENT_MODE === '0') {
+    configure({ concurrentRoot: false });
   }
 });
diff --git a/src/__tests__/config.test.ts b/src/__tests__/config.test.ts
@@ -16,7 +16,7 @@ test('configure() overrides existing config values', () => {
     asyncUtilTimeout: 5000,
     defaultDebugOptions: { message: 'debug message' },
     defaultIncludeHiddenElements: false,
-    concurrentRoot: false,
+    concurrentRoot: true,
   });
 });
 

diff --git a/src/config.ts b/src/config.ts
@@ -15,8 +15,8 @@ export type Config = {
   defaultDebugOptions?: Partial<DebugOptions>;
 
   /**
-   * Set to `true` to enable concurrent rendering.
-   * Otherwise `render` will default to legacy synchronous rendering.
+   * Set to `false` to disable concurrent rendering.
+   * Otherwise `render` will default to concurrent rendering.
    */
   concurrentRoot: boolean;
 };
@@ -43,7 +43,7 @@ export type InternalConfig = Config & {
 const defaultConfig: InternalConfig = {
   asyncUtilTimeout: 1000,
   defaultIncludeHiddenElements: false,
-  concurrentRoot: false,
+  concurrentRoot: true,
 };
 
 let config = { ...defaultConfig };

diff --git a/src/render.tsx b/src/render.tsx
@@ -24,10 +24,10 @@ export interface RenderOptions {
   wrapper?: React.ComponentType<any>;
 
   /**
-   * Set to `true` to enable concurrent rendering.
-   * Otherwise `render` will default to legacy synchronous rendering.
+   * Set to `false` to disable concurrent rendering.
+   * Otherwise `render` will default to concurrent rendering.
    */
-  concurrentRoot?: boolean | undefined;
+  concurrentRoot?: boolean;
 
   createNodeMock?: (element: React.ReactElement) => unknown;
   unstable_validateStringsRenderedWithinText?: boolean;