Depend on a specific version of Node.js #5158

javierm · 2023-07-22T21:50:00Z

References

Depends on Upgrade Ruby to version 3.1.4 #5157

Objectives

Make sure all Consul Democracy installations compile the assets using the same version of Node.js, so we don't get inconsistent errors
Make it easier to use Node packages in the future

Documentation

We need to update the technical documentation in order to add instructions about how to install a Node Version Manager and use it to install Node.js and to reflect the fact that, due to this change, Ubuntu 18.04 is no longer supported.

Release Notes

⚠️ We now depend on a specific version on Node.js. If you use Capistrano to deploy, this version is already installed during deployment. If you use a different system to deploy, you might need to take this into account.

lib/tasks/node_manager.rake

config/deploy.rb

Senen · 2023-10-11T11:13:45Z

Hi @javierm, I've been testing deployments from this implementation (with bundle within map_node_bins) on servers built with the installer with Consul Democracy 2.0.1 and on servers with Consul Democracy with the new nodejs version:

It worked well in all cases, but I found that on the server with Consul Democracy 2.0.1, the fnm entries were not added to the deploy user .bashrc file, as you can see in the following deployment log:

03:00 install_node
      01 export PATH="$HOME/.fnm:$PATH" && cd /home/deploy/consul/releases/20231011105903 && eval "$(fnm env)" && fnm use --install-if-missing
      01 bash: fnm: command not found
      01
      01 bash: fnm: command not found
      02 export PATH="$HOME/.fnm:$PATH" && cd /home/deploy/consul/releases/20231011105903 && eval "$(fnm env)"
      02 bash: fnm: command not found
      02
    ✔ 02 [email protected] 0.005s
      03 curl -fsSL https://fnm.vercel.app/install | bash -s -- --install-dir "$HOME/.fnm" --skip-shell
      03 Checking dependencies for the installation script...
      03 Checking availability of curl...
      03 OK!
      03 Checking availability of unzip...
      03 OK!
      03 Downloading https://github.com/Schniz/fnm/releases/latest/download/fnm-linux.zip...
      03 #=#=#
      03 ##O#- #
      03 ##O=#  #
      03 #=#=-#  #
      03 -#O#- #   #
                                                                           0.3%
##                                                                         3.6%
#######                                                                   10.1%
############                                                              17.4%
#################                                                         24.6%
#######################                                                   32.7%
#############################                                             40.5%
##################################                                        48.3%
#######################################                                   54.8%
###########################################                               60.0%
##################################################                        70.2%
#######################################################                   76.9%
#############################################################             85.8%
#####################################################################     97.0%
######################################################################## 100.0%
    ✔ 03 [email protected] 2.713s
      01 Installing Node v18.18.0 (x64)
      01 Using Node v18.18.0
      01
    ✔ 01 [email protected] 8.649s

I think adding those entries to the deploy user .bashrc file is important so interactive sessions load the proper nodejs environment through fnm automatically.

javierm · 2023-10-11T20:30:52Z

I think adding those entries to the deploy user .bashrc file is important so interactive sessions load the proper nodejs environment through fnm automatically.

I agree! No idea what's going on here 🤔. Maybe next week we can share a screen and try to find out.

config/deploy.rb

Senen · 2023-10-13T16:30:55Z

Hi @javierm ,

I was wondering exactly which application dependencies need the Execjs runtime and why we need them.

We have five dependencies that use Execjs for asset precompilation purposes (except eslintrb):

autoprefixer-rails
babel-transpiler
coffee-script
eslintrb
uglifier

Quoting ExecJS docs:

ExecJS lets you run JavaScript code from Ruby. It automatically picks the best runtime available to evaluate your JavaScript program, then returns the result to you as a Ruby object.

I verified this behaviour by removing all my local NodeJS versions and checking that the runtime in my development environment changed from NodeJS to Apple JavaScriptCore, which is Included by default with MacOS.

Before migrating to a specific version of NodeJS and allowing the use of npm packages in the Rails Asset Pipeline, we used the Execjs just for assets precompilation purposes. Now, we want to load npm packages in the Rails Assets Pipeline from a particular NodeJS version. Using other NodeJS versions could lead to unexpected results.

I think now we should force the Execjs runtime environment so if developers do not have NodeJS installed, they get a very explicit error. We can do it with an initializer so any environment would fail if they do not find the runtime we want to use:

