fix: esm module resolve issues #754

yeliex · 2024-02-05T03:26:00Z

this commit fix some esm module resolve bugs

convert fileUrl to path before compile in esm, which may cause path alias resolve issue to align with previous behavior. close @swc-node/register@1.8.0 /esm-register does not recognise tsconfig.json paths #753
remove baseUrl from esm to keep module import specifier, as we use tsc resolver.

this commit convert fileUrl to path before compile in esm, this may cause path alias resolve issue close swc-project#753

changeset-bot · 2024-02-05T03:26:04Z

🦋 Changeset detected

Latest commit: bd4e32f

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

psychobolt · 2024-02-09T17:22:52Z

@yeliex Hi I have a similar issue, but when the resolve's specifier begins with file protocol e.g. file://. I current have this patch:

diff --git a/esm/esm.mjs b/esm/esm.mjs
index 8453ae2480391c8eb5cc18d5460bd55b723592ce..a62fa5753df9a00f9680adc8dea7b005dea82f6e 100644
--- a/esm/esm.mjs
+++ b/esm/esm.mjs
@@ -13,7 +13,8 @@ const host = {
 };
 const EXTENSIONS = [ts.Extension.Ts, ts.Extension.Tsx, ts.Extension.Mts];
 export const resolve = async (specifier, context, nextResolve) => {
-    const isTS = EXTENSIONS.some((ext) => specifier.endsWith(ext));
+    const modulePath = specifier.startsWith('file://') ? fileURLToPath(specifier) : specifier;
+    const isTS = EXTENSIONS.some((ext) => modulePath.endsWith(ext));
     // entrypoint
     if (!context.parentURL) {
         return {
@@ -26,7 +27,7 @@ export const resolve = async (specifier, context, nextResolve) => {
     if (context.parentURL.includes('/node_modules/') && !isTS) {
         return nextResolve(specifier);
     }
-    const { resolvedModule } = ts.resolveModuleName(specifier, fileURLToPath(context.parentURL), tsconfig, host, moduleResolutionCache);
+    const { resolvedModule } = ts.resolveModuleName(modulePath, fileURLToPath(context.parentURL), tsconfig, host, moduleResolutionCache);
     // import from local project to local project TS file
     if (resolvedModule &&
         !resolvedModule.resolvedFileName.includes('/node_modules/') &&

yeliex · 2024-02-18T09:56:00Z

@psychobolt This caused a ci failure, maybe a complication issue with @swc/core. I am trying to resolve this, and filling more test cases

…t use tsc resolver

yeliex · 2024-03-03T13:41:08Z

The pr should fix these issues as well, but not test for each. feedback required.

#758
#753
#734
#727 (comment)

mylesj

Thanks for looking into this @yeliex. I tried this against my original bug report and can confirm that this runs as expected with the newer --import loader. However it unfortunately also breaks the original register method.

Error: failed to handle: base_dir(``) must be absolute. Please ensure that jsc.baseUrl is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if .swcrc is used, but if not, there are many candidates. e.g. the directory containing package.json, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it.

Full stack trace

❯ pn esm

> swc-node-esm-register-issue@ esm /Users/myles/dev/issue-swc-node-1
> node --import @swc-node/register/esm-register src/index.ts

hello
❯ pn cjs

> swc-node-esm-register-issue@ cjs /Users/myles/dev/issue-swc-node-1
> node -r @swc-node/register src/index.ts

thread '<unnamed>' panicked at /Users/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/swc_ecma_transforms_module-0.179.5/src/path.rs:122:13:
base_dir(``) must be absolute. Please ensure that `jsc.baseUrl` is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if `.swcrc` is used, but if not, there are many candidates. e.g. the directory containing `package.json`, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it. If you see this error, please report an issue to the package author.
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:244
            return bindings.transformSync(isModule ? JSON.stringify(src) : src, isModule, toBuffer(newOptions));
                            ^

Error: failed to handle: base_dir(``) must be absolute. Please ensure that `jsc.baseUrl` is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if `.swcrc` is used, but if not, there are many candidates. e.g. the directory containing `package.json`, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it. If you see this error, please report an issue to the package author.
    at Compiler.transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:244:29)
    at transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:351:21)
    at transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc-node+core@1.12.0_@swc+core@1.3.107_@swc+types@0.1.5/node_modules/@swc-node/core/index.ts:90:26)
    at compile (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/file+.yalc+@swc-node+register_@swc+core@1.3.107_@swc+types@0.1.5_typescript@5.3.3/node_modules/@swc-node/register/register.ts:105:40)
    at exts (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/file+.yalc+@swc-node+register_@swc+core@1.3.107_@swc+types@0.1.5_typescript@5.3.3/node_modules/@swc-node/register/register.ts:116:38)
    at Module._compile (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/pirates@4.0.6/node_modules/pirates/lib/index.js:113:29)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Object.newLoader [as .ts] (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/pirates@4.0.6/node_modules/pirates/lib/index.js:121:7)
    at Module.load (node:internal/modules/cjs/loader:1207:32)
    at Function.Module._load (node:internal/modules/cjs/loader:1023:12) {
  code: 'GenericFailure'
}

Node.js v20.11.0
 ELIFECYCLE  Command failed with exit code 1.

cghiurea · 2024-03-04T00:09:04Z

The pr should fix these issues as well, but not test for each. feedback required.

#758 #753 #734 #727 (comment)

@yeliex I am willing to test this on our project. Any instructions on how I can install the module from this pr? Or is it already published ?

yeliex · 2024-03-04T00:10:40Z

The pr should fix these issues as well, but not test for each. feedback required.

#758 #753 #734 #727 (comment)

@yeliex I am willing to test this on our project. Any instructions on how I can install the module from this pr? Or is it already published ?

install package as git url or link locally

yeliex · 2024-03-04T00:12:42Z

Thanks for looking into this @yeliex. I tried this against my original bug report and can confirm that this runs as expected with the newer --import loader. However it unfortunately also breaks the original register method.

Error: failed to handle: base_dir(``) must be absolute. Please ensure that jsc.baseUrl is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if .swcrc is used, but if not, there are many candidates. e.g. the directory containing package.json, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it.

Full stack trace


❯ pn esm



> swc-node-esm-register-issue@ esm /Users/myles/dev/issue-swc-node-1

> node --import @swc-node/register/esm-register src/index.ts



hello

❯ pn cjs



> swc-node-esm-register-issue@ cjs /Users/myles/dev/issue-swc-node-1

> node -r @swc-node/register src/index.ts



thread '<unnamed>' panicked at /Users/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/swc_ecma_transforms_module-0.179.5/src/path.rs:122:13:

base_dir(``) must be absolute. Please ensure that `jsc.baseUrl` is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if `.swcrc` is used, but if not, there are many candidates. e.g. the directory containing `package.json`, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it. If you see this error, please report an issue to the package author.

note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:244

            return bindings.transformSync(isModule ? JSON.stringify(src) : src, isModule, toBuffer(newOptions));

                            ^



Error: failed to handle: base_dir(``) must be absolute. Please ensure that `jsc.baseUrl` is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if `.swcrc` is used, but if not, there are many candidates. e.g. the directory containing `package.json`, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it. If you see this error, please report an issue to the package author.

    at Compiler.transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:244:29)

    at transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc+core@1.3.107/node_modules/@swc/core/index.js:351:21)

    at transformSync (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/@swc-node+core@1.12.0_@swc+core@1.3.107_@swc+types@0.1.5/node_modules/@swc-node/core/index.ts:90:26)

    at compile (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/file+.yalc+@swc-node+register_@swc+core@1.3.107_@swc+types@0.1.5_typescript@5.3.3/node_modules/@swc-node/register/register.ts:105:40)

    at exts (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/file+.yalc+@swc-node+register_@swc+core@1.3.107_@swc+types@0.1.5_typescript@5.3.3/node_modules/@swc-node/register/register.ts:116:38)

    at Module._compile (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/pirates@4.0.6/node_modules/pirates/lib/index.js:113:29)

    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)

    at Object.newLoader [as .ts] (/Users/myles/dev/issue-swc-node-1/node_modules/.pnpm/pirates@4.0.6/node_modules/pirates/lib/index.js:121:7)

    at Module.load (node:internal/modules/cjs/loader:1207:32)

    at Function.Module._load (node:internal/modules/cjs/loader:1023:12) {

  code: 'GenericFailure'

}



