overlookmotel / livepack / 7283582789

/* --------------------

 * livepack module

 * Code instrumentation visitor for classes

 * ------------------*/

'use strict';

// Export

module.exports = {

        ClassDeclaration,

        ClassExpression

};

// Modules

const t = require('@babel/types');

// Imports

const {

                createFunction, createAndEnterFunctionOrClassNameBlock, visitFunctionParams, visitFunctionBody,

                removeUnnecessaryUseStrictDirectives, insertTrackerComment, createTrackerCall

        } = require('./function.js'),

        {visitMethod, getMethodName} = require('./method.js'),

        Expression = require('./expression.js'),

        Statement = require('./statement.js'),

        {assertNoCommonJsVarsClash} = require('./assignee.js'),

        {getSuperVarNode} = require('./super.js'),

        {

                createBlockId, createBlock, createBlockWithId, createAndEnterBlock, createBindingWithoutNameCheck,

                createThisBinding, createArgumentsBinding, createNewTargetBinding

        } = require('../blocks.js'),

        {insertTrackerCodeIntoFunction} = require('../tracking.js'),

        {visitKey, visitKeyMaybe, visitKeyContainer} = require('../visit.js'),

        {createTempVarNode} = require('../internalVars.js'),

        {FN_TYPE_CLASS} = require('../../shared/constants.js');

// Exports

/**

 * Visitor for class declaration.

 * @param {Object} node - Class declaration AST node

 * @param {Object} state - State object

 * @param {Object|Array} parent - Parent AST node/container

 * @param {string|number} key - Node's key on parent AST node/container

 * @returns {undefined}

 */

