Components: use full import paths with JS extensions

[nateweller]

Proposed changes:

• Updates the @automattic/jetpack-components package to specify .js extensions in import paths, and changes directory imports to specify /index.js.
• Adds the .jsx extension to the supported aliases in storybook and webpack configs.

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

peb6dq-3ta-p2

Does this pull request change what data or activity we track or use?

No

Testing instructions:

• TBD
  • Review automated tests.
  • Smoke test plugins?

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/components/js-imports branch.

  • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

• To test on Simple, run the following command on your sandbox:

  bin/jetpack-downloader test jetpack add/components/js-imports
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/components/js-imports
  

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• 🔴 Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Choose a review path based on your changes:
   • A. Team Review: add the "[Status] Needs Team Review" label
     • For most changes, including minor cross-team impacts.
     • Example: Updating a team-specific component or a small change to a shared library.
   • B. Crew Review: add the "[Status] Needs Review" label
     • For significant changes to core functionality.
     • Example: Major updates to a shared library or complex features.
   • C. Both: Start with Team, then request Crew
     • For complex changes or when you need extra confidence.
     • Example: Refactor affecting multiple systems.
3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

[github-actions]

Code Coverage Summary

Cannot generate coverage summary while tests are failing. 🤐

Please fix the tests, or re-run the Code coverage job if it was something being flaky.

Full summary · PHP report · JS report

[anomiex]

Looks good as far as it goes. Some comments inline.

I'm tempted to add a new tools/js-tools/tsconfig.nodenext.json that sets "module" and "moduleResoltion" to "nodenext" but leaves "noEmit" false, so future PRs will get checked with the right options to require the full paths. OTOH, if someone is going to immediately follow this up with updating it to create a build/ dir, there may not be much need for that. 🤷

[anomiex]

At some point this may cause problems. Ideally we really shouldn't be trying to relative-include files from outside of the package, instead this should be something like import { STORE_ID as CONNECTION_STORE_ID } from '@automattic/jetpack-connection';.

Probably someone did it this way because js-packages/connection also depends on js-packages/components, and the bidirectional dependency makes our tooling unhappy. Maybe it needs to be changed so the necessary info gets passed into this component, or maybe the component should be moved to the connection js-package. Or maybe there's a better idea I don't know about. 😀

Anyway, fixing that can be a left for a different PR.

[nateweller]

Yeah, the cyclical dependency is an issue. Updating that relative import that reaches outside of the package to use the .js extension appears to break the JS Tests on this PR as well.

[anomiex]

For now, let's just leave this one as jsx. We'll need to fix the circular dependency anyway before we can make this build properly.

As for the test, it looks like the ts-jest-resolver package we're using doesn't properly handle TypeScript's jsx option, so it doesn't check for the .jsx extension. At some point I'll probably need to work around that somehow too.

[anomiex]

Rather than 8e011ec, I think the correct fix would be to add .jsx into the relevant webpack configurations.

When tsc is used to build files it doesn't transform the extensions in imports, so the extensions used need to match what the output file is going to be. To support this, we have Webpack configured to do the same mappings. But in #35453 I apparently forgot to include .jsx.

jetpack/projects/js-packages/webpack-config/src/webpack.js

Line 116 in d4ee689

'.js': [ '.js', '.ts', '.tsx' ],

jetpack/projects/js-packages/storybook/storybook/main.js

Line 114 in d4ee689

'.js': [ '.js', '.ts', '.tsx' ],