test(e2e): add helper to assert no logs by chenjiahan · Pull Request #5877 · web-infra-dev/rsbuild

chenjiahan · 2025-08-18T13:29:02Z

Summary

Replace manual log checks with expectLog and expectNoLog helper methods
Clean up test setup code by removing unnecessary file deletions
Rename createLogMatcher to createLogHelper for clarity

Checklist

Tests updated (or not required).
Documentation updated (or not required).

netlify · 2025-08-18T13:29:09Z

✅ Deploy Preview for rsbuild ready!

Name	Link
🔨 Latest commit	`5ae6b4c`
🔍 Latest deploy log	https://app.netlify.com/projects/rsbuild/deploys/68a32aa21890ae000801a74f
😎 Deploy Preview	https://deploy-preview-5877--rsbuild.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 83 (🟢 up 12 from production) Accessibility: 97 (no change from production) Best Practices: 100 (no change from production) SEO: 100 (no change from production) PWA: 60 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull Request Overview

This PR refactors logging test utilities by replacing manual log checks with standardized helper methods and cleaning up test setup code.

Renamed createLogMatcher to createLogHelper for better clarity
Added new expectNoLog helper method to complement existing expectLog functionality
Removed unnecessary file deletion operations in test setup code

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
e2e/helper/logs.ts	Added `expectNoLog` helper and renamed function/types for clarity
e2e/helper/jsApi.ts	Updated variable names to use singular `logHelper` consistently
e2e/helper/cli.ts	Simplified helper usage by spreading all methods from `logHelper`
e2e/cases/server/overlay/index.test.ts	Updated import to use renamed `createLogHelper`
e2e/cases/server/overlay-type-errors/index.test.ts	Updated import to use renamed `createLogHelper`
e2e/cases/rsdoctor/index.test.ts	Replaced manual log checks with `expectLog`/`expectNoLog` helpers
e2e/cases/print-file-size/with-error/index.test.ts	Replaced manual log check with `expectNoLog` helper
e2e/cases/lazy-compilation/port-placeholder/index.test.ts	Replaced manual log check with `expectNoLog` helper
e2e/cases/lazy-compilation/dynamic-import/index.test.ts	Replaced manual log check with `expectNoLog` helper and removed unused import
e2e/cases/lazy-compilation/basic/index.test.ts	Replaced manual log checks with `expectNoLog` helper
e2e/cases/css/import-common-css/index.test.ts	Removed manual log check code
e2e/cases/css/enable-experiments-css/index.test.ts	Replaced manual log checks with `expectNoLog` helper
e2e/cases/config/stats-options/index.test.ts	Replaced manual log checks with `expectLog`/`expectNoLog` helpers
e2e/cases/config/inspect-config/index.test.ts	Replaced manual log checks with `expectLog` helper
e2e/cases/config/debug-mode/index.test.ts	Replaced manual log checks with `expectLog` helper
e2e/cases/cli/watch-files/index.test.ts	Removed unnecessary file deletion in test setup
e2e/cases/cli/watch-files-array/index.test.ts	Removed unnecessary file deletion in test setup
e2e/cases/cli/reload-env/index.test.ts	Removed file deletions and added proper async log expectations
e2e/cases/cli/build-watch/index.test.ts	Removed unnecessary file deletions in test setup
e2e/cases/cli/build-watch-restart/index.test.ts	Improved test flow with proper async expectations and removed file deletions
e2e/cases/cli/build-watch-options/index.test.ts	Replaced manual log check with `expectNoLog` helper

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-18T13:35:14Z

e2e/helper/logs.ts

    });
  };