function ClassDeclaration(node, state, parent, key) {

        // Create binding for function name in parent block

        const block = state.currentBlock,

                className = node.id.name;

        assertNoCommonJsVarsClash(block, className, state);

        // No need to check for internal var name clash here as will be checked when creating

        // the binding for class name accessed from inside class

        createBindingWithoutNameCheck(block, className, {isFrozenName: true});

        // Visit class

        visitClass(node, parent, key, className, state);

 * @param {Object} node - Class expression AST node

 * @param {Object} state - State object

 * @param {Object|Array} parent - Parent AST node/container

 * @param {string|number} key - Node's key on parent AST node/container

 * @returns {undefined}

 */

function ClassExpression(node, state, parent, key) {

        visitClass(node, parent, key, node.id ? node.id.name : undefined, state);

}

/**

 * Visit class declaration/expression.

 * Class members are visited out of order as different types of members e.g. static/prototype methods

 * are within different blocks.

 * @param {Object} classNode - Class declaration or expression AST node

 * @param {Object|Array} parent - Parent AST node/container

 * @param {string|number} key - Class node's key on parent AST node/container

 * @param {string} [className] - Class name (`undefined` if unnamed)

 * @param {Object} state - State object

 * @returns {undefined}

 * @throws {Error} - If unexpected class member node type

 */

function visitClass(classNode, parent, key, className, state) {

                parentBlock = state.currentBlock,

                parentThisBlock = state.currentThisBlock,

                parentSuperBlock = state.currentSuperBlock,

                parentSuperIsProto = state.currentSuperIsProto,

                parentIsStrict = state.isStrict,

                externalTrail = state.trail;

        // If not anonymous, create and enter block for class name accessed from within class

        let nameBlock;

        if (className) nameBlock = createAndEnterFunctionOrClassNameBlock(className, false, state);

        // Create function (but don't enter it yet)

        const fn = createFunction(createBlockId(state), classNode, true, state);

        // Create block for `super` target (but don't enter it yet).

        // `super` block is child of name block as `extends` clause and method/property

        // computed keys can access class name, but not `super`.

        // `super` block is inside class so it's considered internal to class constructor.

        const innerNameBlockId = createBlockId(state);

        // Enter strict mode

        state.isStrict = true;

        // Visit `extends` clause

        if (classNode.superClass) {

                fn.hasSuperClass = true;

                visitKey(classNode, 'superClass', Expression, state);

        }

        // Visit class body. Visited in this order:

        // 1. Class constructor

        // 2. Prototype properties

        // 3. Static properties and static blocks

        // 4. Methods

        // 5. Computed method/property keys

        // Class constructor and prototype properties are processed within class.

        // Methods, static blocks and static properties are processed as within class's parent function.

        // Computed keys are processed as within class's parent function and parent super block.

        // Split class body members into categories

        const methodIndexes = [],

                protoPropertyIndexes = [],

                staticPropertyOrBlockIndexes = [],

                computedKeys = [];

        let constructorIndex, constructorNode;

        const memberNodes = classNode.body.body;

        memberNodes.forEach((memberNode, index) => {

                const {type} = memberNode;

                if (type === 'ClassMethod') {

                        if (memberNode.kind === 'constructor') {

                                constructorIndex = index;

                                constructorNode = memberNode;

                        } else {

                                if (memberNode.computed) computedKeys.push({memberNode, index});

                                methodIndexes.push(index);

                        }

                } else if (type === 'ClassProperty') {

                        if (memberNode.computed) computedKeys.push({memberNode, index});

                        if (memberNode.static) {

                                staticPropertyOrBlockIndexes.push(index);

                        } else {

                                protoPropertyIndexes.push(index);

                        }

                } else if (type === 'ClassPrivateProperty') {

                        // TODO: Will be missed out when serializing instances of this class.

                        // Flag the class that it has private properties so serialization can throw error?

                        } else {

                                protoPropertyIndexes.push(index);

                        }

                } else if (type === 'StaticBlock') {

                        staticPropertyOrBlockIndexes.push(index);

        });

        // Enter `super` block

        state.currentBlock = state.currentSuperBlock = superBlock;

        // Create blocks for constructor params and body

        const constructorParamsBlock = createAndEnterBlock(className, false, state),

        // Visit constructor and prototype properties

        let protoThisBlock, propForTrackerNode;

        if (constructorNode || protoPropertyIndexes.length !== 0) {

                // Enter function

                state.currentFunction = fn;

                state.trail = ['body', 'body'];

                // Visit constructor

                if (constructorNode) {

                        visitKey(

                                memberNodes, constructorIndex,

                                () => visitClassConstructor(

                                        constructorNode, fn, constructorParamsBlock, constructorBodyBlock, state

                                ),

                                state

                        );

                }

                // Visit prototype properties

                if (protoPropertyIndexes.length !== 0) {

                        // TODO: This should be a vars block and all prototype methods should be wrapped

                        // in closures. See https://github.com/overlookmotel/livepack/issues/305

                        state.currentBlock = superBlock;

                        protoThisBlock = createAndEnterBlock(className, false, state);

                        createThisBinding(protoThisBlock);

                        createNewTargetBinding(protoThisBlock);

                        state.currentThisBlock = protoThisBlock;

                        for (const index of protoPropertyIndexes) {

                                visitKey(memberNodes, index, ClassPropertyMaybePrivate, state);

                        }

                        // If class does not extend a super class, prototype properties will be evaluated

                        if (!classNode.superClass) propForTrackerNode = memberNodes[protoPropertyIndexes[0]];

                }

                // Exit function

                state.currentFunction = parentFunction;

                state.trail = externalTrail;

        }

        // Enter class body container (applies to methods, computed keys, static properties, static blocks)

        externalTrail.push('body', 'body');

        // Visit static properties and static blocks

        if (staticPropertyOrBlockIndexes.length !== 0) {

                // Create and enter block for `this` in the context of static properties

                state.currentBlock = superBlock;

                const staticThisBlock = createAndEnterBlock(className, false, state);

                createThisBinding(staticThisBlock);

                createNewTargetBinding(staticThisBlock);

                state.currentThisBlock = staticThisBlock;

                state.currentSuperIsProto = false;

                for (const index of staticPropertyOrBlockIndexes) {

                        visitKey(memberNodes, index, ClassStaticPropertyOrBlock, state);

                }

        }

                // NB: `state.currentThisBlock` is not relevant for methods as they create their own `this` block.

                // `ClassMethodMaybePrivate` visitor sets `state.currentSuperIsProto` for each method.

                for (const index of methodIndexes) {

                        visitKey(memberNodes, index, ClassMethodMaybePrivate, state);

                }

        }

        // Exit `super` and `this` blocks

        state.currentThisBlock = parentThisBlock;

        state.currentSuperBlock = parentSuperBlock;

        state.currentSuperIsProto = parentSuperIsProto;

        // Visit computed keys

        // TODO: Pass values of computed prototype property keys to serializer so it can recreate them

        if (computedKeys.length !== 0) {

                state.currentBlock = nameBlock || parentBlock;

                for (const {memberNode, index} of computedKeys) {

                        externalTrail.push(index, 'key');

                        Expression(memberNode.key, state, memberNode, 'key');

                        externalTrail.length -= 2;

                }

        }

        // Serialize class AST

        fn.astJson = serializeClassAst(classNode, constructorNode, constructorIndex);

        // If constructor or a prototype property contains `eval()`, make class name internal to class.

        // Achieved by inserting an extra block between `super` block and constructor params

        // + prototype `this` blocks. This block has a binding for class name added to it.

        if (className && fn.containsEval) {

                state.currentBlock = superBlock;

                const innerNameBlock = createBlockWithId(innerNameBlockId, className, false, state);

                constructorParamsBlock.parent = innerNameBlock;

                innerNameBlock.bindings.set(className, nameBlock.bindings.get(className));

        }

        // Exit class body

        state.currentBlock = parentBlock;

        externalTrail.length -= 2;

        if (!parentIsStrict) state.isStrict = false;

        // Temporarily remove from AST so is not included in parent function's serialized AST

        parent[key] = null;

        // Queue instrumentation of class in 2nd pass

        state.secondPass(

                instrumentClass,

                classNode, fn, parent, key, constructorNode, propForTrackerNode,

                constructorParamsBlock, constructorBodyBlock, superBlock, state

        );

}

