feat: add NodeJS version #23

rtritto · 2024-09-28T14:13:14Z

Create a NodeJS version, so it can be used with https://github.com/elysiajs/node-adapter

Differences

use fs.globSync (it's introduced with NodeJS 22.0.0) instead of Bun.glob
use fs.writeFileSync instead Bun.write

Notes:

@types/node is added as dev dependency because globSync (Node v22) isn't recognized.
@types/bun include @types/node but is v20 (and not >=v22).
After Update @types/node dependency version oven-sh/bun#13987 is merged, @types/node dev dependency can be removed.

TODO

test build
.ts/.tsx files needs to be transpiled

Fix #30

kravetsone · 2024-09-29T00:06:39Z

Why not typeof bun === "undefined"

kravetsone · 2024-09-29T00:07:12Z

Also we should check that esbuild plugin not broken with it

rtritto · 2024-09-29T04:29:07Z

Why not typeof bun === "undefined"

Done, thanks!

rtritto · 2024-09-29T11:19:14Z

Also we should check that esbuild plugin not broken with it

I tested on Windows side:

with Vite/Vike (esbuild in the hood):

with Node, using @elysia/node, I get:

Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'

We should change:

elysia-autoload/src/index.ts

Line 137 in 5920060

const file = await import(fullPath);

- const file = await import(fullPath);
+ import { pathToFileURL } from 'node:url';
+ const fileURL = pathToFileURL(fullPath);
+ const file = await import(fileURL.href);

Should we do the change in this PR?

with Bun, I have no issue

without Vite/Vike, I have no issues:
- with Node + @elysia/node
- with Bun

rtritto · 2024-09-29T11:36:26Z

I added @types/node dev dependency because globSync (Node v22) isn't recognized.
@types/bun also include @types/node but is v20 (Node v20).
After oven-sh/bun#13987 is merged, @types/node dev dependency can be removed.

kravetsone · 2024-10-01T17:17:12Z

Also we should check that esbuild plugin not broken with it

I tested on Windows side:
with Vite/Vike (esbuild in the hood):
with Node, using @elysia/node, I get:
Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'
We should change:

elysia-autoload/src/index.ts

Line 137 in 5920060

const file = await import(fullPath);
- const file = await import(fullPath);
+ import { pathToFileURL } from 'node:url'
+ const fileURL = pathToFileURL(fullPath);
+ const file = await import(fileURL.href);
Should we do the change in this PR?
with Bun, I have no issue
without Vite/Vike, I have no issues:

with Node + @elysia/node

with Bun

based i see this issue in my https://github.com/gramiojs/autoload too

Bun just works fine

kravetsone · 2024-10-01T17:18:56Z

Also we should check that esbuild plugin not broken with it

did u try it?
https://github.com/kravetsone/esbuild-plugin-autoload

But for now it uses Bun.Glob api (only in Bun.build step)

rtritto · 2024-10-02T15:57:37Z

based i see this issue in my https://github.com/gramiojs/autoload too

Bun just works fine

I know.
Bun maybe wraps always (Windows or not) the parameter of import with pathToFileURL and get href.
Anyway the fix of dynamic import in Windows (maybe with pathToFileURL will be done in another PR (this PR is related to Node support)).
Opened #24 to discuss.

rtritto · 2024-10-02T16:19:10Z

Also we should check that esbuild plugin not broken with it

did u try it? https://github.com/kravetsone/esbuild-plugin-autoload

But for now it uses Bun.Glob api (only in Bun.build step)

Not yet

rtritto · 2024-10-02T18:57:00Z

How can we test with esbuild?

It that https://github.com/kravetsone/esbuild-plugin-autoload?tab=readme-ov-file#esbuild-usage the correct reference?

Draft:

await esbuild
  .build({
    target: "bun",
    outdir: "out",
    plugins: [{
      name: 'elysia-autoload',
      setup: autoload
    }]
  })
  .then(console.log)

rtritto · 2024-10-09T15:24:00Z

Changed to use glob with async iteration with streams.
If needed, sortByNestedParams function can be restored and used to paths array (after for async).

elysia-autoload/src/index.ts

Line 132 in a059f51

const paths: [path: string, exportName: string][] = [];

rtritto · 2024-10-10T07:23:20Z

This logic can be restored:

  const paths: [path: string, exportName: string][] = [];

  for await (const filePath of files) {
  // ...
-    if (types) paths.push([fullPath.replace(directoryPath, ""), importName]);
+    paths.push([fullPath.replace(directoryPath, ""), importName]);
  }

+  if (failGlob && files.length === 0)
+    throw new Error(
+      `No matches found in ${directoryPath}. You can disable this error by setting the failGlob parameter to false in the options of autoload plugin`,
+    );

@kravetsone what do you think about?

kravetsone · 2024-10-10T07:54:19Z

This logic can be restored:

  const paths: [path: string, exportName: string][] = [];

  for await (const filePath of files) {
  // ...
-    if (types) paths.push([fullPath.replace(directoryPath, ""), importName]);
+    paths.push([fullPath.replace(directoryPath, ""), importName]);
  }

+  if (failGlob && files.length === 0)
+    throw new Error(
+      `No matches found in ${directoryPath}. You can disable this error by setting the failGlob parameter to false in the options of autoload plugin`,
+    );

@kravetsone what do you think about?

Idk why u drop it

rtritto · 2024-10-10T08:44:17Z

Because I changed the glob scan to async iteration with streams (https://bun.sh/docs/api/glob#quickstart) and the filepath list can't be collected.

kravetsone · 2024-10-10T09:30:56Z

Because I changed the glob scan to async iteration with streams (https://bun.sh/docs/api/glob#quickstart) and the filepath list can't be collected.

It is possible to add let isEmpty and in for if it false set to true
And u will know if generator return zero results
I guess maybe a better way exists but this way is okay too

kravetsone · 2024-10-10T09:33:31Z

Changed to use glob with async iteration with streams.
If needed, sortByNestedParams function can be restored and used to paths array (after for async).

elysia-autoload/src/index.ts

Line 132 in a059f51

const paths: [path: string, exportName: string][] = [];

I add sortByNestedParams to prevent some/[ok] be higher than some/ok

Because path with params should be connected in last way

rtritto · 2024-10-10T23:58:16Z

Changed to use glob with async iteration with streams.
If needed, sortByNestedParams function can be restored and used to paths array (after for async).

elysia-autoload/src/index.ts

Line 132 in a059f51

const paths: [path: string, exportName: string][] = [];

I add sortByNestedParams to prevent some/[ok] be higher than some/ok

Because path with params should be connected in last way

Ok, I restored the previous logic.

kravetsone · 2024-10-25T22:04:37Z

is this PR ready for merge?

kravetsone · 2024-10-25T22:07:48Z

Do we really need esbuild?

I guess we can recommend tsx to execute TS on NodeJS

It is also recommended in NodeJS documentation and it has support for import(".ts")

kravetsone · 2024-10-25T22:08:41Z

love this PR

also when elysia going to support node much better it really good

…o node-support

rtritto · 2024-10-27T10:17:41Z

is this PR ready for merge?

I don't know if we should add a message error when using NodeJS and missing esbuild.
Anyway README needs to be updated with NodeJS usage case (install esbuild when using .ts files etc).

Note: on merging this PR, I would use the squash (cleaner history) instead of the merge.

Do we really need esbuild?

NodeJS doesn't support .ts files. esbuild is an optional peer dependency.

I guess we can recommend tsx to execute TS on NodeJS

It is also recommended in NodeJS documentation and it has support for import(".ts")

tsx uses esbuild under the hood and esbuild is used widely (so it can be easily deduped and we have essentials dependencies).
If there is a pereferred (usefull) setting in tsx, we can copy it.

kravetsone · 2024-10-27T13:09:33Z

is this PR ready for merge?

I don't know if we should add a message error when using NodeJS and missing esbuild.
Anyway README needs to be updated with NodeJS usage case (install esbuild when using .ts files etc).

Note: on merging this PR, I would use the squash (cleaner history) instead of the merge.

Do we really need esbuild?

NodeJS doesn't support .ts files. esbuild is an optional peer dependency.

I guess we can recommend tsx to execute TS on NodeJS

It is also recommended in NodeJS documentation and it has support for import(".ts")

tsx uses esbuild under the hood and esbuild is used widely (so it can be easily deduped and we have essentials dependencies).
If there is a pereferred (usefull) setting in tsx, we can copy it.

I mean that tsx is de-facto standard and it mentioned in NodeJS documentation

So if some TypeScript executor isn't support .ts files it will be not our problem)
I guess no need to use esbuild directly in plugin
It's more about executor scope

rtritto · 2024-10-27T13:39:36Z

I mean that tsx is de-facto standard and it mentioned in NodeJS documentation

So if some TypeScript executor isn't support .ts files it will be not our problem)
I guess no need to use esbuild directly in plugin
It's more about executor scope

In the doc, tsx is used only with scripts (shell).
In our use case, we can use directly esbuild like vite and vike projects.
Another point where tsx (currently) uses esbuild@~0.23.0 and latest esbuild version is 0.24.0. Using directly esbuild as dev dependency, the user can choose which version to use (in case of problems or every kind of updates).

kravetsone · 2024-10-28T00:43:10Z

I mean that tsx is de-facto standard and it mentioned in NodeJS documentation

So if some TypeScript executor isn't support .ts files it will be not our problem)
I guess no need to use esbuild directly in plugin
It's more about executor scope

In the doc, tsx is used only with scripts (shell).
In our use case, we can use directly esbuild like vite and vike projects.
Another point where tsx (currently) uses esbuild@~0.23.0 and latest esbuild version is 0.24.0. Using directly esbuild as dev dependency, the user can choose which version to use (in case of problems or every kind of updates).

Didn't understand what u mean by "we can use directly" What's we get with it?

Seems like elysia application will be bundled or executed by tsx

rtritto · 2024-10-28T09:16:05Z

Didn't understand what u mean by "we can use directly" What's we get with it?

esbuild is a bundler and it's used to build and transpile.
tsx is used, in place of node command, to execute code (shell commands, package.json scripts etc) with a loader. Under the hood it uses esbuild to transpile and then execute.
With "directly" I mean that we can use the build function of esbuild instead of tsx that uses the build function of esbuild.

Seems like elysia application will be bundled or executed by tsx

Elysia is bundled with tsup (an alternative to pkgroll and that uses esbuild) and then with Bun (source). It's executed by Bun (Bun runtime with TypeScript).

Some differences: https://dev.to/andreasbergstrom/simplify-typescript-builds-with-esbuild-and-skip-tsctsx-2124

Some references:

kravetsone · 2024-10-28T17:41:14Z

yeah tsx is executor
esbuild is bundler

and classic user flow will be:

use tsx to execute typescript files (works with elysia-autoload because import(".ts") supported)
transpile it via bundler (works with elysia-autoload because files transpiled to .js)

So why we need to execute esbuild directly?

rtritto · 2024-10-29T10:11:26Z

When you start vite and vike, you don't use tsx because they use esbuild internally. At same way, elysia-autoload should use esbuild.
Use tsx when you need to start .ts (execute a file with no exports).
Use esbuild when you internally check the file extension and you can select the default or named export(s) to execute or use.

rtritto · 2024-12-03T15:23:10Z

@kravetsone the error TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /<FILE>.ts, with the dynamic import on Node.js for .ts and .tsx files, has a related issue with Vite: vitejs/vite#5370

As probably Bun do, a loader needs to be used on entrypoint.

So, I did a commit to remove esbuild.

Imo we can always use pathToFileURL (same as #30):

const file = await import(pathToFileURL(fullPath).href)

instead of

let file;
if (typeof Bun === "undefined")
  ? await import(pathToFileURL(fullPath).href)
  : await import(fullPath)

What do you think about?

rtritto · 2024-12-03T16:15:09Z

My comment: vitejs/vite#5370 (comment)

kravetsone · 2024-12-28T21:19:17Z

Thanks for the work! Love it

For final i guess we should not include any loaders to this library.
We should talk to user about this.

Also tsx is a great solution and no problem will be caused by this.
And type stripping in new Node.js versions will be fine!

rtritto marked this pull request as draft September 28, 2024 22:14

rtritto marked this pull request as ready for review September 29, 2024 04:26

rtritto mentioned this pull request Oct 2, 2024

[Node.js] Dynamic import of routes in Windows #24

Closed

rtritto force-pushed the node-support branch from e2a9c65 to 9347494 Compare October 9, 2024 15:50

rtritto force-pushed the node-support branch from 9347494 to 9746bc2 Compare October 10, 2024 23:57

rtritto force-pushed the node-support branch from 8fc284d to 1e1caee Compare October 11, 2024 15:34

rtritto mentioned this pull request Oct 13, 2024

fix(#24): ERR_UNSUPPORTED_ESM_URL_SCHEME on Windows (Node.js) #30

Closed

2 tasks

rtritto marked this pull request as draft October 13, 2024 21:07

rtritto mentioned this pull request Oct 14, 2024

fix(#24): ERR_UNSUPPORTED_ESM_URL_SCHEME on Windows (Node.js) #32

Closed

rtritto added 4 commits October 14, 2024 15:17

feat: add NodeJS version

ca848b2

feat: improve Node code

51a23f1

feat: improve Node/bun check

29393f8

feat: refactor glob params

e4c4129

rtritto added 2 commits October 14, 2024 15:17

lint: remove unused await because it's for-of and not for-await-of

4c312da

chore: add Node 22 as minor version

e3da0d4

rtritto force-pushed the node-support branch from 1e1caee to e3da0d4 Compare October 14, 2024 13:18

rtritto added 2 commits October 14, 2024 17:35

feat: add transpile ts and tsx files with Node.js

fa911af

Lint

0a60371

rtritto added 2 commits October 27, 2024 11:05

Merge branch 'main' of https://github.com/rtritto/elysia-autoload int…

208a079

…o node-support

Lint

7a9a9e5

rtritto marked this pull request as ready for review October 27, 2024 10:08

feat: remove esbuild

f96b0a8

rtritto marked this pull request as draft December 3, 2024 13:03

kravetsone marked this pull request as ready for review December 28, 2024 21:11

kravetsone merged commit f96b0a8 into kravetsone:main Dec 28, 2024

rtritto deleted the node-support branch January 14, 2025 00:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add NodeJS version #23

feat: add NodeJS version #23

rtritto commented Sep 28, 2024 •

edited

Loading

kravetsone commented Sep 29, 2024

kravetsone commented Sep 29, 2024

rtritto commented Sep 29, 2024

rtritto commented Sep 29, 2024 •

edited

Loading

rtritto commented Sep 29, 2024

kravetsone commented Oct 1, 2024

kravetsone commented Oct 1, 2024

rtritto commented Oct 2, 2024 •

edited

Loading

rtritto commented Oct 2, 2024 •

edited

Loading

rtritto commented Oct 2, 2024

rtritto commented Oct 9, 2024 •

edited

Loading

rtritto commented Oct 10, 2024

kravetsone commented Oct 10, 2024

rtritto commented Oct 10, 2024

kravetsone commented Oct 10, 2024

kravetsone commented Oct 10, 2024

rtritto commented Oct 10, 2024

kravetsone commented Oct 25, 2024

kravetsone commented Oct 25, 2024

kravetsone commented Oct 25, 2024

rtritto commented Oct 27, 2024 •

edited

Loading

kravetsone commented Oct 27, 2024

rtritto commented Oct 27, 2024 •

edited

Loading

kravetsone commented Oct 28, 2024

rtritto commented Oct 28, 2024

kravetsone commented Oct 28, 2024 •

edited

Loading

rtritto commented Oct 29, 2024 •

edited

Loading

rtritto commented Dec 3, 2024

rtritto commented Dec 3, 2024

kravetsone commented Dec 28, 2024

feat: add NodeJS version #23

feat: add NodeJS version #23

Conversation

rtritto commented Sep 28, 2024 • edited Loading

Differences

Notes:

TODO

kravetsone commented Sep 29, 2024

kravetsone commented Sep 29, 2024

rtritto commented Sep 29, 2024

rtritto commented Sep 29, 2024 • edited Loading

rtritto commented Sep 29, 2024

kravetsone commented Oct 1, 2024

kravetsone commented Oct 1, 2024

rtritto commented Oct 2, 2024 • edited Loading

rtritto commented Oct 2, 2024 • edited Loading

rtritto commented Oct 2, 2024

rtritto commented Oct 9, 2024 • edited Loading

rtritto commented Oct 10, 2024

kravetsone commented Oct 10, 2024

rtritto commented Oct 10, 2024

kravetsone commented Oct 10, 2024

kravetsone commented Oct 10, 2024

rtritto commented Oct 10, 2024

kravetsone commented Oct 25, 2024

kravetsone commented Oct 25, 2024

kravetsone commented Oct 25, 2024

rtritto commented Oct 27, 2024 • edited Loading

kravetsone commented Oct 27, 2024

rtritto commented Oct 27, 2024 • edited Loading

kravetsone commented Oct 28, 2024

rtritto commented Oct 28, 2024

kravetsone commented Oct 28, 2024 • edited Loading

rtritto commented Oct 29, 2024 • edited Loading

rtritto commented Dec 3, 2024

rtritto commented Dec 3, 2024

kravetsone commented Dec 28, 2024

rtritto commented Sep 28, 2024 •

edited

Loading

rtritto commented Sep 29, 2024 •

edited

Loading

rtritto commented Oct 2, 2024 •

edited

Loading

rtritto commented Oct 2, 2024 •

edited

Loading

rtritto commented Oct 9, 2024 •

edited

Loading

rtritto commented Oct 27, 2024 •

edited

Loading

rtritto commented Oct 27, 2024 •

edited

Loading

kravetsone commented Oct 28, 2024 •

edited

Loading

rtritto commented Oct 29, 2024 •

edited

Loading