+  const expectNoLog = (pattern: LogPattern) => {


The expectNoLog function returns a boolean synchronously, which is inconsistent with expectLog that returns a Promise. This could cause issues when used with await statements in test files. Consider making this function async or removing the return statement to match the pattern of other expectation functions.

Suggested change

const expectNoLog = (pattern: LogPattern) => {

const expectNoLog = async (pattern: LogPattern) => {

Copilot · 2025-08-18T13:35:15Z

e2e/cases/rsdoctor/index.test.ts

-    expect(
-      logs.some((log) => log.includes('@rsdoctor') && log.includes('enabled')),
-    ).toBe(false);
+    expectNoLog(RSDOCTOR_LOG);


The expectNoLog call is missing await. Since this function is used in an async context and other expectLog calls are awaited, this should also be awaited for consistency and proper test execution flow.

Suggested change

expectNoLog(RSDOCTOR_LOG);

await expectNoLog(RSDOCTOR_LOG);

Copilot · 2025-08-18T13:35:15Z

e2e/cases/rsdoctor/index.test.ts

-    expect(
-      logs.some((log) => log.includes('@rsdoctor') && log.includes('enabled')),
-    ).toBe(false);
+    expectNoLog(RSDOCTOR_LOG);


The expectNoLog call is missing await. Since this function is used in an async context and other expectLog calls are awaited, this should also be awaited for consistency and proper test execution flow.

Suggested change

expectNoLog(RSDOCTOR_LOG);

await expectNoLog(RSDOCTOR_LOG);

Copilot · 2025-08-18T13:35:15Z

e2e/cases/print-file-size/with-error/index.test.ts


  expect(rsbuild.buildError).toBeTruthy();
-  expect(rsbuild.logs.some((log) => log.includes('Total:'))).toBeFalsy();
+  rsbuild.expectNoLog('Total:');


The expectNoLog call is missing await. Since this is used in an async test context, it should be awaited for proper test execution.

Suggested change

rsbuild.expectNoLog('Total:');

await rsbuild.expectNoLog('Total:');

Copilot · 2025-08-18T13:35:15Z

e2e/cases/lazy-compilation/port-placeholder/index.test.ts

-    expect(
-      rsbuild.logs.some((log) => log.includes('building src/page2/index.js')),
-    ).toBeFalsy();
+    rsbuild.expectNoLog('building src/page2/index.js');


The expectNoLog call is missing await. Since this is used in an async test context and other expectLog calls are awaited, this should also be awaited for consistency.

Suggested change

rsbuild.expectNoLog('building src/page2/index.js');

await rsbuild.expectNoLog('building src/page2/index.js');

Copilot · 2025-08-18T13:35:16Z

e2e/cases/lazy-compilation/basic/index.test.ts

-    expect(
-      rsbuild.logs.some((log) => log.includes('building src/page2/index.js')),
-    ).toBeFalsy();
+    rsbuild.expectNoLog('building src/page2/index.js');


The expectNoLog call is missing await. Since this is used in an async test context and other expectLog calls are awaited, this should also be awaited for consistency.

Suggested change

rsbuild.expectNoLog('building src/page2/index.js');

await rsbuild.expectNoLog('building src/page2/index.js');

Copilot · 2025-08-18T13:35:17Z

e2e/cases/css/enable-experiments-css/index.test.ts

-  expect(
-    rsbuild.logs.some((log) => log.includes('Compile Warning')),
-  ).toBeFalsy();
+  rsbuild.expectNoLog(COMPILE_WARNING);


The expectNoLog call is missing await. Since this is used in an async test context, it should be awaited for proper test execution.

Suggested change

rsbuild.expectNoLog(COMPILE_WARNING);

await rsbuild.expectNoLog(COMPILE_WARNING);

Copilot · 2025-08-18T13:35:17Z

e2e/cases/css/enable-experiments-css/index.test.ts

-    expect(
-      rsbuild.logs.some((log) => log.includes('Compile Warning')),
-    ).toBeFalsy();
+    rsbuild.expectNoLog(COMPILE_WARNING);


The expectNoLog call is missing await. Since this is used in an async test context, it should be awaited for proper test execution.

Suggested change

rsbuild.expectNoLog(COMPILE_WARNING);

await rsbuild.expectNoLog(COMPILE_WARNING);

Copilot · 2025-08-18T13:35:17Z

e2e/cases/config/stats-options/index.test.ts

-    ),
-  ).toBeFalsy();
-
+  rsbuild.expectNoLog(WARNING_MSG);


The expectNoLog call is missing await. Since this is used in an async test context and other expectLog calls are awaited, this should also be awaited for consistency.

Suggested change

rsbuild.expectNoLog(WARNING_MSG);

await rsbuild.expectNoLog(WARNING_MSG);

Copilot · 2025-08-18T13:35:18Z

e2e/cases/cli/build-watch-options/index.test.ts

-    expect(
-      logs.some((log) => /building test-temp-src[\\/]bar.js/.test(log)),
-    ).toBeFalsy();
+    expectNoLog(/building test-temp-src[\\/]bar.js/);


The expectNoLog call is missing await. Since this is used in an async test context and other expectLog calls are awaited, this should also be awaited for consistency.

Suggested change

expectNoLog(/building test-temp-src[\\/]bar.js/);

await expectNoLog(/building test-temp-src[\\/]bar.js/);

test(test): add helper to assert no logs

5ae6b4c

Copilot AI review requested due to automatic review settings August 18, 2025 13:29

chenjiahan merged commit 6ceaf0f into main Aug 18, 2025
12 checks passed

chenjiahan deleted the asset_no_logs_0818 branch August 18, 2025 13:34

chenjiahan changed the title ~~test(test): add helper to assert no logs~~ test(e2e): add helper to assert no logs Aug 18, 2025

Copilot AI reviewed Aug 18, 2025

View reviewed changes

chenjiahan mentioned this pull request Aug 19, 2025

release: 1.5.0-beta.4 #5885

Merged

	const expectNoLog = (pattern: LogPattern) => {
	const expectNoLog = async (pattern: LogPattern) => {

	rsbuild.expectNoLog('Total:');
	await rsbuild.expectNoLog('Total:');

	rsbuild.expectNoLog('building src/page2/index.js');
	await rsbuild.expectNoLog('building src/page2/index.js');

	rsbuild.expectNoLog(COMPILE_WARNING);
	await rsbuild.expectNoLog(COMPILE_WARNING);

	rsbuild.expectNoLog(WARNING_MSG);
	await rsbuild.expectNoLog(WARNING_MSG);

	expectNoLog(/building test-temp-src[\\/]bar.js/);
	await expectNoLog(/building test-temp-src[\\/]bar.js/);

Uh oh!

Conversation

chenjiahan commented Aug 18, 2025

Summary

Checklist

Uh oh!

netlify bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rsbuild ready!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Aug 18, 2025 •

edited

Loading