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.

Sign up for GitHub

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

Jump to bottom

Fixes: #56518 - Warning Message for .cjs Files Using import Statements #56618

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fixes: #56518 - Warning Message for .cjs Files Using import Statements #56618

wants to merge 6 commits into from

Conversation

wongprom
Copy link

Summary

This PR introduces the following changes to address issue #56518:

Add a specific warning for .cjs files using import statements:

  • Displays a clear error message to inform users that .cjs files do not support import and advises them to use require() instead.

Update tests:

  • Added a test case in test/es-module/test-cjs-esm-warn.js to validate the warning message.
  • Test compares the exact string value of the warning for now but could be optimized in the future to validate only the critical parts of the message.

Refactored src/node_contextify.cc:

  • Added GetFileExtension and GetWarningMessage helper functions for better code readability and modularity.

Details

Testing:

  • Verified the changes with the test suite using make -j6 test. All tests passed successfully.
  • Validated linting with make lint.

Changes:

  • Removed the temporary jimmy.cjs test file after confirming its purpose was fulfilled during development.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  1. The contribution was created in whole or in part by me, and I have the right to submit it under the open source license indicated in the file.
  2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part, by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file.
  3. The contribution was provided directly to me by some other person who certified (1), (2), or (3) and I have not modified it.
  4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Additional Notes

  • The test compares the exact warning string. Future improvements could involve matching only essential parts of the message for better flexibility.

@wongprom
Add new jimmy.cjs file and test log in .cc file.
db48cff
@wongprom
Improve error handling and file extension detection in node_contextif…
85d2a9d 
…y.cc

- Added a utility function GetFileExtension to extract file extensions from filenames.
- Enhanced the require_esm_warning logic to dynamically generate appropriate error messages based on file extensions.
- Included a TODO comment to enhance error messages further with specific package.json file locations if applicable.
- Cleaned up and removed redundant code for better maintainability and clarity.
@wongprom
Refactor: Implement Factory Pattern for ESM warning messages
d18bd7d 
- Extracted warning message logic into a dedicated `GetWarningMessage` function.
- Encapsulated file extension handling and warning generation for improved reusability.
- Updated relevant code sections to use the new factory-style function.
- Aligns with existing design patterns and improves maintainability.
@wongprom
test, src: add and refactor tests for CJS ↔︎ ESM interop warnings
5488e72 
- Added new tests for invalid imports in .cjs files.
- Added tests for loading .mjs files in CommonJS packages.
- Refactored assertions to align with project lint rules.
- Verified all tests pass with Node.js tools and addressed related errors.
- Formatted src/node_contextify.cc using clang-format for consistent code style.

Refs: nodejs#56518
@wongprom
test,src: add warning message validation for .cjs imports
258dfd8 
- Updated `GetWarningMessage` in `node_contextify.cc` to handle `.cjs` files and emit appropriate warnings.
- Normalized the warning message in tests to simplify comparison and improve readability.
- Added specific tests to verify warnings for invalid imports in `.cjs` files and handling of `.mjs` in CommonJS packages.

Note: The test currently compares the exact string value for warnings. This could be optimized by validating only the critical parts of the warning message.

Refs: nodejs#56518
@wongprom
Remove jimmy.cjs test file
161e627
@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. vm Issues and PRs related to the vm subsystem. labels Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run. vm Issues and PRs related to the vm subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wongprom @nodejs-github-bot