/**

 * Visit class constructor.

 * @param {Object} node - Class constructor AST node

 * @param {Object} fn - Function object

 * @param {Object} paramsBlock - Constructor params block object

 * @param {Object} bodyBlock - Constructor body block object

 * @param {Object} state - State object

 * @returns {undefined}

 */

function visitClassConstructor(node, fn, paramsBlock, bodyBlock, state) {

        // NB: No need to check for existence of param called `arguments`,

        // as this is illegal in strict mode, and classes are always strict

        createThisBinding(paramsBlock);

        createArgumentsBinding(paramsBlock, true, []);

        createNewTargetBinding(paramsBlock);

        state.currentThisBlock = paramsBlock;

        // Visit constructor

        visitFunctionBody(node, bodyBlock, state);

}

 * @param {Object} state - State object

 * @param {Array} parent - Class body container

 * @param {number} key - Method node's index on class body container

 * @returns {undefined}

 */

function ClassMethodMaybePrivate(node, state, parent, key) {

        // Get method name

        let keyIsComputed, fnName;

        } else {

                keyIsComputed = node.computed;

        }

        // Set whether `super` is prototype `super`.

        // No need to reset after as will be set again by next method.

        state.currentSuperIsProto = !node.static;

        // Don't visit `key` as has been dealt with separately above

        visitMethod(node, parent, key, fnName, true, false, keyIsComputed, state);

}

/**

 * Visitor for class static property or static block.

 * @param {Object} state - State object

 * @returns {undefined}

 */

function ClassStaticPropertyOrBlock(node, state) {

        if (node.type === 'StaticBlock') {

                StaticBlock(node, state);

        } else {

                ClassPropertyMaybePrivate(node, state);

        }

}

/**

 * Visitor for class property or class private property.

 * Can be prototype or static property.

 * @param {Object} node - Class property or private property AST node

 * @param {Object} state - State object

 * @returns {undefined}

 */

function ClassPropertyMaybePrivate(node, state) {

        // Don't visit `key` as has been dealt with separately above

        visitKeyMaybe(node, 'value', Expression, state);

}

/**

 * Visitor for class static block.

 * @param {Object} node - Class static block AST node

 * @param {Object} state - State object

 * @returns {undefined}

 */

function StaticBlock(node, state) {

        // `var` declarations in a static block are hoisted to top level within the static block

                parentHoistBlock = state.currentHoistBlock;

        state.currentHoistBlock = createAndEnterBlock('staticBlock', false, state);

        visitKeyContainer(node, 'body', Statement, state);

        state.currentBlock = parentBlock;

        state.currentHoistBlock = parentHoistBlock;

}

