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.
85 lines
3.7 KiB
TypeScript
85 lines
3.7 KiB
TypeScript
// Copyright (c) 2016, 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 './utils.js';
|
|
import {beforeAll, describe, expect, it} from 'vitest';
|
|
|
|
import {CompilationEnvironment} from '../lib/compilation-env.js';
|
|
import {CompilationQueue} from '../lib/compilation-queue.js';
|
|
import {FormattingService} from '../lib/formatting-service.js';
|
|
import {CompilerProps, fakeProps} from '../lib/properties.js';
|
|
|
|
const props = {
|
|
optionsAllowedRe: '.*',
|
|
optionsForbiddenRe: '^(-W[alp],)?((-wrapper|-fplugin.*|-specs|-load|-plugin|(@.*)|-I|-i)(=.*)?|--)$',
|
|
cacheConfig: 'InMemory(10)',
|
|
};
|
|
|
|
describe('Compilation environment', () => {
|
|
let compilerProps: CompilerProps;
|
|
let compilationQueue: CompilationQueue;
|
|
|
|
beforeAll(() => {
|
|
compilerProps = new CompilerProps({}, fakeProps(props));
|
|
compilationQueue = new CompilationQueue(1, 1000, 1000);
|
|
});
|
|
|
|
it('Should cache by default', async () => {
|
|
const ce = new CompilationEnvironment(compilerProps, fakeProps({}), compilationQueue, new FormattingService());
|
|
await expect(ce.cacheGet('foo')).resolves.toBeNull();
|
|
await ce.cachePut('foo', {res: 'bar'}, undefined);
|
|
await expect(ce.cacheGet('foo')).resolves.toEqual({res: 'bar'});
|
|
await expect(ce.cacheGet('baz')).resolves.toBeNull();
|
|
});
|
|
it('Should cache when asked', async () => {
|
|
const ce = new CompilationEnvironment(
|
|
compilerProps,
|
|
fakeProps({}),
|
|
compilationQueue,
|
|
new FormattingService(),
|
|
true,
|
|
);
|
|
await expect(ce.cacheGet('foo')).resolves.toBeNull();
|
|
await ce.cachePut('foo', {res: 'bar'}, undefined);
|
|
await expect(ce.cacheGet('foo')).resolves.toEqual({res: 'bar'});
|
|
});
|
|
it("Shouldn't cache when asked", async () => {
|
|
const ce = new CompilationEnvironment(
|
|
compilerProps,
|
|
fakeProps({}),
|
|
compilationQueue,
|
|
new FormattingService(),
|
|
false,
|
|
);
|
|
await expect(ce.cacheGet('foo')).resolves.toBeNull();
|
|
await ce.cachePut('foo', {res: 'bar'}, undefined);
|
|
await expect(ce.cacheGet('foo')).resolves.toBeNull();
|
|
});
|
|
it('Should filter bad options', () => {
|
|
const ce = new CompilationEnvironment(compilerProps, fakeProps({}), compilationQueue, new FormattingService());
|
|
expect(ce.findBadOptions(['-O3', '-flto'])).toEqual([]);
|
|
expect(ce.findBadOptions(['-O3', '-plugin'])).toEqual(['-plugin']);
|
|
});
|
|
});
|