Client version in new release marked as beta in NPM registry

[jannis-adamek-dt]

Description

Hello,
First of all, thank you for all the hard work and dedication you've put into maintaining Node-Redis!

I noticed that the redis client incorrectly reports its version as 5.9.0-beta.3 in the new release 5.9.0.
I'm wondering if there might have been a mistake with the deployment or a caching issue.

# In a fresh Node.js project
npm install node-redis@5.9.0
grep "version"  node_modules/@redis/client/dist/package.json # "version": "5.9.0-beta.3",

In the parent package-lock.json:

"node_modules/@redis/client": {
  "version": "5.9.0",
  "resolved": "https://registry.npmjs.org/@redis/client/-/client-5.9.0.tgz",
  "integrity": "sha512-EI0Ti5pojD2p7TmcS7RRa+AJVahdQvP/urpcSbK/K9Rlk6+dwMJTQ354pCNGCwfke8x4yKr5+iH85wcERSkwLQ==",
  "license": "MIT",
  "dependencies": {
    "cluster-key-slot": "1.1.2"
  },
  "engines": {
    "node": ">= 18"
  }
},

It claims that the client is on version 5.9.0, but when I actually download the package from the registry:

wget https://registry.npmjs.org/@redis/client/-/client-5.9.0.tgz
mkdir client-5.9.0
tar -xzvf client-5.9.0.tgz -C client-5.9.0
grep "version" client-5.9.0/package.json # "version": "5.9.0",
# but inside the dist/
grep "version" client-5.9.0/dist/package.json # "version": "5.9.0-beta

I could guess that this may be due to caching if 5.9.0-beta.3 and 5.9.0 share the same content.

Best,
Jannis

Node.js Version

v22.20.0

Redis Server Version

No response

Node Redis Version

5.9.0

Platform

Linux

Logs

[nkaradzhov]

Hi @jannis-adamek-dt, thanks for flagging this issue! On first glance it indeed looks like a caching issue, although i canno explain how could it happen tbh. I will take further look into this.

[zingazzi]

Hi @nkaradzhov ,

seems the issue is related to build process.

1. The build process (npm run build) runs before the version bump
2. This creates the dist/package.json with the beta version (5.9.0-beta.3)
3. Then release-it updates the source package.json to the final version (5.9.0)
4. But the dist/package.json is never updated, so it still contains the beta version

The release workflow needs to rebuild the packages after the version bump but before publishing to npm.
release.yml

     # Build all packages
      - name: Build packages
        run: npm run build

      # Release using the monorepo approach
      - name: Release packages
        run: npm run release -- --ci -i ${{ github.event.inputs.version }} ${{ github.event.inputs.args }}
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

at the end should be added something like:

     # Rebuild packages after version bump to ensure dist/package.json is updated
     - name: Rebuild packages after version bump
        run: npm run build

[zingazzi]

#3120

This is the pull request

[jannis-adamek-dt]

Hi @zingazzi, thank you for this analysis!

2. This creates the dist/package.json with the beta version (5.9.0-beta.3)

I'm wondering if the dist even needs a package.json if it is already contained one layer above?

Would it make sense to change the order into version-bump -> build?

I also commented this on the PR but isn't it already too late after npm run release because I assume then it is uploaded to the NPM registry?

[zingazzi]

@jannis-adamek-dt I'm checking the timing.
I wondering the right solution can be add an hook.

"before:release": "npm run build"

the before:release hook should runs during the npm run release so:

1 npm run release starts
2 Version gets bumped in package.json
3 before:release hook runs (rebuilds with correct version)
4 Git operations (commit, tag)
5 npm publish happens
6 npm run release completes
7 So the rebuild happens before the npm publish, not after.

If I well understand the documentation .... :)