mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 07:04:04 -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.
92 lines
3.6 KiB
TypeScript
92 lines
3.6 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 url from 'node:url';
|
|
import type {NextFunction, Request, Response} from 'express';
|
|
|
|
import {logger} from '../logger.js';
|
|
import {PropertyGetter} from '../properties.interfaces.js';
|
|
import {ShortLinkResolver} from '../shortener/google.js';
|
|
|
|
/**
|
|
* Detects if the request is from a mobile viewer
|
|
* @param req - Express request object
|
|
* @returns true if the request is from a mobile viewer
|
|
*/
|
|
export function isMobileViewer(req: Request): boolean {
|
|
return req.header('CloudFront-Is-Mobile-Viewer') === 'true';
|
|
}
|
|
|
|
/**
|
|
* Handles legacy Google URL shortener redirects
|
|
*/
|
|
export class LegacyGoogleUrlHandler {
|
|
private readonly googleShortUrlResolver: ShortLinkResolver;
|
|
|
|
/**
|
|
* Create a new handler for legacy Google URL shortcuts
|
|
* @param ceProps - Compiler Explorer properties
|
|
*/
|
|
constructor(private readonly ceProps: PropertyGetter) {
|
|
this.googleShortUrlResolver = new ShortLinkResolver();
|
|
}
|
|
|
|
/**
|
|
* Handle a request for a legacy Google short URL
|
|
* @param req - Express request object
|
|
* @param res - Express response object
|
|
* @param next - Express next function
|
|
*/
|
|
async handle(req: Request, res: Response, next: NextFunction) {
|
|
const id = req.params.id;
|
|
const googleUrl = `https://goo.gl/${encodeURIComponent(id)}`;
|
|
|
|
try {
|
|
const resultObj = await this.googleShortUrlResolver.resolve(googleUrl);
|
|
const parsed = new url.URL(resultObj.longUrl);
|
|
const allowedRe = new RegExp(this.ceProps<string>('allowedShortUrlHostRe'));
|
|
|
|
if (parsed.host.match(allowedRe) === null) {
|
|
logger.warn(`Denied access to short URL ${id} - linked to ${resultObj.longUrl}`);
|
|
return next({
|
|
statusCode: 404,
|
|
message: `ID "${id}" could not be found`,
|
|
});
|
|
}
|
|
|
|
res.writeHead(301, {
|
|
Location: resultObj.longUrl,
|
|
'Cache-Control': 'public',
|
|
});
|
|
res.end();
|
|
} catch (err: unknown) {
|
|
logger.error(`Failed to expand ${googleUrl} - ${err}`);
|
|
next({
|
|
statusCode: 404,
|
|
message: `ID "${id}" could not be found`,
|
|
});
|
|
}
|
|
}
|
|
}
|