fix: rsbuild environments problem. (#795)

Author: easy1090

e2e/cases/doctor-rsbuild/fixtures/a.js

@@ -0,0 +1 @@
+console.log('a');

e2e/cases/doctor-rsbuild/fixtures/b.js

@@ -0,0 +1,10 @@
+const ll = 1;
+
+console.log('a');
+
+function kk() {
+  console.log('hhe: ', ll);
+  return '111';
+}
+
+kk();

e2e/cases/doctor-rsbuild/fixtures/loaders/comment.js

@@ -0,0 +1,39 @@
+/**
+ * @template {{
+ *   mode: 'async' | 'callback' | 'sync';
+ *   pitchResult?: string;
+ * }} Options
+ */
+
+/**
+ * @type {import("webpack").LoaderDefinitionFunction<Options, {}>}
+ */
+module.exports = function (input) {
+  /**
+   * @type Options
+   */
+  const options = this.getOptions();
+  const res = [input, '// hello world'].join('\n');
+
+  if (options.mode === 'async') {
+    const cb = this.async();
+    setTimeout(() => {
+      cb(null, res);
+    }, 3000);
+  } else if (options.mode === 'callback') {
+    this.callback(null, res);
+  } else {
+    return res;
+  }
+};
+
+module.exports.pitch = function () {
+  /**
+   * @type Options
+   */
+  const options = this.getOptions();
+
+  if (options.pitchResult) {
+    return options.pitchResult;
+  }
+};

e2e/cases/doctor-rsbuild/fixtures/loaders/serialize-query-to-comment.js

@@ -0,0 +1,16 @@
+const { parseQuery } = require('loader-utils');
+
+/**
+ * @type {import("webpack").LoaderDefinitionFunction<{}, {}>}
+ */
+module.exports = function (input) {
+  const res = [input, `// ${JSON.stringify(this.query)}`];
+
+  // Based on https://github.com/windicss/windicss-webpack-plugin/blob/main/src/loaders/windicss-template.ts#L42
+  // test the loader query
+  if (this.query !== '') {
+    res.push(`// ${JSON.stringify(parseQuery(this.query))}`);
+  }
+
+  return res.join('\n');
+};

e2e/cases/doctor-rsbuild/fixtures/loaders/serialize-resource-query-to-comment.js

@@ -0,0 +1,16 @@
+const { parseQuery } = require('loader-utils');
+
+/**
+ * @type {import("webpack").LoaderDefinitionFunction<{}, {}>}
+ */
+module.exports = function (input) {
+  const res = [input, `// ${JSON.stringify(this.resourceQuery)}`];
+
+  // Based on https://github.com/windicss/windicss-webpack-plugin/blob/main/src/loaders/windicss-template.ts#L42
+  // test the loader query
+  if (this.resourceQuery !== '') {
+    res.push(`// ${JSON.stringify(parseQuery(this.resourceQuery))}`);
+  }
+
+  return res.join('\n');
+};

e2e/cases/doctor-rsbuild/fixtures/port.js

@@ -0,0 +1,7 @@
+const { RsdoctorWebpackPlugin } = require('../../dist/index');
+
+const plugin = new RsdoctorWebpackPlugin({});
+
+plugin.sdk.bootstrap().then(() => {
+  console.log(plugin.sdk.server.port);
+});

e2e/cases/doctor-rsbuild/loaders/loader.test.ts

@@ -0,0 +1,53 @@
+import { expect, test } from '@playwright/test';
+import { getSDK } from '@rsdoctor/core/plugins';
+import { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';
+import { createStubRsbuild } from '@scripts/test-helper';
+import path from 'path';
+
+const file = path.resolve(__dirname, '../fixtures/a.js');
+
+async function rsbuild(_query?: string) {
+  const res = await createStubRsbuild({
+    rsbuildConfig: {
+      source: {
+        entry: {
+          index: path.join(__dirname, '../fixtures/a.js'),
+        },
+      },
+      environments: {
+        web: {},
+        web1: {},
+      },
+      tools: {
+        rspack(config: any, { appendPlugins, environment }: any) {
+          if (environment.name === 'node') {
+            appendPlugins(
+              new RsdoctorRspackPlugin({
+                disableClientServer: true,
+                output: {
+                  reportDir: path.join(__dirname, './doc_build/node/'),
+                },
+              }),
+            );
+          } else {
+            appendPlugins(
+              new RsdoctorRspackPlugin({
+                disableClientServer: true,
+              }),
+            );
+          }
+        },
+      },
+    },
+  });
+  return res;
+}
+
+test('rsbuild environments tests', async () => {
+  const rsdbuildInstance = await rsbuild();
+  await rsdbuildInstance.build();
+  const sdk = getSDK('web');
+  expect(sdk.name).toBe('web');
+  const sdk1 = getSDK('web1');
+  expect(sdk1.name).toBe('web1');
+});

e2e/cases/doctor-rsbuild/test-utils.ts

@@ -0,0 +1,71 @@
+import { RsdoctorWebpackPluginOptions } from '@rsdoctor/core/types';
+import {
+  RsdoctorWebpackPlugin,
+  RsdoctorWebpackMultiplePlugin,
+} from '@rsdoctor/webpack-plugin';
+import { Linter } from '@rsdoctor/types';
+import { File } from '@rsdoctor/utils/build';
+import { tmpdir } from 'os';
+import path from 'path';
+
+export function createRsdoctorPlugin<T extends Linter.ExtendRuleData[]>(
+  options: RsdoctorWebpackPluginOptions<T> = {},
+) {
+  const plugin = new RsdoctorWebpackPlugin({
+    ...options,
+    disableClientServer:
+      typeof options.disableClientServer === 'boolean'
+        ? options.disableClientServer
+        : true,
+  });
+
+  const outdir = path.resolve(
+    tmpdir(),
+    `./${Date.now()}/rsdoctor_webpack_plugin_test`,
+  );
+
+  plugin.sdk.hooks.afterSaveManifest.tapPromise(
+    { name: 'REMOVE_TMP_DIR', stage: -9999 },
+    async () => {
+      plugin.sdk.setOutputDir(outdir);
+      try {
+        await File.fse.remove(plugin.sdk.outputDir);
+      } catch (e) {
+        console.error(e);
+      }
+    },
+  );
+
+  return plugin;
+}
+
+export function createRsdoctorMultiPlugin<T extends Linter.ExtendRuleData[]>(
+  options: RsdoctorWebpackPluginOptions<T> = {},
+) {
+  const plugin = new RsdoctorWebpackMultiplePlugin({
+    ...options,
+    disableClientServer:
+      typeof options.disableClientServer === 'boolean'
+        ? options.disableClientServer
+        : true,
+  });
+
+  const outdir = path.resolve(
+    tmpdir(),
+    `./${Date.now()}/rsdoctor_webpack_plugin_test`,
+  );
+
+  plugin.sdk.hooks.afterSaveManifest.tapPromise(
+    { name: 'REMOVE_TMP_DIR', stage: -9999 },
+    async () => {
+      plugin.sdk.setOutputDir(outdir);
+      try {
+        await File.fse.remove(plugin.sdk.outputDir);
+      } catch (e) {
+        console.error(e);
+      }
+    },
+  );
+
+  return plugin;
+}

e2e/cases/doctor-webpack/test-utils.ts

@@ -21,7 +21,7 @@ export function createRsdoctorPlugin<T extends Linter.ExtendRuleData[]>(
 
   const outdir = path.resolve(
     tmpdir(),
-    `./${Date.now()}/web_doctor_webpack_plugin_test`,
+    `./${Date.now()}/rsdoctor_webpack_plugin_test`,
   );
 
   plugin.sdk.hooks.afterSaveManifest.tapPromise(
@@ -52,7 +52,7 @@ export function createRsdoctorMultiPlugin<T extends Linter.ExtendRuleData[]>(
 
   const outdir = path.resolve(
     tmpdir(),
-    `./${Date.now()}/web_doctor_webpack_plugin_test`,
+    `./${Date.now()}/rsdoctor_webpack_plugin_test`,
   );
 
   plugin.sdk.hooks.afterSaveManifest.tapPromise(

examples/rspress-minimal/.gitignore

@@ -0,0 +1,14 @@
+# Local
+.DS_Store
+*.local
+*.log*
+
+# Dist
+node_modules
+dist/
+doc_build/
+
+# IDE
+.vscode/*
+!.vscode/extensions.json
+.idea

examples/rspress-minimal/README.md

@@ -0,0 +1,29 @@
+# Rspress website
+
+## Setup
+
+Install the dependencies:
+
+```bash
+npm install
+```
+
+## Get started
+
+Start the dev server:
+
+```bash
+npm run dev
+```
+
+Build the website for production:
+
+```bash
+npm run build
+```
+
+Preview the production build locally:
+
+```bash
+npm run preview
+```

examples/rspress-minimal/docs/_meta.json

@@ -0,0 +1,16 @@
+[
+  {
+    "text": "Guide",
+    "link": "/guide/",
+    "activeMatch": "/guide/"
+  },
+  {
+    "text": "Hello world",
+    "link": "/hello/",
+    "activeMatch": "/hello/"
+  },
+  {
+    "text": "API",
+    "link": "https://rspress.dev/api/index.html"
+  }
+]

examples/rspress-minimal/docs/guide/_meta.json

@@ -0,0 +1 @@
+["index"]