Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Track mutations of elements pushed into arrays #5352

Merged
merged 3 commits into from
Jan 21, 2024
Merged

Track mutations of elements pushed into arrays #5352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d9ec9a
Add test for dependency deoptimization
lukastaegert Jan 20, 2024
bc0e8d4
Deoptimize elements pushed into an array
lukastaegert Jan 20, 2024
d2ddd5d
Copy rollup types in tests to avoid temporary type issues
lukastaegert Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rollup.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export default async function (
addCliEntry(),
esmDynamicImport(),
!command.configTest && collectLicenses(),
!command.configTest && copyNodeTypes()
copyNodeTypes()
],
strictDeprecations: true,
treeshake
Expand Down
17 changes: 14 additions & 3 deletions src/ast/nodes/shared/ArrayPrototype.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const NEW_ARRAY_PROPERTIES: ObjectProperty[] = [
const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_BOOLEAN: [ExpressionEntity] = [
new Method({
callsArgs: [0],
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_BOOLEAN
Expand All @@ -28,6 +29,7 @@ const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_BOOLEAN: [ExpressionEntity] = [
const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_NUMBER: [ExpressionEntity] = [
new Method({
callsArgs: [0],
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_NUMBER
Expand All @@ -37,6 +39,7 @@ const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_NUMBER: [ExpressionEntity] = [
const METHOD_MUTATES_SELF_RETURNS_NEW_ARRAY: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: true,
returns: () => new ObjectEntity(NEW_ARRAY_PROPERTIES, ARRAY_PROTOTYPE),
returnsPrimitive: null
Expand All @@ -46,6 +49,7 @@ const METHOD_MUTATES_SELF_RETURNS_NEW_ARRAY: [ExpressionEntity] = [
const METHOD_DEOPTS_SELF_RETURNS_NEW_ARRAY: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: () => new ObjectEntity(NEW_ARRAY_PROPERTIES, ARRAY_PROTOTYPE),
returnsPrimitive: null
Expand All @@ -55,15 +59,17 @@ const METHOD_DEOPTS_SELF_RETURNS_NEW_ARRAY: [ExpressionEntity] = [
const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_NEW_ARRAY: [ExpressionEntity] = [
new Method({
callsArgs: [0],
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: () => new ObjectEntity(NEW_ARRAY_PROPERTIES, ARRAY_PROTOTYPE),
returnsPrimitive: null
})
];

const METHOD_MUTATES_SELF_RETURNS_NUMBER: [ExpressionEntity] = [
const METHOD_MUTATES_SELF_AND_ARGS_RETURNS_NUMBER: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: true,
mutatesSelfAsArray: true,
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_NUMBER
Expand All @@ -73,6 +79,7 @@ const METHOD_MUTATES_SELF_RETURNS_NUMBER: [ExpressionEntity] = [
const METHOD_MUTATES_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: true,
returns: null,
returnsPrimitive: UNKNOWN_EXPRESSION
Expand All @@ -82,6 +89,7 @@ const METHOD_MUTATES_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
const METHOD_DEOPTS_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: null,
returnsPrimitive: UNKNOWN_EXPRESSION
Expand All @@ -91,6 +99,7 @@ const METHOD_DEOPTS_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
new Method({
callsArgs: [0],
mutatesArgs: false,
mutatesSelfAsArray: 'deopt-only',
returns: null,
returnsPrimitive: UNKNOWN_EXPRESSION
Expand All @@ -100,6 +109,7 @@ const METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_UNKNOWN: [ExpressionEntity] = [
const METHOD_MUTATES_SELF_RETURNS_SELF: [ExpressionEntity] = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: true,
returns: 'self',
returnsPrimitive: null
Expand All @@ -109,6 +119,7 @@ const METHOD_MUTATES_SELF_RETURNS_SELF: [ExpressionEntity] = [
const METHOD_CALLS_ARG_MUTATES_SELF_RETURNS_SELF: [ExpressionEntity] = [
new Method({
callsArgs: [0],
mutatesArgs: false,
mutatesSelfAsArray: true,
returns: 'self',
returnsPrimitive: null
Expand Down Expand Up @@ -140,7 +151,7 @@ export const ARRAY_PROTOTYPE = new ObjectEntity(
lastIndexOf: METHOD_RETURNS_NUMBER,
map: METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_NEW_ARRAY,
pop: METHOD_MUTATES_SELF_RETURNS_UNKNOWN,
push: METHOD_MUTATES_SELF_RETURNS_NUMBER,
push: METHOD_MUTATES_SELF_AND_ARGS_RETURNS_NUMBER,
reduce: METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_UNKNOWN,
reduceRight: METHOD_CALLS_ARG_DEOPTS_SELF_RETURNS_UNKNOWN,
reverse: METHOD_MUTATES_SELF_RETURNS_SELF,
Expand All @@ -151,7 +162,7 @@ export const ARRAY_PROTOTYPE = new ObjectEntity(
splice: METHOD_MUTATES_SELF_RETURNS_NEW_ARRAY,
toLocaleString: METHOD_RETURNS_STRING,
toString: METHOD_RETURNS_STRING,
unshift: METHOD_MUTATES_SELF_RETURNS_NUMBER,
unshift: METHOD_MUTATES_SELF_AND_ARGS_RETURNS_NUMBER,
values: METHOD_DEOPTS_SELF_RETURNS_UNKNOWN
} as unknown as PropertyMap,
OBJECT_PROTOTYPE,
Expand Down
23 changes: 20 additions & 3 deletions src/ast/nodes/shared/MethodTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ import {
NODE_INTERACTION_UNKNOWN_ASSIGNMENT,
NODE_INTERACTION_UNKNOWN_CALL
} from '../../NodeInteractions';
import { EMPTY_PATH, type ObjectPath, UNKNOWN_INTEGER_PATH } from '../../utils/PathTracker';
import {
EMPTY_PATH,
type ObjectPath,
UNKNOWN_INTEGER_PATH,
UNKNOWN_PATH
} from '../../utils/PathTracker';
import {
UNKNOWN_LITERAL_BOOLEAN,
UNKNOWN_LITERAL_NUMBER,
Expand All @@ -17,6 +22,7 @@ import { ExpressionEntity, UNKNOWN_EXPRESSION, UNKNOWN_RETURN_EXPRESSION } from
type MethodDescription = {
callsArgs: number[] | null;
mutatesSelfAsArray: boolean | 'deopt-only';
mutatesArgs: boolean;
} & (
| {
returns: 'self' | (() => ExpressionEntity);
Expand All @@ -34,8 +40,15 @@ export class Method extends ExpressionEntity {
}

deoptimizeArgumentsOnInteractionAtPath({ args, type }: NodeInteraction, path: ObjectPath): void {
if (type === INTERACTION_CALLED && path.length === 0 && this.description.mutatesSelfAsArray) {
args[0]?.deoptimizePath(UNKNOWN_INTEGER_PATH);
if (type === INTERACTION_CALLED && path.length === 0) {
if (this.description.mutatesSelfAsArray) {
args[0]?.deoptimizePath(UNKNOWN_INTEGER_PATH);
}
if (this.description.mutatesArgs) {
for (let index = 1; index < args.length; index++) {
args[index]!.deoptimizePath(UNKNOWN_PATH);
}
}
}
}

Expand Down Expand Up @@ -97,6 +110,7 @@ export class Method extends ExpressionEntity {
export const METHOD_RETURNS_BOOLEAN = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: false,
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_BOOLEAN
Expand All @@ -106,6 +120,7 @@ export const METHOD_RETURNS_BOOLEAN = [
export const METHOD_RETURNS_STRING = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: false,
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_STRING
Expand All @@ -115,6 +130,7 @@ export const METHOD_RETURNS_STRING = [
export const METHOD_RETURNS_NUMBER = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: false,
returns: null,
returnsPrimitive: UNKNOWN_LITERAL_NUMBER
Expand All @@ -124,6 +140,7 @@ export const METHOD_RETURNS_NUMBER = [
export const METHOD_RETURNS_UNKNOWN = [
new Method({
callsArgs: null,
mutatesArgs: false,
mutatesSelfAsArray: false,
returns: null,
returnsPrimitive: UNKNOWN_EXPRESSION
Expand Down
3 changes: 3 additions & 0 deletions test/function/samples/deoptimize-pushed-array-element/_config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = defineTest({
description: 'deoptimizes elements pushed into an array'
});
21 changes: 21 additions & 0 deletions test/function/samples/deoptimize-pushed-array-element/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
let mutated1 = false;
const state1 = {
foo: undefined
};

let mutated2 = false;
const state2 = {
foo: undefined
};

const stack = [];
stack.push(state1, state2);
stack[0].foo = () => (mutated1 = true);
stack.at(-1).foo = () => (mutated2 = true);

state1.foo?.();
assert.ok(mutated1, '1');

state2.foo?.();
assert.ok(mutated2, '2');