/**

 * Serialize class AST to JSON.

 * Remove 'use strict' directives from constructor if present.

 * Do not mutate the node passed in, to ensure these changes only affect the serialized AST,

 * and not the instrumented output.

 * @param {Object} classNode - Class AST node

 * @param {Object} [constructorNode] - Class constructor AST node if present

 * @param {number} [constructorIndex] - Index if class constructor if present

 * @returns {string} - Function AST as JSON

 */

function serializeClassAst(classNode, constructorNode, constructorIndex) {

        // Remove 'use strict' directives in constructor

        if (constructorNode) {

                const alteredConstructorNode = removeUnnecessaryUseStrictDirectives(constructorNode, true);

                        const classBodyNode = classNode.body,

                                memberNodes = [...classBodyNode.body];

                        memberNodes[constructorIndex] = alteredConstructorNode;

                        classNode = {...classNode, body: {...classBodyNode, body: memberNodes}};

                }

        }

        return JSON.stringify(classNode);

}

/**

 * Instrument class.

 * @param {Object} classNode - Class declaration or expression AST node

 * @param {Object} fn - Function object for class

 * @param {Object|Array} parent - Parent AST node/container

 * @param {string|number} key - Node's key on parent AST node/container

 * @param {Object} [constructorNode] - Class constructor AST node (or `undefined` if no constructor)

 * @param {Object} [propForTrackerNode] - Property node to insert tracker in

 * @param {Object} constructorParamsBlock - Constructor params block object

 * @param {Object} constructorBodyBlock - Constructor body block object

 * @param {Object} superBlock - `super` target block object

 * @param {Object} state - State object

function instrumentClass(

        classNode, fn, parent, key, constructorNode, propForTrackerNode,

        constructorParamsBlock, constructorBodyBlock, superBlock, state

) {

        // Create tracker

        let trackerNode = createTrackerCall(fn, state);

        if (propForTrackerNode) {

                // Insert tracker into prototype property

                propForTrackerNode.value = propForTrackerNode.value

                        ? t.sequenceExpression([trackerNode, propForTrackerNode.value])

                        : t.unaryExpression('void', trackerNode);

                trackerNode = undefined;

        } else if (!constructorNode) {

                // Class has no constructor - create one for tracker code to be inserted in

                constructorNode = createClassConstructor(fn, state);

                classNode.body.body.push(constructorNode);

        }

        // Add tracker code + block vars to constructor

        if (constructorNode) {

                insertTrackerCodeIntoFunction(

                        fn, constructorNode, constructorParamsBlock, constructorBodyBlock, trackerNode, state

                );

        }

        // Insert `static {}` block to define temp var for `super` target if `super` used in class

        const superVarNode = getSuperVarNode(superBlock);

        if (superVarNode) {

                classNode.body.body.unshift(

                        t.staticBlock([

                                t.expressionStatement(t.assignmentExpression('=', superVarNode, t.thisExpression()))

                        ])

                );

        }

        // Restore to original place in AST

        parent[key] = classNode;

        // Insert tracking comment

        const commentHolderNode = classNode.id || classNode.superClass || classNode.body;

        insertTrackerComment(fn.id, FN_TYPE_CLASS, commentHolderNode, 'leading', state);

        // TODO: Handle prototype properties

}

/**

 * Create empty class constructor node.

 * It will be instrumented by `instrumentClass()`, same as a real constructor.

 * @param {Object} fn - Function object for class

 * @param {Object} state - State object

 * @returns {Object} - Class constructor AST node

 */

function createClassConstructor(fn, state) {

        // If extends a super class: `constructor(...livepack_temp_4) { super(...livepack_temp_4); }`

        // Otherwise: `constructor() {}`

        let paramNodes, bodyNode;

        if (fn.hasSuperClass) {

                const argsVarNode = createTempVarNode(state);

                paramNodes = [t.restElement(argsVarNode)];

                bodyNode = t.blockStatement([

                        t.expressionStatement(t.callExpression(t.super(), [t.spreadElement(argsVarNode)]))

                paramNodes = [];

                bodyNode = t.blockStatement([]);

        }

        return t.classMethod('constructor', t.identifier('constructor'), paramNodes, bodyNode);

}