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

[ReadMe] Update NodeJS Version in Readme #292

Open
DrKittens opened this issue May 1, 2023 · 4 comments
Open

[ReadMe] Update NodeJS Version in Readme #292

DrKittens opened this issue May 1, 2023 · 4 comments
Labels
core bug Bug related to the core SquadJS API

Comments

@DrKittens
Copy link
Contributor

Description of Issue

SquadJS's readme lists NodeJS v14 as a prerequisite, this information is problematic as NodeJS 14's End of Life is today so the inherit recommendation of Node v14 is problematic to end users.

I believe this should be updated to either not describe an explicit version or mention the current LTS release (currently node 18)

Errors or Screenshots of Issue

https://endoflife.date/nodejs

Squad Information

  • SquadJS Version: 3.7.0
  • Squad Version: N/A

If potentially relevant, please provide regarding the state of the Squad server at the time of error, e.g. the current layer.

System Information

  • Operating System: Almalinux 9
  • NodeJS Version: 18.12.1 (el9)
  • Yarn Version: 1.22.19
@DrKittens DrKittens added the core bug Bug related to the core SquadJS API label May 1, 2023
@Thomas-Smyth
Copy link
Collaborator

The current suggestion was made based on the compatibility of sqlite3 at the time. Research should be conducted to find what versions are required by sqlite3, if any.

@reck1610
Copy link
Contributor

sqlite3 version 5.0.0 was compatible with NodeJS 11, 12, 13 and 14 as stated here: https://www.npmjs.com/package/sqlite3/v/5.0.0

The current version is 5.1.6 which can be found here: https://www.npmjs.com/package/sqlite3/v/5.1.6

The compatibility statement for NodeJS 11, 12, 13 and 14 has been removed. The only mention of specific NodeJS versions is the one below.

sqlite3 v5+ was rewritten to use Node-API so prebuilt binaries do not need to be built for specific Node versions. sqlite3 currently builds for both Node-API v3 and v6. Check the Node-API version matrix to ensure your Node version supports one of these. The prebuilt binaries should be supported on Node v10+.

I have been running SquadJS with NodeJS v18.16.0 since I had to upgrade 2 months ago. I have a sqlite database configured and everything worked so far.

@DrKittens
Copy link
Contributor Author

DrKittens commented Jun 22, 2023

Going by the info provided above about why the version is recommended:

The NPM info for sqlitev5.1.6 below:

https://www.npmjs.com/package/sqlite3/v/5.1.6

Notes that Node-API v3 is supported.

The Node-API version matrix below

https://nodejs.dev/en/api/v18/n-api/#node-api-version-matrix

Notes that v3 is supported by all releases >v10

I believe it is safe to remove that version specific readme warning and recommend the latest Node LTS be deployed until either node-api deprecates v3.0 from a future release or nodejs sqlite drops support for api v3

@naxhh
Copy link

naxhh commented Apr 28, 2024

as of today, you can't run the project with node 14. some of the dependencies are requiring 16 or above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core bug Bug related to the core SquadJS API
Projects
None yet
Development

No branches or pull requests

4 participants