// @flow import type { HubInterface, NodePath } from "@babel/traverse"; import traverse from "@babel/traverse"; import memberExpressionToFunctions from "@babel/helper-member-expression-to-functions"; import optimiseCall from "@babel/helper-optimise-call-expression"; import * as t from "@babel/types"; /** * Creates an expression which result is the proto of objectRef. * * @example isStatic === true * * helpers.getPrototypeOf(CLASS) * * @example isStatic === false * * helpers.getPrototypeOf(CLASS.prototype) */ function getPrototypeOfExpression(objectRef, isStatic, file, isPrivateMethod) { objectRef = t.cloneNode(objectRef); const targetRef = isStatic || isPrivateMethod ? objectRef : t.memberExpression(objectRef, t.identifier("prototype")); return t.callExpression(file.addHelper("getPrototypeOf"), [targetRef]); } export function skipAllButComputedKey(path: NodePath) { // If the path isn't computed, just skip everything. if (!path.node.computed) { path.skip(); return; } // So it's got a computed key. Make sure to skip every other key the // traversal would visit. const keys = t.VISITOR_KEYS[path.type]; for (const key of keys) { if (key !== "key") path.skipKey(key); } } // environmentVisitor should be used when traversing the whole class and not for specific class elements/methods. export const environmentVisitor = { TypeAnnotation(path: NodePath) { path.skip(); }, Function(path: NodePath) { // Methods will be handled by the Method visit if (path.isMethod()) return; // Arrow functions inherit their parent's environment if (path.isArrowFunctionExpression()) return; path.skip(); }, "Method|ClassProperty|ClassPrivateProperty"(path: NodePath) { skipAllButComputedKey(path); }, }; const visitor = traverse.visitors.merge([ environmentVisitor, { Super(path, state) { const { node, parentPath } = path; if (!parentPath.isMemberExpression({ object: node })) return; state.handle(parentPath); }, }, ]); const specHandlers = { memoise(superMember, count) { const { scope, node } = superMember; const { computed, property } = node; if (!computed) { return; } const memo = scope.maybeGenerateMemoised(property); if (!memo) { return; } this.memoiser.set(property, memo, count); }, prop(superMember) { const { computed, property } = superMember.node; if (this.memoiser.has(property)) { return t.cloneNode(this.memoiser.get(property)); } if (computed) { return t.cloneNode(property); } return t.stringLiteral(property.name); }, get(superMember) { return this._get(superMember, this._getThisRefs()); }, _get(superMember, thisRefs) { const proto = getPrototypeOfExpression( this.getObjectRef(), this.isStatic, this.file, this.isPrivateMethod, ); return t.callExpression(this.file.addHelper("get"), [ thisRefs.memo ? t.sequenceExpression([thisRefs.memo, proto]) : proto, this.prop(superMember), thisRefs.this, ]); }, _getThisRefs() { if (!this.isDerivedConstructor) { return { this: t.thisExpression() }; } const thisRef = this.scope.generateDeclaredUidIdentifier("thisSuper"); return { memo: t.assignmentExpression("=", thisRef, t.thisExpression()), this: t.cloneNode(thisRef), }; }, set(superMember, value) { const thisRefs = this._getThisRefs(); const proto = getPrototypeOfExpression( this.getObjectRef(), this.isStatic, this.file, this.isPrivateMethod, ); return t.callExpression(this.file.addHelper("set"), [ thisRefs.memo ? t.sequenceExpression([thisRefs.memo, proto]) : proto, this.prop(superMember), value, thisRefs.this, t.booleanLiteral(superMember.isInStrictMode()), ]); }, destructureSet(superMember) { throw superMember.buildCodeFrameError( `Destructuring to a super field is not supported yet.`, ); }, call(superMember, args) { const thisRefs = this._getThisRefs(); return optimiseCall( this._get(superMember, thisRefs), t.cloneNode(thisRefs.this), args, false, ); }, }; const looseHandlers = { ...specHandlers, prop(superMember) { const { property } = superMember.node; if (this.memoiser.has(property)) { return t.cloneNode(this.memoiser.get(property)); } return t.cloneNode(property); }, get(superMember) { const { isStatic, superRef } = this; const { computed } = superMember.node; const prop = this.prop(superMember); let object; if (isStatic) { object = superRef ? t.cloneNode(superRef) : t.memberExpression( t.identifier("Function"), t.identifier("prototype"), ); } else { object = superRef ? t.memberExpression(t.cloneNode(superRef), t.identifier("prototype")) : t.memberExpression(t.identifier("Object"), t.identifier("prototype")); } return t.memberExpression(object, prop, computed); }, set(superMember, value) { const { computed } = superMember.node; const prop = this.prop(superMember); return t.assignmentExpression( "=", t.memberExpression(t.thisExpression(), prop, computed), value, ); }, destructureSet(superMember) { const { computed } = superMember.node; const prop = this.prop(superMember); return t.memberExpression(t.thisExpression(), prop, computed); }, call(superMember, args) { return optimiseCall(this.get(superMember), t.thisExpression(), args, false); }, }; type ReplaceSupersOptionsBase = {| methodPath: NodePath, superRef: Object, isLoose: boolean, file: any, |}; type ReplaceSupersOptions = | {| ...ReplaceSupersOptionsBase, getObjectRef: () => BabelNode, |} | {| ...ReplaceSupersOptionsBase, objectRef: BabelNode, |}; export default class ReplaceSupers { constructor(opts: ReplaceSupersOptions) { const path = opts.methodPath; this.methodPath = path; this.isDerivedConstructor = path.isClassMethod({ kind: "constructor" }) && !!opts.superRef; this.isStatic = path.isObjectMethod() || path.node.static; this.isPrivateMethod = path.isPrivate() && path.isMethod(); this.file = opts.file; this.superRef = opts.superRef; this.isLoose = opts.isLoose; this.opts = opts; } file: HubInterface; isDerivedConstructor: boolean; isLoose: boolean; isPrivateMethod: boolean; isStatic: boolean; methodPath: NodePath; opts: ReplaceSupersOptions; superRef: Object; getObjectRef() { return t.cloneNode(this.opts.objectRef || this.opts.getObjectRef()); } replace() { const handler = this.isLoose ? looseHandlers : specHandlers; memberExpressionToFunctions(this.methodPath, visitor, { file: this.file, scope: this.methodPath.scope, isDerivedConstructor: this.isDerivedConstructor, isStatic: this.isStatic, isPrivateMethod: this.isPrivateMethod, getObjectRef: this.getObjectRef.bind(this), superRef: this.superRef, ...handler, }); } }