Get the compilation name in the web-worker target

[tmkx]

I want to implement a custom HMR client for a Chrome extension background script that self-reloads when there is an update. I need some env configs like RSBUILD_COMPILATION_NAME, RSBUILD_CLIENT_CONFIG, and RSBUILD_RESOLVED_CLIENT_CONFIG to establish the connection. However, these variables do not exist when the target is web-worker.

I wonder if we can export the getCompilationId method to maintain the same behavior. Do you have any other suggestions? Thank you!

[chenjiahan]

For RSBUILD_CLIENT_CONFIG, you can create a Rsbuild plugin to get the client config and define it:

import { defineConfig, RsbuildPlugin } from "@rsbuild/core";

const envPlugin: RsbuildPlugin = {
  name: "env-plugin",
  setup(api) {
    api.modifyRspackConfig((config, { rspack, environment }) => {
      const { client } = environment.config.dev;
      config.plugins.push(
        new rspack.DefinePlugin({
          RSBUILD_CLIENT_CONFIG: JSON.stringify(client),
        })
      );
    });
  },
};

export default defineConfig({
  output: {
    target: "web-worker",
  },
  plugins: [envPlugin],
});

For RSBUILD_COMPILATION_NAME, I'm not sure if you need it when developing VS Code extensions, maybe you can ignore this parameter for now. Exporting getCompilationId from @rsbuild/core doesn't seem to be a good way because it is an internal helper.

[tmkx]

thanks for your reply! I'm using the environment API to build both the web and web-worker simultaneously. therefore, RSBUILD_COMPILATION_NAME is necessary to determine if the change comes from the same compiler.

[chenjiahan]

Get 👌 I would consider how to expose a unique id for socket communication

[chenjiahan]

In Rsbuild 1.4.4, I have replaced the compilationId variable with a new public webSocketToken variable. Would you like to try it out?