Node.js v20.11.0

 ELIFECYCLE  Command failed with exit code 1.

it looks not the same issue. i would looking this later today

yeliex · 2024-03-04T02:30:55Z

Thanks for looking into this @yeliex. I tried this against my original bug report and can confirm that this runs as expected with the newer --import loader. However it unfortunately also breaks the original register method.

Error: failed to handle: base_dir(``) must be absolute. Please ensure that jsc.baseUrl is specified correctly. This cannot be deduced by SWC itself because SWC is a transpiler and it does not try to resolve project details. In other words, SWC does not know which directory should be used as a base directory. It can be deduced if `.swcrc` is used, but if not, there are many candidates. e.g. the directory containing `package.json`, or the current working directory. Because of that, the caller (typically the developer of the JavaScript package) should specify it.

Full stack trace

@mylesj add "baseUrl": "./" to tsconfig should resolve commonjs register issue.It is better to add a format validation to readDefaultTsConfig to align with swc/cli (or we should default use path of tsconfig.json to align with tsc cause this config reads from tsconfig? https://www.typescriptlang.org/tsconfig#paths) @Brooooooklyn @kdy1

mylesj · 2024-03-04T08:25:52Z

Thanks that does indeed address the issue locally, I just mentioned it to highlight the breaking API change. TypeScript documents the following under the baseUrl config so I think it is in your interest to align. My understanding of swc and associated tooling is that it is intended as a drop-in replacement for tsc - or at least that has become an expectation.

As of TypeScript 4.1, baseUrl is no longer required to be set when using paths.

yeliex · 2024-03-04T08:52:55Z

Thanks that does indeed address the issue locally, I just mentioned it to highlight the breaking API change. TypeScript documents the following under the baseUrl config so I think it is in your interest to align. My understanding of swc and associated tooling is that it is intended as a drop-in replacement for tsc - or at least that has become an expectation.

As of TypeScript 4.1, baseUrl is no longer required to be set when using paths.

I have created a new PR to fix this, keeping the behavior with tsc and the previous versions of swc-node.

I Agree that it is better for swc-node/register to be compatible with ts-node(Attention: swc is not exactly the same as tsc, and should not be).

alfaproject · 2024-03-07T08:33:04Z

So, there's still some issue with resolves. TS paths now work correctly which is awesome but now deep imports from aws-sdk package for example, break:

> node --import @swc-node/register/esm-register ./apps/lambda-api/src/extract-schema.ts && prettier --write ./apps/lambda-api/src/schema.graphql


node:internal/process/esm_loader:34
      internalBinding('errors').triggerUncaughtException(
                                ^
Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/Users/joaodias/the-mill/lambda-gaming.nosync/node_modules/aws-sdk/clients/dynamodb' imported from /Users/joaodias/the-mill/lambda-gaming.nosync/libs/node-aws/src/dynamodb/dynamodb-sdk.ts
Did you mean to import aws-sdk@2.1536.0/node_modules/aws-sdk/clients/dynamodb.js?
    at finalizeResolution (node:internal/modules/esm/resolve:264:11)
    at moduleResolve (node:internal/modules/esm/resolve:917:10)
    at defaultResolve (node:internal/modules/esm/resolve:1130:11)
    at nextResolve (node:internal/modules/esm/hooks:865:28)
    at resolve (file:///Users/joaodias/the-mill/lambda-gaming.nosync/node_modules/.pnpm/@swc-node+register@1.9.0_@swc+core@1.4.2_@swc+types@0.1.5_typescript@5.2.2/node_modules/@swc-node/register/esm/esm.mjs:44:12)
    at nextResolve (node:internal/modules/esm/hooks:865:28)
    at Hooks.resolve (node:internal/modules/esm/hooks:303:30)
    at handleMessage (node:internal/modules/esm/worker:196:24)
    at Immediate.checkForMessages [as _onImmediate] (node:internal/modules/esm/worker:138:28)
    at process.processImmediate (node:internal/timers:478:21) {
  code: 'ERR_MODULE_NOT_FOUND',
  url: 'file:///Users/joaodias/the-mill/lambda-gaming.nosync/node_modules/aws-sdk/clients/dynamodb'
}

yeliex · 2024-03-07T08:35:04Z

@alfaproject could u please provide a minimal reproduction

alfaproject · 2024-03-20T06:37:54Z

@yeliex the problem seems to be lack of .js file extension in imports but it's a very big project so I think I'll continue using CJS for now ):

yeliex · 2024-03-20T06:42:41Z

@yeliex the problem seems to be lack of .js file extension in imports but it's a very big project so I think I'll continue using CJS for now ):

maybe the same as packages/register/test/ts-compiler-options-to-swc-config.spec.ts

check your baseUrl and paths config in tsconfig and swcrc

alfaproject · 2024-03-20T11:33:48Z

I get the same error with or without baseUrl. This is a Nx mono repo so I also tried to run the command in the subfolder of the project but then I get another error related to paths. Oh well...

I really appreciate your help but I think I'll need to drop this for the time being. I couldn't get our Jest tests to work with full ESM either so either way, we are kind of blocked in having everything ESM first, unfortunately

fix: convert fileUrl to path before compile

8e25c4c

this commit convert fileUrl to path before compile in esm, this may cause path alias resolve issue close swc-project#753

Create changeset

b5a0838

yeliex changed the title ~~fix: convert fileUrl to path before compile~~ WIP: fix: convert fileUrl to path before compile Feb 5, 2024

yeliex mentioned this pull request Feb 5, 2024

@swc-node/register@1.8.0 /esm-register does not recognise tsconfig.json paths #753

Closed

This was referenced Feb 9, 2024

feat: Improve performance of running TypeScript files psychobolt/vite-storybook-boilerplate#261

Closed

@swc-node/register/esm doesn't recognize .ts file #710

Open

psychobolt mentioned this pull request Feb 19, 2024

@swc-node/register — Files are not transpiled on Windows with tsconfig.json present swc-project/swc#8639

Open

c3cris mentioned this pull request Feb 23, 2024

SWC does not transpile on Windows if tsconfig.json is present in cwd where the cmd is ran #758

Closed

yeliex added 2 commits March 2, 2024 19:26

chore: update test:module to use node --import

17fa9fc

fix: remove baseUrl from esm to keep module import specifier, cause i…

bd4e32f

…t use tsc resolver

yeliex changed the title ~~WIP: fix: convert fileUrl to path before compile~~ fix: esm module resolve bugs Mar 3, 2024

yeliex changed the title ~~fix: esm module resolve bugs~~ fix: esm module resolve issues Mar 3, 2024

mylesj reviewed Mar 3, 2024

View reviewed changes

kdy1 self-assigned this Mar 4, 2024

kdy1 approved these changes Mar 4, 2024

View reviewed changes

kdy1 merged commit d35ddf1 into swc-project:master Mar 4, 2024
7 checks passed

yeliex deleted the patch-1 branch March 4, 2024 01:49

yeliex mentioned this pull request Mar 4, 2024

Syntax error after updating to 1.6.8 #734

Closed

yeliex mentioned this pull request Mar 4, 2024

fix: add default tsconfig.baseUrl to align with tsc behavior #759

Merged

yeliex mentioned this pull request May 29, 2024

feat: update esm module resolver #781

Merged

snyk-io bot mentioned this pull request Jun 19, 2024

[Snyk] Upgrade @swc-node/register from 1.9.0 to 1.9.1 Opetushallitus/ludos#145

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: esm module resolve issues #754

fix: esm module resolve issues #754

yeliex commented Feb 5, 2024 •

edited

Loading

changeset-bot bot commented Feb 5, 2024 •

edited

Loading

psychobolt commented Feb 9, 2024

yeliex commented Feb 18, 2024

yeliex commented Mar 3, 2024 •

edited

Loading

mylesj left a comment •

edited

Loading

cghiurea commented Mar 4, 2024

yeliex commented Mar 4, 2024

yeliex commented Mar 4, 2024

yeliex commented Mar 4, 2024 •

edited

Loading

mylesj commented Mar 4, 2024

yeliex commented Mar 4, 2024 •

edited

Loading

alfaproject commented Mar 7, 2024

yeliex commented Mar 7, 2024 •

edited

Loading

alfaproject commented Mar 20, 2024

yeliex commented Mar 20, 2024

alfaproject commented Mar 20, 2024

fix: esm module resolve issues #754

fix: esm module resolve issues #754

Conversation

yeliex commented Feb 5, 2024 • edited Loading

changeset-bot bot commented Feb 5, 2024 • edited Loading

🦋 Changeset detected

psychobolt commented Feb 9, 2024

yeliex commented Feb 18, 2024

yeliex commented Mar 3, 2024 • edited Loading

mylesj left a comment • edited Loading

Choose a reason for hiding this comment

cghiurea commented Mar 4, 2024

yeliex commented Mar 4, 2024

yeliex commented Mar 4, 2024

yeliex commented Mar 4, 2024 • edited Loading

mylesj commented Mar 4, 2024

yeliex commented Mar 4, 2024 • edited Loading

alfaproject commented Mar 7, 2024

yeliex commented Mar 7, 2024 • edited Loading

alfaproject commented Mar 20, 2024

yeliex commented Mar 20, 2024

alfaproject commented Mar 20, 2024

yeliex commented Feb 5, 2024 •

edited

Loading

changeset-bot bot commented Feb 5, 2024 •

edited

Loading

yeliex commented Mar 3, 2024 •

edited

Loading

mylesj left a comment •

edited

Loading

yeliex commented Mar 4, 2024 •

edited

Loading

yeliex commented Mar 4, 2024 •

edited

Loading

yeliex commented Mar 7, 2024 •

edited

Loading