config/initializers/execjs.rb

ExecJS.runtime = ExecJS::Runtimes::Node

With this change the error is more precise:

> rails s                   
=> Booting Puma
=> Rails 6.1.7.4 application starting in development 
=> Run `bin/rails server --help` for more startup options
Exiting
/Users/sendero/.rvm/gems/ruby-3.1.4/gems/execjs-2.8.1/lib/execjs/module.rb:14:in `runtime=': Node.js (V8) is unavailable on this system (ExecJS::RuntimeUnavailable)

Another thing we can do is add the required NodeJS version in the README file and mention the need to install the package.json dependencies to precompile assets.

What do you think?

javierm · 2023-10-13T17:23:40Z

@Senen I've updated the code:

Added > /dev/null to the fnm env command so we don't constantly get its output while deploying
Run map_node_bins after git:create_release so we don't use the wrong folder when running the FNM setup command
Install node before running bundle, since bundle now depends on Node being installed 😌

Tried every scenario I could think of 🤞.

javierm · 2023-10-14T23:20:06Z

Another thing we can do is add the required NodeJS version in the README file and mention the need to install the package.json dependencies to precompile assets.

I've updated the README to add the required Node.js version 👍. Not sure about the package.json dependencies, but I guess that one belongs to pull request #5159 🤔.

javierm · 2023-10-14T23:24:56Z

I think now we should force the Execjs runtime environment so if developers do not have NodeJS installed, they get a very explicit error.

Good question 🤔.

Dockerfile

We're choosing version 18 because if offers support for SSL 3, just like Ruby 3.1 does. Note we're symlinking a .nvmrc file as well, in order to make it compatible with NVM. While the .nvmrc and .node-version files use different formats, they both support the syntax we're using to define the version. The code to install Node.js in the Dockerfile is a simplification of the code in the Rails Dockerfile template [1]. [1] https://github.com/rails/rails/blob/04c97aec8a/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt#L25

We use FNM instead of NVM. Reason: the setup seems easier with just `eval "$(fnm env)"`. So now, we try to install Node.js; if the command fails, it could be because FNM isn't installed (and we need to install it) or because the version of Node.js cannot be installed with the current version of FNM (and we need to update FNM). After installing/updating FNM, we try to install Node.js again. Note we're using `fnm env` in the middle of the `fnm_setup_command`. That way, the command will raise a `SSHKit::Command::Failed` exception if `fnm` isn't installed, and it will give us an indicator that we need to actually install it.

This code is based on what the rvm1-capistrano and capistrano-nvm gems do, but simplified a bit to take advantage of the `fnm exec` command. Since ExecJS will check for a JavaScript runtime every time the application is started, we need to include commands like `bundle` (used when running `bin/delayed_job`), `puma` and `rake`, so Node.js is found when running these commands. I'm not sure whether `pumactl` is also necessary, but I've added it for consistency. We're also including the default commands gems like capistrano-nvm use because we will add the `npm` command in the near future. Note that, in order to setup FNM, we need to enter the actual release folder (using `within release_path` isn't enough). So we have to run this task after the actual release is created; otherwise many commands would run in the previous release's folder.

Senen

Hi @javierm,

As we talked about, if we finally decide to set the Execjs runtime to NodeJS, we'll do it in a separate PR.

javierm · 2023-10-18T12:53:14Z

@Senen We finally made it! 🎉

javierm added the Maintenance label Jul 22, 2023

javierm self-assigned this Jul 22, 2023

javierm marked this pull request as draft July 22, 2023 21:50

javierm added this to Reviewing in Consul Democracy Jul 22, 2023

github-actions bot reviewed Jul 22, 2023

View reviewed changes

lib/tasks/node_manager.rake Outdated Show resolved Hide resolved

javierm mentioned this pull request Jul 22, 2023

Allow adding Node packages as dependencies #5159

Merged

javierm moved this from Reviewing to Doing in Consul Democracy Jul 22, 2023

javierm force-pushed the node_version branch 6 times, most recently from e560213 to 138d15c Compare July 23, 2023 02:19

javierm force-pushed the node_version branch 2 times, most recently from 53b511e to 8ba0db0 Compare August 6, 2023 20:57

javierm force-pushed the ruby3.1 branch from 403a1b1 to 56344e5 Compare August 7, 2023 11:39

javierm force-pushed the node_version branch from 8ba0db0 to dec4b9c Compare August 7, 2023 11:40

javierm mentioned this pull request Aug 30, 2023

Bump autoprefixer-rails from 8.2.0 to 10.4.13.0 #5193

Closed

javierm force-pushed the ruby3.1 branch 4 times, most recently from 3fad249 to 35884f9 Compare September 6, 2023 11:47

javierm force-pushed the node_version branch from dec4b9c to ed70d57 Compare September 6, 2023 12:18

javierm mentioned this pull request Sep 7, 2023

Bump autoprefixer-rails from 8.2.0 to 10.4.15.0 #5237

Closed

javierm force-pushed the ruby3.1 branch from 35884f9 to e19bb6e Compare September 7, 2023 19:53

javierm force-pushed the node_version branch from ed70d57 to aba056d Compare September 7, 2023 20:01

javierm marked this pull request as ready for review September 7, 2023 20:01

javierm moved this from Doing to Reviewing in Consul Democracy Sep 7, 2023

javierm force-pushed the ruby3.1 branch from f832b0a to b42b96a Compare September 11, 2023 21:41

javierm force-pushed the node_version branch from aba056d to b252ae1 Compare September 11, 2023 21:42

Senen reviewed Oct 10, 2023

View reviewed changes

config/deploy.rb Show resolved Hide resolved

javierm force-pushed the node_version branch 2 times, most recently from f15474a to d6eb6ce Compare October 11, 2023 21:07

Senen mentioned this pull request Oct 13, 2023

Install specific nodejs version consuldemocracy/installer#223

Merged

Senen reviewed Oct 13, 2023

View reviewed changes

config/deploy.rb Show resolved Hide resolved

javierm force-pushed the node_version branch from d6eb6ce to 3518870 Compare October 13, 2023 16:29

javierm force-pushed the node_version branch from 3518870 to cec9b5c Compare October 13, 2023 17:20

javierm force-pushed the node_version branch from cec9b5c to 986f276 Compare October 14, 2023 23:17

javierm added the Documentation label Oct 15, 2023

Senen reviewed Oct 16, 2023

View reviewed changes

Dockerfile Show resolved Hide resolved

javierm force-pushed the node_version branch from 986f276 to 1c4588e Compare October 17, 2023 11:11

javierm added 3 commits October 17, 2023 13:11

javierm force-pushed the node_version branch from 1c4588e to f209325 Compare October 17, 2023 11:12

Consul Democracy automation moved this from Reviewing to Testing Oct 18, 2023

Senen approved these changes Oct 18, 2023

View reviewed changes

javierm merged commit 55efcbc into master Oct 18, 2023
13 checks passed

Consul Democracy automation moved this from Testing to Release 2.1.0 Oct 18, 2023

javierm deleted the node_version branch October 18, 2023 12:52

javierm removed the 2.1 label Oct 18, 2023

Senen mentioned this pull request Oct 24, 2023

Map node binaries whenever rvm1:hook is called and evaluate the fnm_setup_command dynamically #5303

Merged

javierm added the Release notes label Feb 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Depend on a specific version of Node.js #5158

Depend on a specific version of Node.js #5158

javierm commented Jul 22, 2023 •

edited

Senen commented Oct 11, 2023 •

edited

javierm commented Oct 11, 2023

Senen commented Oct 13, 2023 •

edited

javierm commented Oct 13, 2023 •

edited

javierm commented Oct 14, 2023

javierm commented Oct 14, 2023

Senen left a comment

javierm commented Oct 18, 2023

Depend on a specific version of Node.js #5158

Depend on a specific version of Node.js #5158

Conversation

javierm commented Jul 22, 2023 • edited

References

Objectives

Documentation

Release Notes

Senen commented Oct 11, 2023 • edited

javierm commented Oct 11, 2023

Senen commented Oct 13, 2023 • edited

javierm commented Oct 13, 2023 • edited

javierm commented Oct 14, 2023

javierm commented Oct 14, 2023

Senen left a comment

Choose a reason for hiding this comment

javierm commented Oct 18, 2023

javierm commented Jul 22, 2023 •

edited

Senen commented Oct 11, 2023 •

edited

Senen commented Oct 13, 2023 •

edited

javierm commented Oct 13, 2023 •

edited