feat: prune orphaned Node.js versions after install, fixes #7325 #7326

lozcalver · 2025-05-22T09:16:05Z

The Issue

Prune orphaned node versions when node is updated #7325

How This PR Solves The Issue

Runs the n prune command

Manual Testing Instructions

Open the ddev-global-cache volume and look at a long-standing project’s directory: n_prefix/<project-name>/n/versions/node/. It’ll likely already contain multiple Node.js versions.

After this change, the next time you start DDEV only the most recent Node.js version should be present

Automated Testing Overview

I’m not really sure how you’d test this, but given that this is a non-essential enhancement (everything’s running fine without this change, it just saves some disk space) I don’t think additional testing is necessary

Release/Deployment Notes

N/A

lozcalver · 2025-05-22T09:19:00Z

containers/ddev-webserver/ddev-webserver-base-files/usr/local/bin/n-install.sh

@@ -47,6 +47,9 @@ if [ "${n_install_result}" = "false" ]; then
  rm -f "${N_PREFIX}" && exit 6
 fi

+# prune orphaned Node.js versions
+log-stderr.sh n prune || true


I wasn’t sure if including log-stderr.sh here was worth it given that this command isn’t really essential. Happy to remove it.

It's fine to use log-stderr.sh here.

stasadev

Thank you!

I'm pushing a new Docker image now.

Important: test starting/stopping the project, then disable Internet and start the project again. It should work as before.

stasadev · 2025-05-22T09:28:18Z

containers/ddev-webserver/ddev-webserver-base-files/usr/local/bin/n-install.sh

@@ -47,6 +47,9 @@ if [ "${n_install_result}" = "false" ]; then
  rm -f "${N_PREFIX}" && exit 6
 fi

+# prune orphaned Node.js versions
+log-stderr.sh n prune || true


It's fine to use log-stderr.sh here.

stasadev · 2025-05-22T09:38:52Z

A new Docker image is ready, build artifacts will appear shortly below.

github-actions · 2025-05-22T09:42:46Z

Download the artifacts for this pull request:

See Testing a PR.

lozcalver · 2025-05-22T10:16:48Z

Hmm, it’s not working properly - it removes all the versions. Node still “works” but when restarting without an internet connection it fails over to Node 22 (presumably whatever is installed with the image by default).

I think this may be because the prune command needs to be moved after the symlinks are added here:

ddev/containers/ddev-webserver/ddev-webserver-base-files/usr/local/bin/n-install.sh

Lines 50 to 57 in 2842925

    
           # create symlinks on success 
        
           for node_binary in "${N_PREFIX}/bin/"*; do 
        
             if [ -f "${node_binary}" ]; then 
        
               ln -sf "${node_binary}" "${system_node_dir}" 
        
             fi 
        
           done 
        
           ln -sf "${system_node_dir}/node" "${system_node_dir}/nodejs"

n’s prune command will detect the current “active” node version before it runs, and it does so like this:

https://github.com/tj/n/blob/f52d2172f12cd76f0efe9524690723f52ab74f40/bin/n#L477-L494

I’ve pushed a commit that moves the command. If that works I can squash the commits + force push if you’d like, not sure if you’d prefer that done upfront or if you’ll squash + merge

stasadev · 2025-05-22T10:20:57Z

I’ve pushed a commit that moves the command. If that works I can squash the commits + force push if you’d like, not sure if you’d prefer that done upfront or if you’ll squash + merge

We always squash on merge, no need to do it here.

Pushing a new image.

stasadev · 2025-05-22T10:34:53Z

The new Docker image is ready.

Before testing run:

ddev poweroff
docker pull ddev/ddev-webserver:20250522_lozcalver_n_prune

lozcalver · 2025-05-22T10:40:42Z

Great, it’s working now. With a Node 18 project, only 18.20.8 remains after starting DDEV. Tested disabling my internet connection before starting, that works too:

stasadev · 2025-05-22T10:43:06Z

Great!

I'll test it later today as well.

(Ignore the "Container tests" failure: it's unrelated to this PR.)

stasadev · 2025-05-22T15:39:51Z

Rebased to fix tests.

stasadev

Thank you!

There might be cases where someone wants to install multiple Node versions, but they can work around it by using a different N_PREFIX.

The logic behaves as expected:

$ ddev config --nodejs-version="14.1.0"
$ ddev start

$ ddev exec node -v
v14.1.0

$ ddev exec "n install 14 && n install 16 && n install 18"

$ ddev exec n ls
node/14.1.0
node/14.21.3
node/16.20.2
node/18.20.8

$ ddev config --nodejs-version="14"
$ ddev restart

$ ddev exec node -v
v14.21.3

# only one version as expected
$ ddev exec n ls
node/14.21.3

$ ddev exec "n install 14.21.2 && n install 14.21.1 && n install 14.21.0"

$ ddev exec n ls
node/14.21.0
node/14.21.1
node/14.21.2
node/14.21.3

$ ddev poweroff

# turn off the Internet

$ ddev start

$ ddev exec node -v
v14.21.3

# only one version as expected
$ ddev exec n ls
node/14.21.3

$ ddev restart

$ ddev exec node -v
v14.21.3

# only one version as expected
$ ddev exec n ls
node/14.21.3

lozcalver requested a review from a team as a code owner May 22, 2025 09:16

github-actions bot added the enhancement label May 22, 2025

lozcalver commented May 22, 2025

View reviewed changes

stasadev reviewed May 22, 2025

View reviewed changes

github-actions bot added the dependencies Pull requests that update a dependency file label May 22, 2025

stasadev self-requested a review May 22, 2025 13:38

lozcalver and others added 3 commits May 22, 2025 18:39

feat: prune orphaned Node.js versions after install, fixes ddev#7325

768732e

build: push docker image

3c9d774

Move prune command after symlinks have been added

02c6ff9

stasadev force-pushed the prune-node-versions branch from 0480dbd to 02c6ff9 Compare May 22, 2025 15:39

stasadev approved these changes May 22, 2025

View reviewed changes

stasadev merged commit 570918f into ddev:main May 29, 2025
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: prune orphaned Node.js versions after install, fixes #7325 #7326

feat: prune orphaned Node.js versions after install, fixes #7325 #7326

Uh oh!

lozcalver commented May 22, 2025

Uh oh!

lozcalver May 22, 2025

Uh oh!

stasadev May 22, 2025

Uh oh!

stasadev left a comment

Uh oh!

stasadev May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

github-actions bot commented May 22, 2025 •

edited

Loading

Uh oh!

lozcalver commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

lozcalver commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: prune orphaned Node.js versions after install, fixes #7325 #7326

feat: prune orphaned Node.js versions after install, fixes #7325 #7326

Uh oh!

Conversation

lozcalver commented May 22, 2025

The Issue

How This PR Solves The Issue

Manual Testing Instructions

Automated Testing Overview

Release/Deployment Notes

Uh oh!

lozcalver May 22, 2025

Choose a reason for hiding this comment

Uh oh!

stasadev May 22, 2025

Choose a reason for hiding this comment

Uh oh!

stasadev left a comment

Choose a reason for hiding this comment

Uh oh!

stasadev May 22, 2025

Choose a reason for hiding this comment

Uh oh!

stasadev commented May 22, 2025

Uh oh!

github-actions bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lozcalver commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

lozcalver commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev commented May 22, 2025

Uh oh!

stasadev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented May 22, 2025 •

edited

Loading