Rspack incompatibility with docusaurus-plugin-openapi-docs

[rbala19]

Docusaurus version: 3.6.1
Docusaurus-plugin-openapi-docs Version: 4.0.1 (Latest)

Before upgrading to version 3.6.1 and enabling rspack, I used the docusaurus openapi plugin to generate an API webpage from my api spec files (generated by the Open Api Specification Client [oas]). Since, upgrading I've been running into build issues, most likely related to rspack. Here is my current config with the upgraded versions:

Example OAS-generated JSON file api/admin-api.json:

{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Admin"
  },
  "servers": [
    {
      "url": "https://hq.frontapp.com"
    }
  ],
  "paths": {}
}

Configuration in docusaurus.config.js:

  future: {
    experimental_faster: {
      swcJsLoader: false /* We set this to false and use our custom transformation on rspack's builtin swc loader */,
      swcJsMinimizer: true,
      swcHtmlMinimizer: true,
      lightningCssMinimizer: true,
      rspackBundler: true,
      mdxCrossCompilerCache: true,
    },
  },
  webpack: {
    jsLoader: (isServer) => {
      return {
        loader: 'builtin:swc-loader',
        options: {
          jsc: {
            parser: {
              syntax: 'typescript',
              tsx: true,
            },
            target: 'es2017',
          },
          module: {
            type: isServer ? 'commonjs' : 'es6',
          },
        },
      };
    },
  },
 [
      'docusaurus-plugin-openapi-docs',
      {
        id: 'apiDocs',
        docsPluginId: 'classic',
        config: {
          private: {
            specPath: 'api/admin-api.json',
            outputDir: 'docs/api/admin',
            sidebarOptions: {
              groupPathsBy: 'tag',
            },
          },
        }
      }
],
 themes: [
   'docusaurus-theme-openapi-docs',
  ],

For this to build correctly, I also had to add docusaurus-theme-openapi-docs to my themes.

On build, the plugin errors with:

[ERROR] Error: Unable to build website for locale en.
    at tryToBuildLocale (/Users/rahulb/Desktop/front/doc_site/node_modules/@docusaurus/core/lib/commands/build/build.js:78:15)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async /Users/rahulb/Desktop/front/doc_site/node_modules/@docusaurus/core/lib/commands/build/build.js:34:9
    at async mapAsyncSequential (/Users/rahulb/Desktop/front/doc_site/node_modules/@docusaurus/utils/lib/jsUtils.js:21:24)
    at async Command.build (/Users/rahulb/Desktop/front/doc_site/node_modules/@docusaurus/core/lib/commands/build/build.js:33:5) {
  [cause]: [Error:   × TypeError: Cannot read properties of undefined (reading 'set')
    │     at Object.fn (/Users/rahulb/Desktop/front/doc_site/node_modules/webpack/lib/ProvidePlugin.js:43:37)
    │     at SyncHook.callAsyncStageRange (/Users/rahulb/Desktop/front/doc_site/node_modules/@rspack/lite-tapable/dist/index.js:240:21)
    │     at SyncHook.callStageRange (/Users/rahulb/Desktop/front/doc_site/node_modules/@rspack/lite-tapable/dist/index.js:259:14)
    │     at QueriedHook.call (/Users/rahulb/Desktop/front/doc_site/node_modules/@rspack/lite-tapable/dist/index.js:218:26)
    │     at /Users/rahulb/Desktop/front/doc_site/node_modules/@rspack/core/dist/index.js:13679:28
    │     at last.function (/Users/rahulb/Desktop/front/doc_site/node_modules/@rspack/core/dist/index.js:14477:25)
    │
  ] {
    code: 'GenericFailure'
  }
}
[INFO] Docusaurus version: 3.6.1
Node version: v20.11.0

If I turn off rspack (and make associated changes to the webpack config), the build passes. There seems to be an incompatibility with rspack and this plugin at the moment. I have an open issue on that project: milesj/docusaurus-plugin-typedoc-api#158. In the meanwhile, does anyone know of any workarounds to generate API html from OAS-generated JSON?

[slorber]

I don't think the problem comes from that plugin, it is likely something else.

The error comes from the usage of webpack.ProvidePlugin instead of currentBundler.instance. ProvidePlugin (see our guide here: #10572)

But I audited this plugin before Docusaurus v3.6 release and it does not use ProvidePlugin: https://github.com/milesj/docusaurus-plugin-typedoc-api

So, I suspect it's another thing that breaks your site. We'd need a repro to be able to help you.