Skip to content

test(v4): verify cjs module compatibility#90

Open
colinaaa wants to merge 1 commit intorstackjs:v4from
colinaaa:feat/test-cjs-compat
Open

test(v4): verify cjs module compatibility#90
colinaaa wants to merge 1 commit intorstackjs:v4from
colinaaa:feat/test-cjs-compat

Conversation

@colinaaa
Copy link
Collaborator

This PR adds test cases to verify that the plugin's transform logic does not break the loading of CommonJS modules.

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the testing suite by adding comprehensive tests to confirm that the plugin maintains compatibility with CommonJS modules. The new tests ensure that the plugin's build process correctly handles CJS imports and exports, preventing any regressions or unexpected behavior when integrating with existing CJS-based codebases.

Highlights

  • CJS Module Compatibility Testing: New test cases have been introduced to specifically verify that the plugin's transformation logic does not interfere with the proper loading and functionality of CommonJS modules.
  • Playwright Integration: The compatibility tests utilize Playwright to simulate a browser environment, ensuring that the CJS module content is correctly rendered and accessible on the page after being processed by Rsbuild.
  • Dedicated Test Environment: A dedicated test directory (test/cjs-compat) has been created, containing a test file, an entry point JavaScript file, and a sample CommonJS module (lib.cjs) to isolate and validate the CJS compatibility.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • test/cjs-compat/index.test.ts
    • Added a new Playwright test file to verify that the plugin does not break CommonJS module loading.
    • Configured an Rsbuild instance with the plugin and built a test application.
    • Launched a preview server and asserted that content from a CJS module is correctly displayed in the browser.
  • test/cjs-compat/src/index.js
    • Added a JavaScript entry point for the CJS compatibility test.
    • Imports a CommonJS module and appends its message to a div element in the document body.
  • test/cjs-compat/src/lib.cjs
    • Added a sample CommonJS module (lib.cjs) that exports a message and an array of data.
    • This module serves as the target for the CJS compatibility test.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This PR adds test cases to verify that the plugin's transform logic does not break the loading of CommonJS modules. The implementation is clear and the test correctly validates the intended behavior. I have one suggestion to improve the test's robustness by ensuring proper resource cleanup.

Comment on lines +20 to +25
await page.goto(urls[0]);

const locator = page.locator('#cjs-output');
await expect(locator).toHaveText('Hello from CJS');

await server.close();

Choose a reason for hiding this comment

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

medium

The test logic that interacts with the server should be wrapped in a try...finally block. This ensures that server.close() is always called, even if assertions within the try block fail. This prevents leaving dangling server processes, which can lead to resource leaks and instability in test environments.

  try {
    await page.goto(urls[0]);

    const locator = page.locator('#cjs-output');
    await expect(locator).toHaveText('Hello from CJS');
  } finally {
    await server.close();
  }

@colinaaa colinaaa changed the title test: verify cjs module compatibility test(v4): verify cjs module compatibility Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant