bbassieandClaude Opus 5.5
3227179613
Replace webpack and Module Federation with Vite 8. The controller build emits one entry per shared module (lib, web_ui, typebox, antd, react, react-dom, react-router) and lists them in manifest.json. The controller turns that into an import map in index.html, and plugins are built as ES modules that import the shared modules by name and are loaded with import(). The shared Vite setup lives in @clusterio/web_ui/vite.mjs. Plugins use clusterioPlugin(), which exposes index, package.json and web/index under the same keys the webpack template used. The --dev and --dev-plugin flags now run the Vite dev server in middleware mode with hot module replacement. Browser polyfills move from web_ui to lib, which is the code that needs them, and lib sets the process and Buffer globals itself. Refs #1127 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3.3 KiB
Migrating Plugins to 2.1
This guide covers the changes needed to bring a plugin written for 2.0 up to 2.1. Plugins still on an alpha should start with the 2.0 guide.
Request errors
RequestError is gone.
Errors thrown by request handlers are now received by the requester as the same class, see Request errors.
Replace RequestError with the class that fits:
- Invalid input:
ValidationError. - Operation disabled by config:
ForbiddenError. - Missing instance, user, save etc.:
NotFoundError. - Instance running, name taken etc.:
ConflictError. - Host not connected, instance not running:
UnavailableError. - Timeouts:
TimeoutError.
catch blocks that check err instanceof RequestError should check ClientError instead, or the specific class.
Checks of err.code for remote errors can use instanceof, e.g. err instanceof lib.SessionLost.
The config errors lib.InvalidValue, lib.InvalidField and lib.InvalidAccess were renamed to lib.InvalidValueError, lib.InvalidFieldError and lib.InvalidAccessError.
Errors of classes that are not registered, like a TypeError from a bug, are received as InternalServerError.
Plugins that define their own error classes need to list them in errors of the plugin declaration.
Build the web module with Vite
The web interface is now built with Vite instead of webpack, and plugin web modules are loaded as ES modules instead of through Module Federation. A plugin built with webpack fails to load with the error "Incompatible dist/web/manifest.json, the plugin must be rebuilt with Vite".
Delete webpack.config.cjs and add a vite.config.js next to package.json:
import { defineConfig } from "vite";
import { clusterioPlugin } from "@clusterio/web_ui/vite.mjs";
export default defineConfig({
plugins: [clusterioPlugin()],
});
In package.json replace webpack-cli --mode production in the prepare script with vite build, and replace the webpack, webpack-cli and webpack-merge dev dependencies with vite.
Add vite.config.js to .npmignore if you had webpack.config.js there.
clusterioPlugin exposes index.ts (or index.js) as "./", package.json as "./package.json" and web/index.tsx (or .ts, .jsx, .js) as "./web".
These are the same keys the plugin template used with webpack, so webEntrypoint: "./web" stays as it is.
If your webpack config exposed other paths, move the code so it is reachable from web/index.tsx.
The web interface provides @clusterio/lib, @clusterio/web_ui, @sinclair/typebox, antd, react, react-dom, react-router and react-router-dom to plugins.
These are left as imports in the plugin bundle and resolved by the browser, there is no need to list them as shared.
Everything else is bundled into the plugin, including @ant-design/icons.
Import react-dom/client and react/jsx-runtime by those names, other subpaths of the shared packages are bundled as a separate copy.
Vite does not provide Node.js modules to plugin code.
If your web code imports events, path or similar, add the browser package for it (events, path-browserify) to your dependencies.
The container property of WebPluginContext is now the plugin's ES module namespace, await container.get("./web") returns the module instead of a factory function.