refactor(javascript): group domain semantics and contracts (#907)
This commit is contained in:
@@ -0,0 +1,160 @@
|
||||
import * as t from "@babel/types";
|
||||
|
||||
import { compareCodePoints } from "../canonicalOrdering.js";
|
||||
import type { ElectronStaticValue } from "./electronStaticAnalysisTypes.js";
|
||||
import { semanticStaticPropertyName } from "./javascriptAstValues.js";
|
||||
import { sourceSlice } from "./javascriptStaticAnalysisHelpers.js";
|
||||
|
||||
/** Preserve one literal value or the exact inert expression. */
|
||||
export const electronStaticValue = (
|
||||
source: string,
|
||||
node: t.Node | null | undefined,
|
||||
): ElectronStaticValue => {
|
||||
const literal = literalValue(node);
|
||||
return literal.found
|
||||
? { status: "literal", value: literal.value, expression: null }
|
||||
: {
|
||||
status: "dynamic",
|
||||
value: null,
|
||||
expression: boundedExpression(source, node),
|
||||
};
|
||||
};
|
||||
|
||||
/** Return an actionable expression without evaluating it. */
|
||||
export const boundedExpression = (
|
||||
source: string,
|
||||
node: t.Node | null | undefined,
|
||||
): string => {
|
||||
if (node === null || node === undefined) return "[missing-expression]";
|
||||
const expression = sourceSlice(source, node).trim();
|
||||
return expression === "" ? `[${node.type}]` : expression;
|
||||
};
|
||||
|
||||
/** Find the effective explicit property, preserving unresolved overrides. */
|
||||
export const objectProperty = (
|
||||
object: t.Node | undefined,
|
||||
name: string,
|
||||
):
|
||||
| { readonly status: "missing" | "dynamic" }
|
||||
| { readonly status: "explicit"; readonly property: t.ObjectProperty } => {
|
||||
if (object === undefined) return { status: "missing" };
|
||||
if (!t.isObjectExpression(object)) return { status: "dynamic" };
|
||||
for (const property of object.properties.toReversed()) {
|
||||
if (t.isSpreadElement(property)) return { status: "dynamic" };
|
||||
const key = semanticStaticPropertyName(property.key, property.computed);
|
||||
if (key === "" && !t.isStringLiteral(property.key))
|
||||
return { status: "dynamic" };
|
||||
if (key !== name) continue;
|
||||
return t.isObjectProperty(property)
|
||||
? { status: "explicit", property }
|
||||
: { status: "dynamic" };
|
||||
}
|
||||
return { status: "missing" };
|
||||
};
|
||||
|
||||
type PresentHandlerKind =
|
||||
| "inline-function"
|
||||
| "identifier"
|
||||
| "member-expression"
|
||||
| "dynamic-expression";
|
||||
|
||||
/** Classify a handler argument while retaining its exact source range. */
|
||||
export function handlerKind(node: t.Node): PresentHandlerKind;
|
||||
export function handlerKind(node: null | undefined): "missing";
|
||||
export function handlerKind(
|
||||
node: t.Node | null | undefined,
|
||||
): PresentHandlerKind | "missing" {
|
||||
if (node === null || node === undefined) return "missing";
|
||||
if (
|
||||
t.isArrowFunctionExpression(node) ||
|
||||
t.isFunctionExpression(node) ||
|
||||
t.isFunctionDeclaration(node)
|
||||
)
|
||||
return "inline-function";
|
||||
if (t.isIdentifier(node)) return "identifier";
|
||||
if (t.isMemberExpression(node) || t.isOptionalMemberExpression(node))
|
||||
return "member-expression";
|
||||
return "dynamic-expression";
|
||||
}
|
||||
|
||||
/** Collect statically visible dotted keys from one literal contextBridge API object. */
|
||||
export const collectContextBridgeMembers = (
|
||||
node: t.Node | null | undefined,
|
||||
): {
|
||||
readonly status: "object-literal" | "dynamic" | "missing";
|
||||
readonly members: readonly string[];
|
||||
readonly unknown: number;
|
||||
} => {
|
||||
if (node === null || node === undefined)
|
||||
return {
|
||||
status: "missing",
|
||||
members: [],
|
||||
unknown: 0,
|
||||
};
|
||||
if (!t.isObjectExpression(node))
|
||||
return {
|
||||
status: "dynamic",
|
||||
members: [],
|
||||
unknown: 1,
|
||||
};
|
||||
const state: { members: string[]; unknown: number } = {
|
||||
members: [],
|
||||
unknown: 0,
|
||||
};
|
||||
collectMembersAt(node, "", 0, state);
|
||||
const members = [...new Set(state.members)].sort(compareCodePoints);
|
||||
return {
|
||||
status: "object-literal",
|
||||
members,
|
||||
unknown: state.unknown,
|
||||
};
|
||||
};
|
||||
|
||||
const collectMembersAt = (
|
||||
object: t.ObjectExpression,
|
||||
prefix: string,
|
||||
depth: number,
|
||||
state: { members: string[]; unknown: number },
|
||||
): void => {
|
||||
if (depth >= 8) {
|
||||
state.unknown += 1;
|
||||
return;
|
||||
}
|
||||
for (const property of object.properties) {
|
||||
if (t.isSpreadElement(property)) {
|
||||
state.unknown += 1;
|
||||
continue;
|
||||
}
|
||||
const name = semanticStaticPropertyName(property.key, property.computed);
|
||||
if (name === "" || property.computed) {
|
||||
state.unknown += 1;
|
||||
continue;
|
||||
}
|
||||
const path = prefix === "" ? name : `${prefix}.${name}`;
|
||||
state.members.push(path);
|
||||
if (t.isObjectProperty(property) && t.isObjectExpression(property.value))
|
||||
collectMembersAt(property.value, path, depth + 1, state);
|
||||
}
|
||||
};
|
||||
|
||||
const literalValue = (
|
||||
node: t.Node | null | undefined,
|
||||
):
|
||||
| { readonly found: true; readonly value: string | number | boolean | null }
|
||||
| { readonly found: false } => {
|
||||
if (t.isStringLiteral(node) || t.isNumericLiteral(node))
|
||||
return { found: true, value: node.value };
|
||||
if (t.isBooleanLiteral(node)) return { found: true, value: node.value };
|
||||
if (t.isNullLiteral(node)) return { found: true, value: null };
|
||||
if (t.isTemplateLiteral(node) && node.expressions.length === 0)
|
||||
return {
|
||||
found: true,
|
||||
value: node.quasis[0]?.value.cooked ?? node.quasis[0]?.value.raw ?? "",
|
||||
};
|
||||
if (
|
||||
t.isUnaryExpression(node, { operator: "-" }) &&
|
||||
t.isNumericLiteral(node.argument)
|
||||
)
|
||||
return { found: true, value: -node.argument.value };
|
||||
return { found: false };
|
||||
};
|
||||
Reference in New Issue
Block a user