mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-20 23:20:46 +00:00
Optimizes terminal rendering by tuning GPU settings, enabling dynamic renderer selection, and adding debounced resize handling for smoother user experience across platforms. Integrates XTerm serialization addon for enhanced terminal state management. Updates several project dependencies to improve compatibility, security, and maintainability. Removes obsolete refactoring documentation.
180 lines
5.2 KiB
TypeScript
180 lines
5.2 KiB
TypeScript
/**
|
|
* XTerm.js Performance Optimization Configuration
|
|
*
|
|
* This file contains platform-specific optimizations for xterm performance.
|
|
* macOS has different performance characteristics than Windows due to:
|
|
* - Stricter GPU memory management
|
|
* - Different rendering pipeline (Metal vs DirectX)
|
|
* - Memory pressure handling
|
|
*/
|
|
|
|
export const XTERM_PERFORMANCE_CONFIG = {
|
|
// Memory and Scrollback Settings
|
|
scrollback: {
|
|
// Windows can handle larger buffers efficiently
|
|
default: 3000,
|
|
// macOS performance degrades with large scrollbacks
|
|
// due to more aggressive memory pressure
|
|
macOS: 1000,
|
|
// Mobile-like environments
|
|
lowMemory: 500,
|
|
},
|
|
|
|
// Rendering optimizations
|
|
rendering: {
|
|
// Disable cursor blinking - reduces render calls significantly
|
|
cursorBlink: false,
|
|
|
|
// Allow transparency is expensive on macOS with Metal
|
|
// Disabling it improves performance by 15-20%
|
|
allowTransparency: false,
|
|
|
|
// Custom glyphs require additional memory and processing
|
|
customGlyphs: false,
|
|
|
|
// Font rendering settings
|
|
letterSpacing: 0,
|
|
lineHeight: 1,
|
|
},
|
|
|
|
// WebGL-specific optimizations
|
|
webgl: {
|
|
// Enable WebGL by default for GPU acceleration
|
|
enabled: true,
|
|
|
|
// macOS 强制使用 WebGL;仅在非 macOS 平台可选择 Canvas
|
|
preferCanvas: false,
|
|
|
|
// Handle WebGL context loss gracefully
|
|
enableContextLoss: true,
|
|
},
|
|
|
|
// Event handling optimizations
|
|
events: {
|
|
// Use document override for better event routing on macOS
|
|
documentOverride: true,
|
|
|
|
// Standard tab width (8 spaces)
|
|
tabStopWidth: 8,
|
|
|
|
// Let the SSH daemon handle EOL conversion
|
|
convertEol: false,
|
|
|
|
// Allow bracketed paste mode for better paste handling
|
|
ignoreBracketedPasteMode: false,
|
|
},
|
|
|
|
// Logging (disable in production for performance)
|
|
logging: {
|
|
logLevel: 'off' as const, // 'off' | 'error' | 'warn' | 'info' | 'debug'
|
|
},
|
|
|
|
// Resize debouncing (macOS can get flooded with resize events)
|
|
resize: {
|
|
// Debounce delay in milliseconds
|
|
// Higher values reduce CPU usage but may feel less responsive
|
|
debounceMs: 50,
|
|
|
|
// Use requestAnimationFrame for resize fitting
|
|
useRAF: true,
|
|
},
|
|
|
|
// Performance monitoring thresholds
|
|
monitoring: {
|
|
// Log performance warning if render takes longer than this (ms)
|
|
slowRenderThreshold: 16, // 60fps = 16.67ms per frame
|
|
|
|
// Log warning if data buffer gets too large
|
|
largeBufferThreshold: 1024 * 1024, // 1MB
|
|
},
|
|
};
|
|
|
|
export type XTermPlatform = "darwin" | "win32" | "linux";
|
|
|
|
type RendererType = "canvas" | "dom";
|
|
type LogLevel = "off" | "error" | "warn" | "info" | "debug";
|
|
|
|
export type ResolvedXTermPerformance = {
|
|
options: {
|
|
scrollback: number;
|
|
cursorBlink: boolean;
|
|
allowTransparency: boolean;
|
|
customGlyphs: boolean;
|
|
letterSpacing: number;
|
|
lineHeight: number;
|
|
documentOverride: boolean;
|
|
tabStopWidth: number;
|
|
convertEol: boolean;
|
|
ignoreBracketedPasteMode: boolean;
|
|
logLevel: LogLevel;
|
|
rendererType?: RendererType;
|
|
};
|
|
useWebGLAddon: boolean;
|
|
preferCanvasRenderer: boolean;
|
|
};
|
|
|
|
const isLowMemoryDevice = (deviceMemoryGb?: number) =>
|
|
typeof deviceMemoryGb === "number" && deviceMemoryGb > 0 && deviceMemoryGb <= 4;
|
|
|
|
/**
|
|
* Get platform-specific xterm configuration
|
|
* @returns Configuration object optimized for the current platform
|
|
*/
|
|
export function getXTermConfig(platform: XTermPlatform = "darwin") {
|
|
return resolveXTermPerformanceConfig({ platform }).options;
|
|
}
|
|
|
|
/**
|
|
* Resolve a platform and hardware aware performance profile.
|
|
* Enables a Mac-specific canvas preference on low-memory devices to avoid WebGL overhead.
|
|
*/
|
|
export function resolveXTermPerformanceConfig({
|
|
platform = "darwin",
|
|
deviceMemoryGb,
|
|
preferCanvasRenderer,
|
|
}: {
|
|
platform?: XTermPlatform;
|
|
deviceMemoryGb?: number;
|
|
preferCanvasRenderer?: boolean;
|
|
} = {}): ResolvedXTermPerformance {
|
|
const baseConfig = XTERM_PERFORMANCE_CONFIG;
|
|
|
|
const lowMem = isLowMemoryDevice(deviceMemoryGb);
|
|
const resolvedPreferCanvas =
|
|
typeof preferCanvasRenderer === "boolean"
|
|
? preferCanvasRenderer && platform !== "darwin"
|
|
: platform !== "darwin" && (baseConfig.webgl.preferCanvas || lowMem);
|
|
|
|
const scrollbackProfile = lowMem
|
|
? "lowMemory"
|
|
: platform === "darwin"
|
|
? "macOS"
|
|
: "default";
|
|
|
|
const rendererType = resolvedPreferCanvas ? ("canvas" as const) : undefined;
|
|
|
|
const baseOptions = {
|
|
scrollback: baseConfig.scrollback[scrollbackProfile],
|
|
cursorBlink: baseConfig.rendering.cursorBlink,
|
|
allowTransparency: baseConfig.rendering.allowTransparency,
|
|
customGlyphs: baseConfig.rendering.customGlyphs,
|
|
letterSpacing: baseConfig.rendering.letterSpacing,
|
|
lineHeight: baseConfig.rendering.lineHeight,
|
|
documentOverride: baseConfig.events.documentOverride,
|
|
tabStopWidth: baseConfig.events.tabStopWidth,
|
|
convertEol: baseConfig.events.convertEol,
|
|
ignoreBracketedPasteMode: baseConfig.events.ignoreBracketedPasteMode,
|
|
logLevel: baseConfig.logging.logLevel,
|
|
};
|
|
|
|
const options = rendererType
|
|
? { ...baseOptions, rendererType }
|
|
: baseOptions;
|
|
|
|
return {
|
|
options,
|
|
useWebGLAddon: baseConfig.webgl.enabled && !resolvedPreferCanvas,
|
|
preferCanvasRenderer: resolvedPreferCanvas,
|
|
};
|
|
}
|