Implemented private fields in operator.

Author: flohuemer

CHANGELOG.md

@@ -4,6 +4,7 @@ This changelog summarizes major changes between GraalVM versions of the GraalVM
 The main focus is on user-observable behavior of the engine.
 
 ## Version 21.3.0
+* Implemented the [Private Fields in `in`](https://tc39.es/proposal-private-fields-in-in) proposal. It is available behind the experimental option `--js.private-fields-in`. 
 * Implemented the [JavaScript BigInt to WebAssembly i64 integration](https://github.com/WebAssembly/JS-BigInt-integration) proposal. It can be disabled using the `--js.wasm-bigint=false` option.
 * Updated Node.js to version 14.17.6.
 * Implemented the [Error Cause](https://github.com/tc39/proposal-error-cause) proposal. It is available behind the experimental option `--js.error-cause`.

graal-js/src/com.oracle.js.parser/src/com/oracle/js/parser/Parser.java

@@ -72,6 +72,7 @@
 import static com.oracle.js.parser.TokenType.IDENT;
 import static com.oracle.js.parser.TokenType.IF;
 import static com.oracle.js.parser.TokenType.IMPORT;
+import static com.oracle.js.parser.TokenType.IN;
 import static com.oracle.js.parser.TokenType.INCPOSTFIX;
 import static com.oracle.js.parser.TokenType.INCPREFIX;
 import static com.oracle.js.parser.TokenType.LBRACE;
@@ -81,6 +82,7 @@
 import static com.oracle.js.parser.TokenType.MUL;
 import static com.oracle.js.parser.TokenType.OF;
 import static com.oracle.js.parser.TokenType.PERIOD;
+import static com.oracle.js.parser.TokenType.PRIVATE_IDENT;
 import static com.oracle.js.parser.TokenType.RBRACE;
 import static com.oracle.js.parser.TokenType.RBRACKET;
 import static com.oracle.js.parser.TokenType.RPAREN;
@@ -3806,6 +3808,10 @@ private Expression primaryExpression(boolean yield, boolean await) {
         throw error(AbstractParser.message(MESSAGE_EXPECTED_OPERAND, type.getNameOrType()));
     }
 
+    private boolean isPrivateFieldsIn() {
+        return env.privateFieldsIn;
+    }
+
     /**
      * Convert execString to a call to $EXEC.
      *
@@ -5970,7 +5976,13 @@ private Expression arrowFunctionRestParameter(Expression paramListExpr, long com
     }
 
     private Expression expression(int minPrecedence, boolean in, boolean yield, boolean await) {
-        return expression(unaryExpression(yield, await), minPrecedence, in, yield, await);
+        Expression lhs;
+        if (in && type == PRIVATE_IDENT && isPrivateFieldsIn() && lookahead() == IN) {
+            lhs = privateIdentifierUse().setIsPrivateInCheck();
+        } else {
+            lhs = unaryExpression(yield, await);
+        }
+        return expression(lhs, minPrecedence, in, yield, await);
     }
 
     private JoinPredecessorExpression joinPredecessorExpression(boolean yield, boolean await) {
@@ -6003,12 +6015,19 @@ private Expression expression(Expression exprLhs, int minPrecedence, boolean in,
                 // Build up node.
                 lhs = new TernaryNode(op, lhs, new JoinPredecessorExpression(trueExpr), new JoinPredecessorExpression(falseExpr));
             } else {
+                final TokenType opType = type;
                 // Skip operator.
                 next();
 
                 assert !Token.descType(op).isAssignment();
                 // Get the next primary expression.
-                Expression rhs = unaryExpression(yield, await);
+                Expression rhs;
+                if (in && type == PRIVATE_IDENT && isPrivateFieldsIn() && lookahead() == IN && precedence < IN.getPrecedence()) {
+                    assert opType != IN;
+                    rhs = privateIdentifierUse().setIsPrivateInCheck();
+                } else {
+                    rhs = unaryExpression(yield, await);
+                }
 
                 // Get precedence of next operator.
                 int nextPrecedence = type.getPrecedence();

graal-js/src/com.oracle.js.parser/src/com/oracle/js/parser/ScriptEnvironment.java

@@ -116,8 +116,12 @@ public enum FunctionStatementBehavior {
     /** Are import assertions enabled. */
     final boolean importAssertions;
 
+    /** Is private field in enabled */
+    final boolean privateFieldsIn;
+
     private ScriptEnvironment(boolean strict, int ecmaScriptVersion, boolean emptyStatements, boolean syntaxExtensions, boolean scripting, boolean shebang,
-                    boolean constAsVar, boolean allowBigInt, boolean annexB, boolean classFields, boolean importAssertions, FunctionStatementBehavior functionStatementBehavior,
+                    boolean constAsVar, boolean allowBigInt, boolean annexB, boolean classFields, boolean importAssertions, boolean privateFieldsIn,
+                    FunctionStatementBehavior functionStatementBehavior,
                     PrintWriter dumpOnError) {
         this.namespace = new Namespace();
         this.err = dumpOnError;
@@ -135,6 +139,7 @@ private ScriptEnvironment(boolean strict, int ecmaScriptVersion, boolean emptySt
         this.annexB = annexB;
         this.classFields = classFields;
         this.importAssertions = importAssertions;
+        this.privateFieldsIn = privateFieldsIn;
     }
 
     /**
@@ -176,6 +181,7 @@ public static final class Builder {
         private boolean annexB = true;
         private boolean classFields = true;
         private boolean importAssertions = false;
+        private boolean privateFieldsIn = false;
         private FunctionStatementBehavior functionStatementBehavior = FunctionStatementBehavior.ERROR;
         private PrintWriter dumpOnError;
 
@@ -237,6 +243,11 @@ public Builder importAssertions(boolean importAssertions) {
             return this;
         }
 
+        public Builder privateFieldsIn(boolean privateFieldsIn) {
+            this.privateFieldsIn = privateFieldsIn;
+            return this;
+        }
+
         public Builder functionStatementBehavior(FunctionStatementBehavior functionStatementBehavior) {
             this.functionStatementBehavior = functionStatementBehavior;
             return this;
@@ -249,7 +260,7 @@ public Builder dumpOnError(PrintWriter dumpOnError) {
 
         public ScriptEnvironment build() {
             return new ScriptEnvironment(strict, ecmaScriptVersion, emptyStatements, syntaxExtensions, scripting, shebang, constAsVar, allowBigInt, annexB,
-                            classFields, importAssertions, functionStatementBehavior, dumpOnError);
+                            classFields, importAssertions, privateFieldsIn, functionStatementBehavior, dumpOnError);
         }
     }
 }

graal-js/src/com.oracle.js.parser/src/com/oracle/js/parser/ir/IdentNode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -65,6 +65,7 @@ public final class IdentNode extends Expression implements PropertyKey, Function
     private static final int ARGUMENTS         = 1 << 11;
     private static final int APPLY_ARGUMENTS   = 1 << 12;
     private static final int PRIVATE_IDENT     = 1 << 13;
+    private static final int PRIVATE_IN_CHECK  = 1 << 14;
     //@formatter:on
 
     /** Identifier. */
@@ -303,4 +304,12 @@ public IdentNode setIsPrivate() {
     public boolean isPrivate() {
         return (flags & PRIVATE_IDENT) != 0;
     }
+
+    public IdentNode setIsPrivateInCheck() {
+        return new IdentNode(this, name, flags | PRIVATE_IN_CHECK);
+    }
+
+    public boolean isPrivateInCheck() {
+        return (flags & PRIVATE_IN_CHECK) != 0;
+    }
 }

graal-js/src/com.oracle.truffle.js.parser/src/com/oracle/truffle/js/parser/GraalJSParserHelper.java

@@ -189,6 +189,7 @@ private static ScriptEnvironment makeScriptEnvironment(JSParserOptions parserOpt
         builder.annexB(parserOptions.isAnnexB());
         builder.classFields(parserOptions.isClassFields());
         builder.importAssertions(parserOptions.isImportAssertions());
+        builder.privateFieldsIn(parserOptions.isPrivateFieldsIn());
         if (parserOptions.isFunctionStatementError()) {
             builder.functionStatementBehavior(FunctionStatementBehavior.ERROR);
         } else {

graal-js/src/com.oracle.truffle.js.parser/src/com/oracle/truffle/js/parser/GraalJSTranslator.java

@@ -1550,6 +1550,17 @@ public JavaScriptNode enterIdentNode(IdentNode identNode) {
             result = enterNewTarget();
         } else if (identNode.isImportMeta()) {
             result = enterImportMeta();
+        } else if (identNode.isPrivateInCheck()) {
+            String privateVarName = identNode.getName();
+            VarRef privateVarRef = environment.findLocalVar(privateVarName);
+            JavaScriptNode readNode = privateVarRef.createReadNode();
+            FrameSlot frameSlot = privateVarRef.getFrameSlot();
+            if (JSFrameUtil.needsPrivateBrandCheck(frameSlot)) {
+                // Create a brand node so that a brand check can be performed in the InNode.
+                result = getPrivateBrandNode(frameSlot, privateVarRef);
+            } else {
+                result = readNode;
+            }
         } else {
             String varName = identNode.getName();
             VarRef varRef = findScopeVarCheckTDZ(varName, false);
@@ -2427,9 +2438,16 @@ public JavaScriptNode enterBinaryNode(BinaryNode binaryNode) {
     }
 
     private JavaScriptNode enterBinaryExpressionNode(BinaryNode binaryNode) {
-        JavaScriptNode lhs = transform(binaryNode.getLhs());
+        Expression lhsExpr = binaryNode.getLhs();
+        JavaScriptNode lhs = transform(lhsExpr);
         JavaScriptNode rhs = transform(binaryNode.getRhs());
-        return tagExpression(factory.createBinary(context, tokenTypeToBinaryOperation(binaryNode.tokenType()), lhs, rhs), binaryNode);
+        JavaScriptNode result;
+        if (lhsExpr instanceof IdentNode && ((IdentNode) lhsExpr).isPrivateInCheck()) {
+            result = factory.createPrivateFieldIn(lhs, rhs);
+        } else {
+            result = factory.createBinary(context, tokenTypeToBinaryOperation(binaryNode.tokenType()), lhs, rhs);
+        }
+        return tagExpression(result, binaryNode);
     }
 
     private JavaScriptNode enterBinaryTransformNode(BinaryNode binaryNode) {
@@ -2886,23 +2904,26 @@ private JavaScriptNode createPrivateFieldSet(AccessNode accessNode, JavaScriptNo
     private JavaScriptNode insertPrivateBrandCheck(JavaScriptNode base, VarRef privateNameVar) {
         FrameSlot frameSlot = privateNameVar.getFrameSlot();
         if (JSFrameUtil.needsPrivateBrandCheck(frameSlot)) {
-            int frameLevel = ((AbstractFrameVarRef) privateNameVar).getFrameLevel();
-            int scopeLevel = ((AbstractFrameVarRef) privateNameVar).getScopeLevel();
-            Environment memberEnv = environment.getParentAt(frameLevel, scopeLevel);
-            FrameSlot constructorSlot = memberEnv.getBlockFrameDescriptor().findFrameSlot(ClassNode.PRIVATE_CONSTRUCTOR_BINDING_NAME);
-            JavaScriptNode constructor = environment.createLocal(constructorSlot, frameLevel, scopeLevel);
-            JavaScriptNode brand;
-            if (JSFrameUtil.isPrivateNameStatic(frameSlot)) {
-                brand = constructor;
-            } else {
-                brand = factory.createGetPrivateBrand(context, constructor);
-            }
+            JavaScriptNode brand = getPrivateBrandNode(frameSlot, privateNameVar);
             return factory.createPrivateBrandCheck(base, brand);
         } else {
             return base;
         }
     }
 
+    private JavaScriptNode getPrivateBrandNode(FrameSlot frameSlot, VarRef privateNameVar) {
+        int frameLevel = ((AbstractFrameVarRef) privateNameVar).getFrameLevel();
+        int scopeLevel = ((AbstractFrameVarRef) privateNameVar).getScopeLevel();
+        Environment memberEnv = environment.getParentAt(frameLevel, scopeLevel);
+        FrameSlot constructorSlot = memberEnv.getBlockFrameDescriptor().findFrameSlot(ClassNode.PRIVATE_CONSTRUCTOR_BINDING_NAME);
+        JavaScriptNode constructor = environment.createLocal(constructorSlot, frameLevel, scopeLevel);
+        if (JSFrameUtil.isPrivateNameStatic(frameSlot)) {
+            return constructor;
+        } else {
+            return factory.createGetPrivateBrand(context, constructor);
+        }
+    }
+
     @Override
     public JavaScriptNode enterIndexNode(IndexNode indexNode) {
         JavaScriptNode base = transform(indexNode.getBase());

graal-js/src/com.oracle.truffle.js.test.external/src/com/oracle/truffle/js/test/external/test262/Test262Runnable.java

@@ -180,6 +180,7 @@ public class Test262Runnable extends TestRunnable {
                     "caller",
                     "class",
                     "class-fields-private",
+                    "class-fields-private-in",
                     "class-fields-public",
                     "class-methods-private",
                     "class-static-block",
@@ -242,7 +243,6 @@ public class Test262Runnable extends TestRunnable {
                     "Temporal",
                     "arbitrary-module-namespace-names",
                     "array-find-from-last",
-                    "class-fields-private-in",
                     "resizable-arraybuffer",
                     "tail-call-optimization",
     }));
@@ -252,6 +252,7 @@ public class Test262Runnable extends TestRunnable {
                     "Object.hasOwn",
                     "String.prototype.at",
                     "TypedArray.prototype.at",
+                    "class-fields-private-in",
                     "class-fields-private",
                     "class-fields-public",
                     "class-methods-private",

graal-js/src/com.oracle.truffle.js.test.external/src/com/oracle/truffle/js/test/external/testv8/TestV8Runnable.java

@@ -102,6 +102,7 @@ public class TestV8Runnable extends TestRunnable {
                     "--harmony-atomics-waitasync",
                     "--harmony-class-static-blocks",
                     "--harmony-object-has-own",
+                    "--harmony-private-brand-checks",
                     "--harmony-regexp-match-indices",
                     "--harmony-top-level-await"
     }));