mirror of
https://github.com/compiler-explorer/compiler-explorer.git
synced 2025-12-27 07:04:04 -05:00
03d20c5fde
## Summary Moves `static/assert.ts` and `static/rison.ts` to `shared/` directory to make them available to both frontend and backend code without browser dependencies. Updates all import paths across the codebase (~47 files). ## Motivation This refactoring eliminates browser dependencies in these utilities, allowing them to be imported by Node.js contexts (like Cypress test files) without causing module load failures. This is a prerequisite for upcoming Cypress test improvements. ## Changes - Move `static/assert.ts` → `shared/assert.ts` - Move `static/rison.ts` → `shared/rison.ts` - Update `biome.json` to allow `hasOwnProperty` in `shared/` directory - Update all imports across `static/`, `lib/`, and `test/` directories (47 files changed) ## Benefits - No functional changes, purely a code reorganization - Makes these utilities accessible to both frontend and backend without circular dependencies - Enables future Cypress improvements that require these utilities in Node.js context - All tests pass ✓ (699 tests) ## Test Plan - [x] TypeScript compilation passes - [x] Linting passes - [x] All unit tests pass (699 tests) - [x] Pre-commit hooks pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude <noreply@anthropic.com>
91 lines
3.4 KiB
TypeScript
91 lines
3.4 KiB
TypeScript
// Copyright (c) 2022, 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 {isString} from '../shared/common-utils.js';
|
|
import {parse} from '../shared/stacktrace.js';
|
|
|
|
// This file defines three assert utilities:
|
|
// assert(condition, message?, extra_info...?): asserts condition
|
|
// unwrap(x: T | undefined | null, message?, extra_info...?): T
|
|
// assert_type(x, class, message?, extra_info...?)
|
|
|
|
function get_diagnostic() {
|
|
const e = new Error();
|
|
const trace = parse(e);
|
|
if (trace.length >= 4) {
|
|
const invoker_frame = trace[3];
|
|
if (invoker_frame.fileName && invoker_frame.lineNumber) {
|
|
return {
|
|
file: invoker_frame.fileName,
|
|
line: invoker_frame.lineNumber,
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
function fail(fail_message: string, user_message: string | undefined, args: any[]): never {
|
|
// Assertions will look like:
|
|
// Assertion failed
|
|
// Assertion failed: Foobar
|
|
// Assertion failed: Foobar, [{"foo": "bar"}]
|
|
let assert_line = fail_message;
|
|
if (user_message) {
|
|
assert_line += `: ${user_message}`;
|
|
}
|
|
if (args.length > 0) {
|
|
try {
|
|
assert_line += ', ' + JSON.stringify(args);
|
|
} catch {}
|
|
}
|
|
|
|
const diagnostic = get_diagnostic();
|
|
if (diagnostic) {
|
|
throw new Error(assert_line + `, at ${diagnostic.file}:${diagnostic.line}`);
|
|
}
|
|
throw new Error(assert_line);
|
|
}
|
|
|
|
export function assert(c: unknown, message?: string, ...extra_info: any[]): asserts c {
|
|
if (!c) {
|
|
fail('Assertion failed', message, extra_info);
|
|
}
|
|
}
|
|
|
|
export function unwrap<T>(x: T | undefined | null, message?: string, ...extra_info: any[]): T {
|
|
if (x === undefined || x === null) {
|
|
fail('Unwrap failed', message, extra_info);
|
|
}
|
|
return x;
|
|
}
|
|
|
|
// This mainly a utility for JQuery.val(): string | number | string[] | undefined, in our code we typically want a
|
|
// single string.
|
|
// T is syntax sugar for unwrapping to a string union
|
|
export function unwrapString<T extends string>(x: any, message?: string, ...extra_info: any[]): T {
|
|
if (!isString(x)) {
|
|
fail('String unwrap failed', message, extra_info);
|
|
}
|
|
return x as T;
|
|
}
|