mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-07-11 23:26:30 +08:00
feat: improve test & bundler (#14434)
#### PR Dependency Tree * **PR #14434** 👈 This tree was auto-generated by [Charcoal](https://github.com/danerwilliams/charcoal) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Introduced rspack bundler as an alternative to webpack for optimized builds. * **Tests & Quality** * Added comprehensive editor semantic tests covering markdown, hotkeys, and slash-menu operations. * Expanded CI cross-browser testing to Chromium, Firefox, and WebKit; improved shape-rendering tests to account for zoom. * **Bug Fixes** * Corrected CSS overlay styling for development servers. * Fixed TypeScript typings for build tooling. * **Other** * Document duplication now produces consistent "(n)" suffixes. * French i18n completeness increased to 100%. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
+226
-70
@@ -3,20 +3,46 @@ import { cpus } from 'node:os';
|
||||
|
||||
import { Logger } from '@affine-tools/utils/logger';
|
||||
import { Package } from '@affine-tools/utils/workspace';
|
||||
import rspack, { type MultiRspackOptions } from '@rspack/core';
|
||||
import {
|
||||
type Configuration as RspackDevServerConfiguration,
|
||||
RspackDevServer,
|
||||
} from '@rspack/dev-server';
|
||||
import { merge } from 'lodash-es';
|
||||
import webpack from 'webpack';
|
||||
import WebpackDevServer, {
|
||||
type Configuration as DevServerConfiguration,
|
||||
type Configuration as WebpackDevServerConfiguration,
|
||||
} from 'webpack-dev-server';
|
||||
|
||||
import {
|
||||
assertRspackSupportedPackageName,
|
||||
DEFAULT_DEV_SERVER_CONFIG,
|
||||
isRspackSupportedPackageName,
|
||||
} from './bundle-shared';
|
||||
import { type Bundler, getBundler } from './bundler';
|
||||
import { Option, PackageCommand } from './command';
|
||||
import {
|
||||
createHTMLTargetConfig,
|
||||
createNodeTargetConfig,
|
||||
createWorkerTargetConfig,
|
||||
createHTMLTargetConfig as createRspackHTMLTargetConfig,
|
||||
createNodeTargetConfig as createRspackNodeTargetConfig,
|
||||
createWorkerTargetConfig as createRspackWorkerTargetConfig,
|
||||
} from './rspack';
|
||||
import {
|
||||
createHTMLTargetConfig as createWebpackHTMLTargetConfig,
|
||||
createNodeTargetConfig as createWebpackNodeTargetConfig,
|
||||
createWorkerTargetConfig as createWebpackWorkerTargetConfig,
|
||||
} from './webpack';
|
||||
|
||||
function getBaseWorkerConfigs(pkg: Package) {
|
||||
type WorkerConfig = { name: string };
|
||||
type CreateWorkerTargetConfig = (pkg: Package, entry: string) => WorkerConfig;
|
||||
|
||||
function assertRspackSupportedPackage(pkg: Package) {
|
||||
assertRspackSupportedPackageName(pkg.name);
|
||||
}
|
||||
|
||||
function getBaseWorkerConfigs(
|
||||
pkg: Package,
|
||||
createWorkerTargetConfig: CreateWorkerTargetConfig
|
||||
) {
|
||||
const core = new Package('@affine/core');
|
||||
|
||||
return [
|
||||
@@ -39,27 +65,30 @@ function getBaseWorkerConfigs(pkg: Package) {
|
||||
];
|
||||
}
|
||||
|
||||
function getBundleConfigs(pkg: Package): webpack.MultiConfiguration {
|
||||
function getWebpackBundleConfigs(pkg: Package): webpack.MultiConfiguration {
|
||||
switch (pkg.name) {
|
||||
case '@affine/admin': {
|
||||
return [
|
||||
createHTMLTargetConfig(pkg, pkg.srcPath.join('index.tsx').value),
|
||||
createWebpackHTMLTargetConfig(pkg, pkg.srcPath.join('index.tsx').value),
|
||||
] as webpack.MultiConfiguration;
|
||||
}
|
||||
case '@affine/web':
|
||||
case '@affine/mobile':
|
||||
case '@affine/ios':
|
||||
case '@affine/android': {
|
||||
const workerConfigs = getBaseWorkerConfigs(pkg);
|
||||
const workerConfigs = getBaseWorkerConfigs(
|
||||
pkg,
|
||||
createWebpackWorkerTargetConfig
|
||||
);
|
||||
workerConfigs.push(
|
||||
createWorkerTargetConfig(
|
||||
createWebpackWorkerTargetConfig(
|
||||
pkg,
|
||||
pkg.srcPath.join('nbstore.worker.ts').value
|
||||
)
|
||||
);
|
||||
|
||||
return [
|
||||
createHTMLTargetConfig(
|
||||
createWebpackHTMLTargetConfig(
|
||||
pkg,
|
||||
pkg.srcPath.join('index.tsx').value,
|
||||
{},
|
||||
@@ -69,10 +98,13 @@ function getBundleConfigs(pkg: Package): webpack.MultiConfiguration {
|
||||
] as webpack.MultiConfiguration;
|
||||
}
|
||||
case '@affine/electron-renderer': {
|
||||
const workerConfigs = getBaseWorkerConfigs(pkg);
|
||||
const workerConfigs = getBaseWorkerConfigs(
|
||||
pkg,
|
||||
createWebpackWorkerTargetConfig
|
||||
);
|
||||
|
||||
return [
|
||||
createHTMLTargetConfig(
|
||||
createWebpackHTMLTargetConfig(
|
||||
pkg,
|
||||
{
|
||||
index: pkg.srcPath.join('app/index.tsx').value,
|
||||
@@ -93,7 +125,7 @@ function getBundleConfigs(pkg: Package): webpack.MultiConfiguration {
|
||||
}
|
||||
case '@affine/server': {
|
||||
return [
|
||||
createNodeTargetConfig(pkg, pkg.srcPath.join('index.ts').value),
|
||||
createWebpackNodeTargetConfig(pkg, pkg.srcPath.join('index.ts').value),
|
||||
] as webpack.MultiConfiguration;
|
||||
}
|
||||
}
|
||||
@@ -101,55 +133,75 @@ function getBundleConfigs(pkg: Package): webpack.MultiConfiguration {
|
||||
throw new Error(`Unsupported package: ${pkg.name}`);
|
||||
}
|
||||
|
||||
const IN_CI = !!process.env.CI;
|
||||
const httpProxyMiddlewareLogLevel = IN_CI ? 'silent' : 'error';
|
||||
function getRspackBundleConfigs(pkg: Package): MultiRspackOptions {
|
||||
assertRspackSupportedPackage(pkg);
|
||||
|
||||
const defaultDevServerConfig: DevServerConfiguration = {
|
||||
host: '0.0.0.0',
|
||||
allowedHosts: 'all',
|
||||
hot: false,
|
||||
liveReload: true,
|
||||
compress: !process.env.CI,
|
||||
setupExitSignals: true,
|
||||
client: {
|
||||
overlay: process.env.DISABLE_DEV_OVERLAY === 'true' ? false : undefined,
|
||||
logging: process.env.CI ? 'none' : 'error',
|
||||
// see: https://webpack.js.org/configuration/dev-server/#websocketurl
|
||||
// must be an explicit ws/wss URL because custom protocols (e.g. assets://)
|
||||
// cannot be used to construct WebSocket endpoints in Electron
|
||||
webSocketURL: 'ws://0.0.0.0:8080/ws',
|
||||
},
|
||||
historyApiFallback: {
|
||||
rewrites: [
|
||||
{
|
||||
from: /.*/,
|
||||
to: () => {
|
||||
return process.env.SELF_HOSTED === 'true'
|
||||
? '/selfhost.html'
|
||||
: '/index.html';
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
proxy: [
|
||||
{
|
||||
context: '/api',
|
||||
target: 'http://localhost:3010',
|
||||
logLevel: httpProxyMiddlewareLogLevel,
|
||||
},
|
||||
{
|
||||
context: '/socket.io',
|
||||
target: 'http://localhost:3010',
|
||||
ws: true,
|
||||
logLevel: httpProxyMiddlewareLogLevel,
|
||||
},
|
||||
{
|
||||
context: '/graphql',
|
||||
target: 'http://localhost:3010',
|
||||
logLevel: httpProxyMiddlewareLogLevel,
|
||||
},
|
||||
],
|
||||
};
|
||||
switch (pkg.name) {
|
||||
case '@affine/admin': {
|
||||
return [
|
||||
createRspackHTMLTargetConfig(pkg, pkg.srcPath.join('index.tsx').value),
|
||||
] as MultiRspackOptions;
|
||||
}
|
||||
case '@affine/web':
|
||||
case '@affine/mobile':
|
||||
case '@affine/ios':
|
||||
case '@affine/android': {
|
||||
const workerConfigs = getBaseWorkerConfigs(
|
||||
pkg,
|
||||
createRspackWorkerTargetConfig
|
||||
);
|
||||
workerConfigs.push(
|
||||
createRspackWorkerTargetConfig(
|
||||
pkg,
|
||||
pkg.srcPath.join('nbstore.worker.ts').value
|
||||
)
|
||||
);
|
||||
|
||||
return [
|
||||
createRspackHTMLTargetConfig(
|
||||
pkg,
|
||||
pkg.srcPath.join('index.tsx').value,
|
||||
{},
|
||||
workerConfigs.map(config => config.name)
|
||||
),
|
||||
...workerConfigs,
|
||||
] as MultiRspackOptions;
|
||||
}
|
||||
case '@affine/electron-renderer': {
|
||||
const workerConfigs = getBaseWorkerConfigs(
|
||||
pkg,
|
||||
createRspackWorkerTargetConfig
|
||||
);
|
||||
|
||||
return [
|
||||
createRspackHTMLTargetConfig(
|
||||
pkg,
|
||||
{
|
||||
index: pkg.srcPath.join('app/index.tsx').value,
|
||||
shell: pkg.srcPath.join('shell/index.tsx').value,
|
||||
popup: pkg.srcPath.join('popup/index.tsx').value,
|
||||
backgroundWorker: pkg.srcPath.join('background-worker/index.ts')
|
||||
.value,
|
||||
},
|
||||
{
|
||||
additionalEntryForSelfhost: false,
|
||||
injectGlobalErrorHandler: false,
|
||||
emitAssetsManifest: false,
|
||||
},
|
||||
workerConfigs.map(config => config.name)
|
||||
),
|
||||
...workerConfigs,
|
||||
] as MultiRspackOptions;
|
||||
}
|
||||
case '@affine/server': {
|
||||
return [
|
||||
createRspackNodeTargetConfig(pkg, pkg.srcPath.join('index.ts').value),
|
||||
] as MultiRspackOptions;
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(`Unsupported package: ${pkg.name}`);
|
||||
}
|
||||
|
||||
export class BundleCommand extends PackageCommand {
|
||||
static override paths = [['bundle'], ['webpack'], ['pack'], ['bun']];
|
||||
@@ -164,22 +216,36 @@ export class BundleCommand extends PackageCommand {
|
||||
|
||||
async execute() {
|
||||
const pkg = this.workspace.getPackage(this.package);
|
||||
const bundler = getBundler();
|
||||
|
||||
if (this.dev) {
|
||||
await BundleCommand.dev(pkg);
|
||||
await BundleCommand.dev(pkg, bundler);
|
||||
} else {
|
||||
await BundleCommand.build(pkg);
|
||||
await BundleCommand.build(pkg, bundler);
|
||||
}
|
||||
}
|
||||
|
||||
static async build(pkg: Package) {
|
||||
static async build(pkg: Package, bundler: Bundler = getBundler()) {
|
||||
if (bundler === 'rspack' && !isRspackSupportedPackageName(pkg.name)) {
|
||||
return BundleCommand.buildWithWebpack(pkg);
|
||||
}
|
||||
|
||||
switch (bundler) {
|
||||
case 'webpack':
|
||||
return BundleCommand.buildWithWebpack(pkg);
|
||||
case 'rspack':
|
||||
return BundleCommand.buildWithRspack(pkg);
|
||||
}
|
||||
}
|
||||
|
||||
static async buildWithWebpack(pkg: Package) {
|
||||
process.env.NODE_ENV = 'production';
|
||||
const logger = new Logger('bundle');
|
||||
logger.info(`Packing package ${pkg.name}...`);
|
||||
logger.info(`Packing package ${pkg.name} with webpack...`);
|
||||
logger.info('Cleaning old output...');
|
||||
rmSync(pkg.distPath.value, { recursive: true, force: true });
|
||||
|
||||
const config = getBundleConfigs(pkg);
|
||||
const config = getWebpackBundleConfigs(pkg);
|
||||
config.parallelism = cpus().length;
|
||||
|
||||
const compiler = webpack(config);
|
||||
@@ -203,12 +269,43 @@ export class BundleCommand extends PackageCommand {
|
||||
});
|
||||
}
|
||||
|
||||
static async dev(pkg: Package, devServerConfig?: DevServerConfiguration) {
|
||||
static async dev(
|
||||
pkg: Package,
|
||||
bundler: Bundler = getBundler(),
|
||||
devServerConfig?:
|
||||
| WebpackDevServerConfiguration
|
||||
| RspackDevServerConfiguration
|
||||
) {
|
||||
if (bundler === 'rspack' && !isRspackSupportedPackageName(pkg.name)) {
|
||||
return BundleCommand.devWithWebpack(
|
||||
pkg,
|
||||
devServerConfig as WebpackDevServerConfiguration | undefined
|
||||
);
|
||||
}
|
||||
|
||||
switch (bundler) {
|
||||
case 'webpack':
|
||||
return BundleCommand.devWithWebpack(
|
||||
pkg,
|
||||
devServerConfig as WebpackDevServerConfiguration | undefined
|
||||
);
|
||||
case 'rspack':
|
||||
return BundleCommand.devWithRspack(
|
||||
pkg,
|
||||
devServerConfig as RspackDevServerConfiguration | undefined
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
static async devWithWebpack(
|
||||
pkg: Package,
|
||||
devServerConfig?: WebpackDevServerConfiguration
|
||||
) {
|
||||
process.env.NODE_ENV = 'development';
|
||||
const logger = new Logger('bundle');
|
||||
logger.info(`Starting dev server for ${pkg.name}...`);
|
||||
logger.info(`Starting webpack dev server for ${pkg.name}...`);
|
||||
|
||||
const config = getBundleConfigs(pkg);
|
||||
const config = getWebpackBundleConfigs(pkg);
|
||||
config.parallelism = cpus().length;
|
||||
|
||||
const compiler = webpack(config);
|
||||
@@ -217,7 +314,66 @@ export class BundleCommand extends PackageCommand {
|
||||
}
|
||||
|
||||
const devServer = new WebpackDevServer(
|
||||
merge({}, defaultDevServerConfig, devServerConfig),
|
||||
merge({}, DEFAULT_DEV_SERVER_CONFIG, devServerConfig),
|
||||
compiler
|
||||
);
|
||||
|
||||
await devServer.start();
|
||||
}
|
||||
|
||||
static async buildWithRspack(pkg: Package) {
|
||||
process.env.NODE_ENV = 'production';
|
||||
assertRspackSupportedPackage(pkg);
|
||||
|
||||
const logger = new Logger('bundle');
|
||||
logger.info(`Packing package ${pkg.name} with rspack...`);
|
||||
logger.info('Cleaning old output...');
|
||||
rmSync(pkg.distPath.value, { recursive: true, force: true });
|
||||
|
||||
const config = getRspackBundleConfigs(pkg);
|
||||
config.parallelism = cpus().length;
|
||||
|
||||
const compiler = rspack(config);
|
||||
if (!compiler) {
|
||||
throw new Error('Failed to create rspack compiler');
|
||||
}
|
||||
|
||||
compiler.run((error, stats) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
process.exit(1);
|
||||
}
|
||||
if (stats) {
|
||||
if (stats.hasErrors()) {
|
||||
console.error(stats.toString('errors-only'));
|
||||
process.exit(1);
|
||||
} else {
|
||||
console.log(stats.toString('minimal'));
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
static async devWithRspack(
|
||||
pkg: Package,
|
||||
devServerConfig?: RspackDevServerConfiguration
|
||||
) {
|
||||
process.env.NODE_ENV = 'development';
|
||||
assertRspackSupportedPackage(pkg);
|
||||
|
||||
const logger = new Logger('bundle');
|
||||
logger.info(`Starting rspack dev server for ${pkg.name}...`);
|
||||
|
||||
const config = getRspackBundleConfigs(pkg);
|
||||
config.parallelism = cpus().length;
|
||||
|
||||
const compiler = rspack(config);
|
||||
if (!compiler) {
|
||||
throw new Error('Failed to create rspack compiler');
|
||||
}
|
||||
|
||||
const devServer = new RspackDevServer(
|
||||
merge({}, DEFAULT_DEV_SERVER_CONFIG, devServerConfig),
|
||||
compiler
|
||||
);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user