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.

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

fix: esm suport #5298

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

xiaoxiangmoe
Copy link

Which problem is this PR solving?

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Short description of the changes

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

check compiled dist has no require('...') expression

Checklist:

  • Followed the style guidelines of this project
  • Unit tests have been added
  • Documentation has been updated

@xiaoxiangmoe xiaoxiangmoe requested a review from a team as a code owner December 25, 2024 15:13
Copy link

linux-foundation-easycla bot commented Dec 25, 2024

CLA Signed


The committers listed above are authorized under a signed CLA.

@Netail
Copy link

Netail commented Dec 27, 2024

The requires were inline for lazy loading

@xiaoxiangmoe
Copy link
Author

xiaoxiangmoe commented Dec 27, 2024

@Netail This is not too much code so it it not needed for use lazy loading. Also, use require in esm is illegal.

@pichlermarc
Copy link
Member

pichlermarc commented Jan 7, 2025

@Netail This is not too much code so it it not needed for use lazy loading.

It's there to avoid loading things that may not exist on all platforms (see failing tests looks like the tests are not failing here - there may be some gaps in our tests)

Also, use require in esm is illegal.

ACK - please change the code to use dynamic imports instead to keep in line with the original intentions of the code.

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

Attention: Patch coverage is 54.54545% with 5 lines in your changes missing coverage. Please review.

Project coverage is 94.59%. Comparing base (90afa28) to head (a5a9655).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...detectors/platform/node/machine-id/getMachineId.ts 54.54% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5298      +/-   ##
==========================================
- Coverage   94.62%   94.59%   -0.04%     
==========================================
  Files         323      324       +1     
  Lines        8068     8078      +10     
  Branches     1637     1637              
==========================================
+ Hits         7634     7641       +7     
- Misses        434      437       +3     
Files with missing lines Coverage Δ
...detectors/platform/node/machine-id/getMachineId.ts 47.82% <54.54%> (+12.53%) ⬆️

... and 1 file with indirect coverage changes

@chancancode
Copy link
Contributor

It's there to avoid loading things that may not exist on all platforms (see failing tests looks like the tests are not failing here - there may be some gaps in our tests)

I took a look during the holidays: in this particular case as the code is currently written, they don't import any platform-specific feature, they only try to run a command and parse the result, so won't blow up until the function is called, that's why.

Functionally it probably wouldn't have been a big deal to refactor/consolidate the modules, but agreed that it is bad form to drop this for no other reason if dynamic imports work on the supported platform.

@xiaoxiangmoe
Copy link
Author

👌 I'll create a fix to using dynamic import

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.

4 participants