[dart:js_interop] Add missing checks for toJSCaptureThis

Fixes #61439

These checks exist for toJS but were not added when we
introduced toJSCaptureThis. Error wording is slightly
modified to be consistent.

Change-Id: I12c861aacecc2bfed255be9f26c99bf2f1c02ebd
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/449661
Reviewed-by: Johnni Winther <[email protected]>
Commit-Queue: Srujan Gaddam <[email protected]>
Reviewed-by: Ömer Ağacan <[email protected]>

Author: srujzs

CHANGELOG.md

@@ -118,6 +118,10 @@ instead.
 - For object literals created from extension type factories, the `@JS()`
   annotation can now be used to change the name of keys in JavaScript. See
   [#55138][] for more details.
+- Compile-time checks for `Function.toJS` now apply to `toJSCaptureThis` as
+  well. Specifically, the function should be a statically known type, cannot
+  contain invalid types in its signature, cannot have any type parameters, and
+  cannot have any named parameters.
 
 [#59830]: https://github.com/dart-lang/sdk/issues/59830
 [#55138]: https://github.com/dart-lang/sdk/issues/55138

pkg/_fe_analyzer_shared/lib/src/messages/codes_generated.dart

@@ -9721,21 +9721,114 @@ const MessageCode codeJsInteropExternalMemberNotJSAnnotated = const MessageCode(
 );
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
-const MessageCode codeJsInteropFunctionToJSNamedParameters = const MessageCode(
+const Template<
+  Message Function(String conversion),
+  Message Function({required String conversion})
+>
+codeJsInteropFunctionToJSNamedParameters = const Template(
   "JsInteropFunctionToJSNamedParameters",
-  problemMessage:
-      r"""Functions converted via `toJS` cannot declare named parameters.""",
-  correctionMessage:
+  problemMessageTemplate:
+      r"""Functions converted via '#conversion' cannot declare named parameters.""",
+  correctionMessageTemplate:
       r"""Remove the declared named parameters from the function.""",
+  withArgumentsOld: _withArgumentsOldJsInteropFunctionToJSNamedParameters,
+  withArguments: _withArgumentsJsInteropFunctionToJSNamedParameters,
 );
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
-const MessageCode codeJsInteropFunctionToJSTypeParameters = const MessageCode(
+Message _withArgumentsJsInteropFunctionToJSNamedParameters({
+  required String conversion,
+}) {
+  var conversion_0 = conversions.validateString(conversion);
+  return new Message(
+    codeJsInteropFunctionToJSNamedParameters,
+    problemMessage:
+        """Functions converted via '${conversion_0}' cannot declare named parameters.""",
+    correctionMessage:
+        """Remove the declared named parameters from the function.""",
+    arguments: {'conversion': conversion},
+  );
+}
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsOldJsInteropFunctionToJSNamedParameters(
+  String conversion,
+) => _withArgumentsJsInteropFunctionToJSNamedParameters(conversion: conversion);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Template<
+  Message Function(String conversion),
+  Message Function({required String conversion})
+>
+codeJsInteropFunctionToJSTypeParameters = const Template(
   "JsInteropFunctionToJSTypeParameters",
-  problemMessage:
-      r"""Functions converted via `toJS` cannot declare type parameters.""",
-  correctionMessage:
+  problemMessageTemplate:
+      r"""Functions converted via '#conversion' cannot declare type parameters.""",
+  correctionMessageTemplate:
       r"""Remove the declared type parameters from the function.""",
+  withArgumentsOld: _withArgumentsOldJsInteropFunctionToJSTypeParameters,
+  withArguments: _withArgumentsJsInteropFunctionToJSTypeParameters,
+);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsJsInteropFunctionToJSTypeParameters({
+  required String conversion,
+}) {
+  var conversion_0 = conversions.validateString(conversion);
+  return new Message(
+    codeJsInteropFunctionToJSTypeParameters,
+    problemMessage:
+        """Functions converted via '${conversion_0}' cannot declare type parameters.""",
+    correctionMessage:
+        """Remove the declared type parameters from the function.""",
+    arguments: {'conversion': conversion},
+  );
+}
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsOldJsInteropFunctionToJSTypeParameters(
+  String conversion,
+) => _withArgumentsJsInteropFunctionToJSTypeParameters(conversion: conversion);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+const Template<
+  Message Function(String conversion, String string2),
+  Message Function({required String conversion, required String string2})
+>
+codeJsInteropFunctionToJSTypeViolation = const Template(
+  "JsInteropFunctionToJSTypeViolation",
+  problemMessageTemplate:
+      r"""Function converted via '#conversion' contains invalid types in its function signature: '#string2'.""",
+  correctionMessageTemplate:
+      r"""Use one of these valid types instead: JS types from 'dart:js_interop', ExternalDartReference, void, bool, num, double, int, String, extension types that erase to one of these types, '@staticInterop' types, 'dart:html' types when compiling to JS, or a type parameter that is a subtype of a valid non-primitive type.""",
+  withArgumentsOld: _withArgumentsOldJsInteropFunctionToJSTypeViolation,
+  withArguments: _withArgumentsJsInteropFunctionToJSTypeViolation,
+);
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsJsInteropFunctionToJSTypeViolation({
+  required String conversion,
+  required String string2,
+}) {
+  var conversion_0 = conversions.validateString(conversion);
+  var string2_0 = conversions.validateString(string2);
+  return new Message(
+    codeJsInteropFunctionToJSTypeViolation,
+    problemMessage:
+        """Function converted via '${conversion_0}' contains invalid types in its function signature: '${string2_0}'.""",
+    correctionMessage:
+        """Use one of these valid types instead: JS types from 'dart:js_interop', ExternalDartReference, void, bool, num, double, int, String, extension types that erase to one of these types, '@staticInterop' types, 'dart:html' types when compiling to JS, or a type parameter that is a subtype of a valid non-primitive type.""",
+    arguments: {'conversion': conversion, 'string2': string2},
+  );
+}
+
+// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
+Message _withArgumentsOldJsInteropFunctionToJSTypeViolation(
+  String conversion,
+  String string2,
+) => _withArgumentsJsInteropFunctionToJSTypeViolation(
+  conversion: conversion,
+  string2: string2,
 );
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
@@ -10226,44 +10319,6 @@ Message _withArgumentsOldJsInteropStaticInteropTearOffsDisallowed(
   name: name,
 );
 
-// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
-const Template<
-  Message Function(String string2),
-  Message Function({required String string2})
->
-codeJsInteropStaticInteropToJSFunctionTypeViolation = const Template(
-  "JsInteropStaticInteropToJSFunctionTypeViolation",
-  problemMessageTemplate:
-      r"""Function converted via 'toJS' contains invalid types in its function signature: '#string2'.""",
-  correctionMessageTemplate:
-      r"""Use one of these valid types instead: JS types from 'dart:js_interop', ExternalDartReference, void, bool, num, double, int, String, extension types that erase to one of these types, '@staticInterop' types, 'dart:html' types when compiling to JS, or a type parameter that is a subtype of a valid non-primitive type.""",
-  withArgumentsOld:
-      _withArgumentsOldJsInteropStaticInteropToJSFunctionTypeViolation,
-  withArguments: _withArgumentsJsInteropStaticInteropToJSFunctionTypeViolation,
-);
-
-// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
-Message _withArgumentsJsInteropStaticInteropToJSFunctionTypeViolation({
-  required String string2,
-}) {
-  var string2_0 = conversions.validateString(string2);
-  return new Message(
-    codeJsInteropStaticInteropToJSFunctionTypeViolation,
-    problemMessage:
-        """Function converted via 'toJS' contains invalid types in its function signature: '${string2_0}'.""",
-    correctionMessage:
-        """Use one of these valid types instead: JS types from 'dart:js_interop', ExternalDartReference, void, bool, num, double, int, String, extension types that erase to one of these types, '@staticInterop' types, 'dart:html' types when compiling to JS, or a type parameter that is a subtype of a valid non-primitive type.""",
-    arguments: {'string2': string2},
-  );
-}
-
-// DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
-Message _withArgumentsOldJsInteropStaticInteropToJSFunctionTypeViolation(
-  String string2,
-) => _withArgumentsJsInteropStaticInteropToJSFunctionTypeViolation(
-  string2: string2,
-);
-
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Template<
   Message Function(String name),

pkg/_js_interop_checks/lib/js_interop_checks.dart

@@ -13,42 +13,43 @@ import 'package:front_end/src/api_prototype/codes.dart'
         Message,
         LocatedMessage,
         codeDartFfiLibraryInDart2Wasm,
+        codeJsInteropDartClassExtendsJSClass,
         codeJsInteropDartJsInteropAnnotationForStaticInteropOnly,
+        codeJsInteropDisallowedInteropLibraryInDart2Wasm,
         codeJsInteropEnclosingClassJSAnnotation,
         codeJsInteropEnclosingClassJSAnnotationContext,
         codeJsInteropExtensionTypeMemberNotInterop,
+        codeJsInteropExtensionTypeNotInterop,
         codeJsInteropExtensionTypeUsedWithWrongJsAnnotation,
         codeJsInteropExternalExtensionMemberOnTypeInvalid,
         codeJsInteropExternalExtensionMemberWithStaticDisallowed,
         codeJsInteropExternalMemberNotJSAnnotated,
         codeJsInteropFunctionToJSNamedParameters,
+        codeJsInteropFunctionToJSRequiresStaticType,
         codeJsInteropFunctionToJSTypeParameters,
+        codeJsInteropFunctionToJSTypeViolation,
         codeJsInteropInvalidStaticClassMemberName,
+        codeJsInteropJSClassExtendsDartClass,
         codeJsInteropNamedParameters,
+        codeJsInteropNativeClassInAnnotation,
         codeJsInteropNonExternalConstructor,
         codeJsInteropNonExternalMember,
+        codeJsInteropNonStaticWithStaticInteropSupertype,
+        codeJsInteropObjectLiteralConstructorPositionalParameters,
         codeJsInteropOperatorCannotBeRenamed,
         codeJsInteropOperatorsNotSupported,
+        codeJsInteropStaticInteropExternalAccessorTypeViolation,
+        codeJsInteropStaticInteropExternalFunctionTypeViolation,
         codeJsInteropStaticInteropGenerativeConstructor,
+        codeJsInteropStaticInteropNoJSAnnotation,
         codeJsInteropStaticInteropParameterInitializersAreIgnored,
         codeJsInteropStaticInteropSyntheticConstructor,
-        codeJsInteropDartClassExtendsJSClass,
-        codeJsInteropDisallowedInteropLibraryInDart2Wasm,
-        codeJsInteropJSClassExtendsDartClass,
-        codeJsInteropNonStaticWithStaticInteropSupertype,
-        codeJsInteropStaticInteropNoJSAnnotation,
-        codeJsInteropStaticInteropWithInstanceMembers,
-        codeJsInteropStaticInteropWithNonStaticSupertype,
-        codeJsInteropObjectLiteralConstructorPositionalParameters,
-        codeJsInteropNativeClassInAnnotation,
         codeJsInteropStaticInteropTearOffsDisallowed,
         codeJsInteropStaticInteropTrustTypesUsageNotAllowed,
         codeJsInteropStaticInteropTrustTypesUsedWithoutStaticInterop,
-        codeJsInteropExtensionTypeNotInterop,
-        codeJsInteropFunctionToJSRequiresStaticType,
-        codeJsInteropStaticInteropExternalAccessorTypeViolation,
-        codeJsInteropStaticInteropExternalFunctionTypeViolation,
-        codeJsInteropStaticInteropToJSFunctionTypeViolation;
+        codeJsInteropStaticInteropWithInstanceMembers,
+        codeJsInteropStaticInteropWithNonStaticSupertype;
+
 // Used for importing CFE utility functions for constructor tear-offs.
 import 'package:front_end/src/api_prototype/lowering_predicates.dart';
 import 'package:kernel/class_hierarchy.dart';
@@ -65,6 +66,7 @@ class JsInteropChecks extends RecursiveVisitor {
   final CoreTypes _coreTypes;
   late final ExtensionIndex extensionIndex;
   final Procedure _functionToJSTarget;
+  final Procedure _functionToJSCaptureThisTarget;
   // Errors on constants need source information, so we use the surrounding
   // `ConstantExpression` as the source.
   ConstantExpression? _lastConstantExpression;
@@ -177,6 +179,10 @@ class JsInteropChecks extends RecursiveVisitor {
          'dart:js_interop',
          'FunctionToJSExportedDartFunction|get#toJS',
        ),
+       _functionToJSCaptureThisTarget = _coreTypes.index.getTopLevelProcedure(
+         'dart:js_interop',
+         'FunctionToJSExportedDartFunction|get#toJSCaptureThis',
+       ),
        _staticTypeContext = StatefulStaticTypeContext.stacked(
          TypeEnvironment(_coreTypes, hierarchy),
        ),
@@ -496,7 +502,8 @@ class JsInteropChecks extends RecursiveVisitor {
   @override
   void visitStaticInvocation(StaticInvocation node) {
     final target = node.target;
-    if (target == _functionToJSTarget) {
+    if (target == _functionToJSTarget ||
+        target == _functionToJSCaptureThisTarget) {
       _checkFunctionToJSCall(node);
     } else {
       // Only check generated tear-offs in StaticInvocations.
@@ -851,8 +858,8 @@ class JsInteropChecks extends RecursiveVisitor {
     return false;
   }
 
-  /// Checks that [node], which is a call to 'Function.toJS', is called with a
-  /// valid function type.
+  /// Checks that [node], which is a call to `Function.toJS` or
+  /// `Function.toJSCaptureThis`, is called with a valid function type.
   void _checkFunctionToJSCall(StaticInvocation node) {
     void report(Message message) => _reporter.report(
       message,
@@ -861,20 +868,28 @@ class JsInteropChecks extends RecursiveVisitor {
       node.location?.file,
     );
 
+    final conversion = node.target == _functionToJSTarget
+        ? 'toJS'
+        : 'toJSCaptureThis';
     final argument = node.arguments.positional.single;
     final functionType = argument.getStaticType(_staticTypeContext);
     if (functionType is! FunctionType) {
       report(
         codeJsInteropFunctionToJSRequiresStaticType.withArgumentsOld(
+          conversion,
           functionType,
         ),
       );
     } else {
       if (functionType.typeParameters.isNotEmpty) {
-        report(codeJsInteropFunctionToJSTypeParameters);
+        report(
+          codeJsInteropFunctionToJSTypeParameters.withArgumentsOld(conversion),
+        );
       }
       if (functionType.namedParameters.isNotEmpty) {
-        report(codeJsInteropFunctionToJSNamedParameters);
+        report(
+          codeJsInteropFunctionToJSNamedParameters.withArgumentsOld(conversion),
+        );
       }
       _reportFunctionToJSInvocationIfNotAllowedFunctionType(functionType, node);
     }
@@ -1187,7 +1202,8 @@ class JsInteropChecks extends RecursiveVisitor {
   ) {
     if (!_isAllowedExternalFunctionType(functionType)) {
       _reporter.report(
-        codeJsInteropStaticInteropToJSFunctionTypeViolation.withArgumentsOld(
+        codeJsInteropFunctionToJSTypeViolation.withArgumentsOld(
+          invocation.target == _functionToJSTarget ? 'toJS' : 'toJSCaptureThis',
           _disallowedExternalFunctionTypeString(functionType),
         ),
         invocation.fileOffset,

pkg/front_end/lib/src/codes/cfe_codes_generated.dart

@@ -3141,13 +3141,13 @@ Message _withArgumentsOldJsInteropExtensionTypeNotInterop(
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Template<
-  Message Function(DartType type),
-  Message Function({required DartType type})
+  Message Function(String conversion, DartType type),
+  Message Function({required String conversion, required DartType type})
 >
 codeJsInteropFunctionToJSRequiresStaticType = const Template(
   "JsInteropFunctionToJSRequiresStaticType",
   problemMessageTemplate:
-      r"""`Function.toJS` requires a statically known function type, but Type '#type' is not a precise function type, e.g., `void Function()`.""",
+      r"""Functions converted via '#conversion' require a statically known function type, but Type '#type' is not a precise function type, e.g., `void Function()`.""",
   correctionMessageTemplate:
       r"""Insert an explicit cast to the expected function type.""",
   withArgumentsOld: _withArgumentsOldJsInteropFunctionToJSRequiresStaticType,
@@ -3156,25 +3156,31 @@ codeJsInteropFunctionToJSRequiresStaticType = const Template(
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 Message _withArgumentsJsInteropFunctionToJSRequiresStaticType({
+  required String conversion,
   required DartType type,
 }) {
+  var conversion_0 = conversions.validateString(conversion);
   TypeLabeler labeler = new TypeLabeler();
   var type_0 = labeler.labelType(type);
   return new Message(
     codeJsInteropFunctionToJSRequiresStaticType,
     problemMessage:
-        """`Function.toJS` requires a statically known function type, but Type '${type_0}' is not a precise function type, e.g., `void Function()`.""" +
+        """Functions converted via '${conversion_0}' require a statically known function type, but Type '${type_0}' is not a precise function type, e.g., `void Function()`.""" +
         labeler.originMessages,
     correctionMessage:
         """Insert an explicit cast to the expected function type.""",
-    arguments: {'type': type},
+    arguments: {'conversion': conversion, 'type': type},
   );
 }
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 Message _withArgumentsOldJsInteropFunctionToJSRequiresStaticType(
+  String conversion,
   DartType type,
-) => _withArgumentsJsInteropFunctionToJSRequiresStaticType(type: type);
+) => _withArgumentsJsInteropFunctionToJSRequiresStaticType(
+  conversion: conversion,
+  type: type,
+);
 
 // DO NOT EDIT. THIS FILE IS GENERATED. SEE TOP OF FILE.
 const Template<

pkg/front_end/messages.status

@@ -85,6 +85,7 @@ front_end/JsInteropExternalMemberNotJSAnnotated/example: missingExample # Web co
 front_end/JsInteropFunctionToJSNamedParameters/example: missingExample # Web compiler specific
 front_end/JsInteropFunctionToJSRequiresStaticType/example: missingExample # Web compiler specific
 front_end/JsInteropFunctionToJSTypeParameters/example: missingExample # Web compiler specific
+front_end/JsInteropFunctionToJSTypeViolation/example: missingExample
 front_end/JsInteropInvalidStaticClassMemberName/example: missingExample # Web compiler specific
 front_end/JsInteropIsAInvalidTypeVariable/example: missingExample # Web compiler specific
 front_end/JsInteropIsAObjectLiteralType/example: missingExample # Web compiler specific
@@ -370,6 +371,7 @@ front_end/JsInteropExternalMemberNotJSAnnotated/analyzerCode: missingAnalyzerCod
 front_end/JsInteropFunctionToJSNamedParameters/analyzerCode: missingAnalyzerCode # Web compiler specific
 front_end/JsInteropFunctionToJSRequiresStaticType/analyzerCode: missingAnalyzerCode # Web compiler specific
 front_end/JsInteropFunctionToJSTypeParameters/analyzerCode: missingAnalyzerCode # Web compiler specific
+front_end/JsInteropFunctionToJSTypeViolation/analyzerCode: missingAnalyzerCode
 front_end/JsInteropInvalidStaticClassMemberName/analyzerCode: missingAnalyzerCode
 front_end/JsInteropIsAInvalidTypeVariable/analyzerCode: missingAnalyzerCode # Web compiler specific
 front_end/JsInteropIsAObjectLiteralType/analyzerCode: missingAnalyzerCode # Web compiler specific