Throw an error if goog.callerLocation() is not used in a function parameter list as a default parameter initializer.

PiperOrigin-RevId: 693091444

Author: rahul-kamat

src/com/google/javascript/jscomp/RewriteCallerCodeLocation.java

@@ -43,11 +43,10 @@ class RewriteCallerCodeLocation implements CompilerPass {
           "Please make sure there is only one goog.callerLocation argument in your function's"
               + " parameter list, and it is the first optional argument in the list");
 
-  static final DiagnosticType JSC_CALLER_LOCATION_ERROR =
+  static final DiagnosticType JSC_CALLER_LOCATION_MISUSE_ERROR =
       DiagnosticType.error(
-          "JSC_CALLER_LOCATION_ERROR",
-          "goog.callerLocation should only be used as a default value in a function's parameter"
-              + " list");
+          "JSC_CALLER_LOCATION_MISUSE_ERROR",
+          "goog.callerLocation should only be used as a default parameter initializer");
 
   static final DiagnosticType JSC_UNDEFINED_CODE_LOCATION_ERROR =
       DiagnosticType.error(
@@ -97,12 +96,27 @@ public void visit(NodeTraversal t, Node n, Node parent) {
         visitParamListAndAddCallerLocationFunctionNames(n, t);
       }
       if (n.isCall()) {
-        // Throw an error when goog.callerLocation() is NOT used as a default value in a
-        // function's parameter.
+        // Check for misuse of goog.callerLocation.
         Node firstChild = n.getFirstChild();
-        if (GOOG_CALLER_LOCATION_QUALIFIED_NAME.matches(firstChild)
-            && !n.getParent().isDefaultValue()) {
-          compiler.report(JSError.make(firstChild, JSC_CALLER_LOCATION_ERROR));
+        if (GOOG_CALLER_LOCATION_QUALIFIED_NAME.matches(firstChild)) {
+          if (!parent.isDefaultValue()) {
+            // Throw an error when goog.callerLocation() is NOT used as a default value in a
+            // function's parameter.
+            compiler.report(JSError.make(firstChild, JSC_CALLER_LOCATION_MISUSE_ERROR));
+          }
+          if (parent.getParent().isStringKey()) {
+            // Throw an error when goog.callerLocation() is used in an object literal.
+            // E.g:
+            // function foo({val1, val2, here = goog.callerLocation()}) {}
+            // The AST for `here = goog.callerLocation()`looks like:
+            // STRING_KEY here (This node tells us we are in an object literal)
+            //   DEFAULT_VALUE
+            //     NAME here 1:26
+            //     CALL 1:33
+            //       GETPROP callerLocation
+            //         NAME goog 1:33
+            compiler.report(JSError.make(parent.getParent(), JSC_CALLER_LOCATION_MISUSE_ERROR));
+          }
         }
       }
     }

test/com/google/javascript/jscomp/RewriteCallerCodeLocationTest.java

@@ -17,7 +17,7 @@
 package com.google.javascript.jscomp;
 
 import static com.google.javascript.jscomp.RewriteCallerCodeLocation.JSC_ANONYMOUS_FUNCTION_CODE_LOCATION_ERROR;
-import static com.google.javascript.jscomp.RewriteCallerCodeLocation.JSC_CALLER_LOCATION_ERROR;
+import static com.google.javascript.jscomp.RewriteCallerCodeLocation.JSC_CALLER_LOCATION_MISUSE_ERROR;
 import static com.google.javascript.jscomp.RewriteCallerCodeLocation.JSC_CALLER_LOCATION_POSITION_ERROR;
 import static com.google.javascript.jscomp.RewriteCallerCodeLocation.JSC_UNDEFINED_CODE_LOCATION_ERROR;
 
@@ -296,19 +296,17 @@ public void testErrorOnCallerLocationNotUsedAsDefaultParam() {
             "function foo() {", //
             "  const x = goog.callerLocation();", //
             "}"),
-        JSC_CALLER_LOCATION_ERROR);
+        JSC_CALLER_LOCATION_MISUSE_ERROR);
   }
 
   @Test
   public void testDestructuringOptionsBag() {
-    // TODO(user): this should error
-    test(
+    // Error if `goog.callerLocation()` is used in an object literal
+    testError(
         lines(
             "function foo({val1, val2, here = goog.callerLocation()}) {}", //
             "foo({val1:0, val2:0})"),
-        lines(
-            "function foo({val1, val2, here = goog.callerLocation()}) {}",
-            "foo({val1:0, val2:0})"));
+        JSC_CALLER_LOCATION_MISUSE_ERROR);
   }
 
   @Test