mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 09:23:52 -05:00
f94ff8332a
## Summary This PR significantly improves maintainability by breaking up the 880+ line monolithic app.ts file into smaller, focused modules with proper testing. The code is now organized into dedicated modules under the lib/app/ directory, making the codebase more maintainable and testable. ## Key changes - Extract functionality into modules under lib/app/ directory: - Command-line handling (cli.ts) - Configuration loading (config.ts) - Web server setup and middleware (server.ts) - Core application initialization (main.ts) - URL handlers, routing, rendering, and controllers - Add comprehensive unit tests for all new modules - Make compilationQueue non-optional in the compilation environment - Improve separation of concerns with dedicated interfaces - Ensure backward compatibility with existing functionality - Maintain cross-platform compatibility (Windows/Linux) ## Benefits - Improved code organization and modularity - Enhanced testability with proper unit tests - Better separation of concerns - Reduced complexity in individual files - Easier maintenance and future development This refactoring is a significant step toward a more maintainable codebase while preserving all existing functionality.
88 lines
3.8 KiB
TypeScript
88 lines
3.8 KiB
TypeScript
// Copyright (c) 2025, Compiler Explorer Authors
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import {CompilerInfo} from '../../types/compiler.interfaces.js';
|
|
import type {Language, LanguageKey} from '../../types/languages.interfaces.js';
|
|
import type {AppArguments} from '../app.interfaces.js';
|
|
import {unwrap} from '../assert.js';
|
|
import {CompilerFinder} from '../compiler-finder.js';
|
|
import {RouteAPI} from '../handlers/route-api.js';
|
|
import {logger} from '../logger.js';
|
|
import {ClientOptionsHandler} from '../options-handler.js';
|
|
import {PropertyGetter} from '../properties.interfaces.js';
|
|
|
|
/**
|
|
* Setup handling of compiler changes and periodic rescanning
|
|
* @param initialCompilers - The initial set of compilers
|
|
* @param clientOptionsHandler - Client options handler
|
|
* @param routeApi - Route API instance
|
|
* @param languages - Available languages
|
|
* @param ceProps - CE properties
|
|
* @param compilerFinder - Compiler finder instance
|
|
* @param appArgs - Application arguments
|
|
*/
|
|
export async function setupCompilerChangeHandling(
|
|
initialCompilers: CompilerInfo[],
|
|
clientOptionsHandler: ClientOptionsHandler,
|
|
routeApi: RouteAPI,
|
|
languages: Record<LanguageKey, Language>,
|
|
ceProps: PropertyGetter,
|
|
compilerFinder: CompilerFinder,
|
|
appArgs: AppArguments,
|
|
): Promise<void> {
|
|
let prevCompilers = '';
|
|
|
|
/**
|
|
* Handle compiler change events
|
|
* @param compilers - New set of compilers
|
|
*/
|
|
async function onCompilerChange(compilers: CompilerInfo[]) {
|
|
const compilersAsJson = JSON.stringify(compilers);
|
|
if (prevCompilers === compilersAsJson) {
|
|
return;
|
|
}
|
|
logger.info(`Compiler scan count: ${compilers.length}`);
|
|
logger.debug('Compilers:', compilers);
|
|
prevCompilers = compilersAsJson;
|
|
await clientOptionsHandler.setCompilers(compilers);
|
|
const apiHandler = unwrap(routeApi.apiHandler);
|
|
apiHandler.setCompilers(compilers);
|
|
apiHandler.setLanguages(languages);
|
|
apiHandler.setOptions(clientOptionsHandler);
|
|
}
|
|
|
|
// Set initial compilers
|
|
await onCompilerChange(initialCompilers);
|
|
|
|
// Set up compiler rescanning if configured
|
|
const rescanCompilerSecs = ceProps('rescanCompilerSecs', 0);
|
|
if (rescanCompilerSecs && !appArgs.prediscovered) {
|
|
logger.info(`Rescanning compilers every ${rescanCompilerSecs} secs`);
|
|
setInterval(
|
|
() => compilerFinder.find().then(result => onCompilerChange(result.compilers)),
|
|
rescanCompilerSecs * 1000,
|
|
);
|
|
}
|
|
}
|