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.
103 lines
4.0 KiB
TypeScript
103 lines
4.0 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 type {Router} from 'express';
|
|
import type {AppArguments} from '../app.interfaces.js';
|
|
import {CompilationEnvironment} from '../compilation-env.js';
|
|
import {CompileHandler} from '../handlers/compile.js';
|
|
import {NoScriptHandler} from '../handlers/noscript.js';
|
|
import {RouteAPI} from '../handlers/route-api.js';
|
|
import {ClientOptionsHandler} from '../options-handler.js';
|
|
import {PropertyGetter} from '../properties.interfaces.js';
|
|
import {StorageBase} from '../storage/index.js';
|
|
import type {ApiControllers} from './controllers.js';
|
|
import {RenderConfigFunction, RenderGoldenLayoutHandler} from './server.interfaces.js';
|
|
|
|
/**
|
|
* Set up routes and API endpoints for the application
|
|
* @param router - Express router
|
|
* @param controllers - Controller instances
|
|
* @param clientOptionsHandler - Client options handler
|
|
* @param renderConfig - Config rendering function
|
|
* @param renderGoldenLayout - Golden layout rendering function
|
|
* @param storageHandler - Storage handler
|
|
* @param appArgs - Application arguments
|
|
* @param compileHandler - Compile handler
|
|
* @param compilationEnvironment - Compilation environment
|
|
* @param ceProps - Compiler Explorer properties
|
|
* @returns RouteAPI instance
|
|
*/
|
|
export function setupRoutesAndApi(
|
|
router: Router,
|
|
controllers: ApiControllers,
|
|
clientOptionsHandler: ClientOptionsHandler,
|
|
renderConfig: RenderConfigFunction,
|
|
renderGoldenLayout: RenderGoldenLayoutHandler,
|
|
storageHandler: StorageBase,
|
|
appArgs: AppArguments,
|
|
compileHandler: CompileHandler,
|
|
compilationEnvironment: CompilationEnvironment,
|
|
ceProps: PropertyGetter,
|
|
): RouteAPI {
|
|
const {
|
|
siteTemplateController,
|
|
sourceController,
|
|
assemblyDocumentationController,
|
|
formattingController,
|
|
noScriptController,
|
|
} = controllers;
|
|
|
|
// Set up NoScript handler and RouteAPI
|
|
const noscriptHandler = new NoScriptHandler(
|
|
router,
|
|
clientOptionsHandler,
|
|
renderConfig,
|
|
storageHandler,
|
|
appArgs.wantedLanguages?.[0],
|
|
);
|
|
|
|
const routeApi = new RouteAPI(router, {
|
|
compileHandler,
|
|
clientOptionsHandler,
|
|
storageHandler,
|
|
compilationEnvironment,
|
|
ceProps,
|
|
defArgs: appArgs,
|
|
renderConfig,
|
|
renderGoldenLayout,
|
|
});
|
|
|
|
// Set up controllers
|
|
router.use(siteTemplateController.createRouter());
|
|
router.use(sourceController.createRouter());
|
|
router.use(assemblyDocumentationController.createRouter());
|
|
router.use(formattingController.createRouter());
|
|
router.use(noScriptController.createRouter());
|
|
|
|
noscriptHandler.initializeRoutes();
|
|
routeApi.initializeRoutes();
|
|
|
|
return routeApi;
|
|
}
|