Remove @semantic-release/exec, adjust how next version is acquired

Author: arnautov-anton

.releaserc.json

@@ -71,12 +71,6 @@
         }
       }
     ],
-    [
-      "@semantic-release/exec",
-      {
-        "prepareCmd": "NEXT_VERSION=${nextRelease.version} npm run build"
-      }
-    ],
     [
       "@semantic-release/changelog",
       {

package.json

@@ -185,7 +185,6 @@
     "@ladle/react": "^0.16.0",
     "@playwright/test": "^1.42.1",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/exec": "^7.0.3",
     "@semantic-release/git": "^10.0.1",
     "@stream-io/stream-chat-css": "^5.7.2",
     "@testing-library/dom": "^10.4.0",
@@ -220,7 +219,6 @@
     "dotenv": "^8.6.0",
     "emoji-mart": "^5.5.2",
     "esbuild": "^0.23.1",
-    "esbuild-plugin-replace": "^1.4.0",
     "eslint": "^9.16.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28.11.0",
@@ -271,7 +269,8 @@
     "e2e-fixtures": "node e2e/fixtures/fixtures.mjs",
     "e2e-container": "./e2e/scripts/run_in_container.sh",
     "docs:copy-css-docs": "scripts/merge-stream-chat-css-docs.sh node_modules/@stream-io/stream-chat-css/docs",
-    "docs:run": "yarn docs:copy-css-docs && stream-chat-docusaurus -s"
+    "docs:run": "yarn docs:copy-css-docs && stream-chat-docusaurus -s",
+    "prepack": "yarn build"
   },
   "resolutions": {
     "ast-types": "^0.14.0",

scripts/bundle-cjs.mjs

@@ -3,8 +3,7 @@
 import { dirname, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import * as esbuild from 'esbuild';
-import { replace } from 'esbuild-plugin-replace';
-import getPackageVersion from './getPackageVersion.mjs';
+import getPackageVersion from './get-package-version.mjs';
 import packageJson from '../package.json' with { type: 'json' };
 
 // import.meta.dirname is not available before Node 20
@@ -34,7 +33,12 @@ const external = deps.filter((dep) => !bundledDeps.includes(dep));
 
 /** @type esbuild.BuildOptions */
 const cjsBundleConfig = {
-  entryPoints: [sdkEntrypoint, emojiEntrypoint, mp3EncoderEntrypoint, experimentalEntrypoint],
+  entryPoints: [
+    sdkEntrypoint,
+    emojiEntrypoint,
+    mp3EncoderEntrypoint,
+    experimentalEntrypoint,
+  ],
   bundle: true,
   format: 'cjs',
   target: 'es2020',
@@ -52,11 +56,9 @@ const bundles = ['browser', 'node'].map((platform) =>
     ...cjsBundleConfig,
     entryNames: `[dir]/[name].${platform}`,
     platform,
-    plugins: [
-      replace({
-        __STREAM_CHAT_REACT_VERSION__: getPackageVersion(),
-      }),
-    ],
+    define: {
+      'process.env.STREAM_CHAT_REACT_VERSION': JSON.stringify(getPackageVersion()),
+    },
   }),
 );
 await Promise.all(bundles);

scripts/bundle-esm.mjs

@@ -4,29 +4,32 @@ import { exec } from 'node:child_process';
 import { readFile, writeFile } from 'node:fs/promises';
 import glob from 'glob';
 import { promisify } from 'node:util';
-import getPackageVersion from "./getPackageVersion.mjs";
+import getPackageVersion from './get-package-version.mjs';
 
 const execAsync = promisify(exec);
 
 const version = getPackageVersion();
 
 const bundleEsm = async () => {
-    // Run TypeScript compiler
-    console.log('Running TypeScript compiler...');
-    await execAsync('tsc');
+  // Run TypeScript compiler
+  console.log('Running TypeScript compiler...');
+  await execAsync('tsc');
 
-    // Replace version string in generated files
-    console.log('Replacing version strings...');
-    const files = glob.glob.sync('dist/**/*.js');
-    await Promise.all(
-        files.map(async (file) => {
-            const content = await readFile(file, 'utf8');
-            const newContent = content.replace(/__STREAM_CHAT_REACT_VERSION__/g, version);
-            await writeFile(file, newContent);
-        })
-    );
+  // Replace version string in generated files
+  console.log('Replacing version strings...');
+  const files = glob.glob.sync('dist/**/*.js');
+  await Promise.all(
+    files.map(async (file) => {
+      const content = await readFile(file, 'utf8');
+      const newContent = content.replace(
+        /process.env.STREAM_CHAT_REACT_VERSION/g,
+        JSON.stringify(version),
+      );
+      await writeFile(file, newContent);
+    }),
+  );
 
-    console.log('ESM build complete');
+  console.log('ESM build complete');
 };
 
-bundleEsm().catch(console.error);
+bundleEsm().catch(console.error);

scripts/get-package-version.mjs

@@ -0,0 +1,25 @@
+import { execSync } from 'node:child_process';
+import packageJson from '../package.json' with { type: 'json' };
+
+// get the latest version so that "__STREAM_CHAT_REACT_VERSION__" can be replaced with it in the source code (used for reporting purposes), see bundle-cjs.mjs/bundle-esm.mjs for source
+export default function getPackageVersion() {
+  // "build" script ("prepack" hook) gets invoked when semantic-release runs "npm publish", at that point package.json#version already contains updated next version which we can use
+  let version = packageJson.version;
+
+  // if it fails (loads a default), try pulling version from git
+  if (version === '0.0.0-development') {
+    try {
+      version = execSync('git describe --tags --abbrev=0').toString().trim();
+    } catch (error) {
+      console.error(error);
+      console.warn(
+        'Could not get latest version from git tags, falling back to package.json',
+      );
+      version = packageJson.version;
+    }
+  }
+
+  console.log(`Determined the build package version to be ${version}`);
+
+  return version;
+}

scripts/getPackageVersion.mjs

@@ -66,11 +66,13 @@ export const useChat = <
   useEffect(() => {
     if (!client) return;
 
+    const version = process.env.STREAM_CHAT_REACT_VERSION;
+
     const userAgent = client.getUserAgent();
     if (!userAgent.includes('stream-chat-react')) {
       // result looks like: 'stream-chat-react-2.3.2-stream-chat-javascript-client-browser-2.2.2'
       // the upper-case text between double underscores is replaced with the actual semantic version of the library
-      client.setUserAgent(`stream-chat-react-__STREAM_CHAT_REACT_VERSION__-${userAgent}`);
+      client.setUserAgent(`stream-chat-react-${version}-${userAgent}`);
     }
 
     client.threads.registerSubscriptions();

src/components/Chat/hooks/useChat.ts

@@ -2277,18 +2277,6 @@
   resolved "https://registry.yarnpkg.com/@semantic-release/error/-/error-4.0.0.tgz#692810288239637f74396976a9340fbc0aa9f6f9"
   integrity sha512-mgdxrHTLOjOddRVYIYDo0fR3/v61GNN1YGkfbrjuIKg/uMgCd+Qzo3UAXJ+woLQQpos4pl5Esuw5A7AoNlzjUQ==
 
-"@semantic-release/exec@^7.0.3":
-  version "7.0.3"
-  resolved "https://registry.yarnpkg.com/@semantic-release/exec/-/exec-7.0.3.tgz#be0b2d8e7e2bcf05076fc48914a643b939c2c151"
-  integrity sha512-uNWwPNtWi3WTcTm3fWfFQEuj8otOvwoS5m9yo2jSVHuvqdZNsOWmuL0/FqcVyZnCI32fxyYV0G7PPb/TzCH6jw==
-  dependencies:
-    "@semantic-release/error" "^4.0.0"
-    aggregate-error "^3.0.0"
-    debug "^4.0.0"
-    execa "^9.0.0"
-    lodash-es "^4.17.21"
-    parse-json "^8.0.0"
-
 "@semantic-release/git@^10.0.1":
   version "10.0.1"
   resolved "https://registry.yarnpkg.com/@semantic-release/git/-/git-10.0.1.tgz#c646e55d67fae623875bf3a06a634dd434904498"
@@ -5397,13 +5385,6 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/esbuild-openbsd-64/-/esbuild-openbsd-64-0.14.27.tgz#e99f8cdc63f1628747b63edd124d53cf7796468d"
   integrity sha512-xwSje6qIZaDHXWoPpIgvL+7fC6WeubHHv18tusLYMwL+Z6bEa4Pbfs5IWDtQdHkArtfxEkIZz77944z8MgDxGw==
 
-esbuild-plugin-replace@^1.4.0:
-  version "1.4.0"
-  resolved "https://registry.yarnpkg.com/esbuild-plugin-replace/-/esbuild-plugin-replace-1.4.0.tgz#2051eb35e21699e41dcf75630f613bdaa5039be6"
-  integrity sha512-lP3ZAyzyRa5JXoOd59lJbRKNObtK8pJ/RO7o6vdjwLi71GfbL32NR22ZuS7/cLZkr10/L1lutoLma8E4DLngYg==
-  dependencies:
-    magic-string "^0.25.7"
-
 [email protected]:
   version "0.14.27"
   resolved "https://registry.yarnpkg.com/esbuild-sunos-64/-/esbuild-sunos-64-0.14.27.tgz#8611d825bcb8239c78d57452e83253a71942f45c"
@@ -8834,13 +8815,6 @@ lz-string@^1.5.0:
   resolved "https://registry.yarnpkg.com/lz-string/-/lz-string-1.5.0.tgz#c1ab50f77887b712621201ba9fd4e3a6ed099941"
   integrity sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==
 
-magic-string@^0.25.7:
-  version "0.25.9"
-  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.25.9.tgz#de7f9faf91ef8a1c91d02c2e5314c8277dbcdd1c"
-  integrity sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==
-  dependencies:
-    sourcemap-codec "^1.4.8"
-
 make-dir@^2.0.0, make-dir@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-2.1.0.tgz#5f0310e18b8be898cc07009295a30ae41e91e6f5"
@@ -12022,11 +11996,6 @@ source-map@^0.6.0, source-map@^0.6.1, source-map@~0.6.1:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
   integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
 
-sourcemap-codec@^1.4.8:
-  version "1.4.8"
-  resolved "https://registry.yarnpkg.com/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz#ea804bd94857402e6992d05a38ef1ae35a9ab4c4"
-  integrity sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==
-
 space-separated-tokens@^2.0.0:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz#1ecd9d2350a3844572c3f4a312bceb018348859f"