pkg/analyzer/test/src/dart/resolution/augmented_invocation_test.dart

// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'package:analyzer/src/error/codes.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import 'context_collection_resolution.dart';

main() {
  defineReflectiveSuite(() {
    // TODO(scheglov): implement augmentation
    // defineReflectiveTests(AugmentedInvocationResolutionTest);
  });
}

@reflectiveTest
class AugmentedInvocationResolutionTest extends PubPackageResolutionTest {
  test_class_constructor_named() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {
  A.named(int a);
}
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment class A {
  augment A.named(int a) {
    augmented(0);
  }
}
''');

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: package:test/a.dart::<fragment>::@class::A::@constructor::named::@parameter::a
        staticType: int
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@class::A::@constructor::named
  fragment: package:test/a.dart::<fragment>::@class::A::@constructor::named
  staticType: A
''');
  }

  test_class_constructor_unnamed() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {
  A(int a);
}
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment class A {
  augment A(int a) {
    augmented(0);
  }
}
''');

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: package:test/a.dart::<fragment>::@class::A::@constructor::new::@parameter::a
        staticType: int
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@class::A::@constructor::new
  fragment: package:test/a.dart::<fragment>::@class::A::@constructor::new
  staticType: A
''');
  }

  test_class_getter_functionTyped() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {
  int Function(int a) get foo => throw 0;
}
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment class A {
  augment int Function(int a) get foo {
    augmented(42);
    throw 0;
  }
}
''');

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: FunctionExpressionInvocation
    function: AugmentedExpression
      augmentedKeyword: augmented
      element: package:test/a.dart::<fragment>::@class::A::@getter::foo
      fragment: package:test/a.dart::<fragment>::@class::A::@getter::foo
      staticType: int Function(int)
    argumentList: ArgumentList
      leftParenthesis: (
      arguments
        IntegerLiteral
          literal: 42
          parameter: root::@parameter::a
          staticType: int
      rightParenthesis: )
    staticElement: <null>
    element: <null>
    staticInvokeType: int Function(int)
    staticType: int
  semicolon: ;
''');
  }

  test_class_method() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {
  void foo(int a) {}
}
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment class A {
  augment void foo(int a) {
    augmented(0);
  }
}
''');

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: package:test/a.dart::<fragment>::@class::A::@method::foo::@parameter::a
        staticType: int
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@class::A::@method::foo
  fragment: package:test/a.dart::<fragment>::@class::A::@method::foo
  staticType: void
''');
  }

  test_topLevel_function() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

void foo(int a) {}
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment void foo(int a) {
  augmented(0);
}
''');

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: package:test/a.dart::<fragment>::@function::foo::@parameter::a
        staticType: int
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: void
''');
  }

  test_topLevel_function_augments_class() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class foo {}
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo() {
  augmented(0);
}
''', [
      error(CompileTimeErrorCode.AUGMENTATION_OF_DIFFERENT_DECLARATION_KIND, 19,
          7),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: <null>
        staticType: int
    rightParenthesis: )
  element: <null>
  fragment: <null>
  staticType: InvalidType
''');
  }

  test_topLevel_function_generic_fromArgument() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T>(T a) => a;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2>(T2 a) {
  augmented(0);
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: ParameterMember
          base: package:test/a.dart::<fragment>::@function::foo::@parameter::a
          substitution: {T: int}
        staticType: int
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: int
''');
  }

  test_topLevel_function_generic_fromArguments_couldNotInfer() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T extends num>(T a) => throw 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2 extends num>(T2 a) {
  augmented('');
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      SimpleStringLiteral
        literal: ''
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: num
''');
  }

  test_topLevel_function_generic_fromClosure() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

U foo<T, U>(T t, U Function(T) f) => throw 0;
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment U2 foo<T2, U2>(T2 t, U2 Function(T2) f) {
  augmented(0, (_) => '');
  throw 0;
}
''');

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    arguments
      IntegerLiteral
        literal: 0
        parameter: ParameterMember
          base: package:test/a.dart::<fragment>::@function::foo::@parameter::t
          substitution: {T: int, U: String}
        staticType: int
      FunctionExpression
        parameters: FormalParameterList
          leftParenthesis: (
          parameter: SimpleFormalParameter
            name: _
            declaredElement: @84::@parameter::_
              type: int
          rightParenthesis: )
        body: ExpressionFunctionBody
          functionDefinition: =>
          expression: SimpleStringLiteral
            literal: ''
        declaredElement: @84
          type: String Function(int)
        parameter: ParameterMember
          base: package:test/a.dart::<fragment>::@function::foo::@parameter::f
          substitution: {T: int, U: String}
        staticType: String Function(int)
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: String
''');
  }

  test_topLevel_function_generic_fromContextType() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T>() => throw 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2>() {
  int a = augmented();
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
      error(WarningCode.UNUSED_LOCAL_VARIABLE, 50, 1),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  arguments: ArgumentList
    leftParenthesis: (
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: int
''');
  }

  test_topLevel_function_generic_typeArguments() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T>() => throw 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2>() {
  augmented<int>();
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  typeArguments: TypeArgumentList
    leftBracket: <
    arguments
      NamedType
        name: int
        element: dart:core::<fragment>::@class::int
        element2: dart:core::@class::int
        type: int
    rightBracket: >
  arguments: ArgumentList
    leftParenthesis: (
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: int
''');
  }

  test_topLevel_function_generic_typeArguments_notMatchingBounds() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T extends num>() => throw 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2 extends num>() {
  augmented<String>();
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
      error(CompileTimeErrorCode.TYPE_ARGUMENT_NOT_MATCHING_BOUNDS, 68, 6),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  typeArguments: TypeArgumentList
    leftBracket: <
    arguments
      NamedType
        name: String
        element: dart:core::<fragment>::@class::String
        element2: dart:core::@class::String
        type: String
    rightBracket: >
  arguments: ArgumentList
    leftParenthesis: (
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: String
''');
  }

  test_topLevel_function_generic_typeArguments_wrongNumber() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

T foo<T>() => throw 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment void foo<T2>() {
  augmented<int, String>();
}
''', [
      error(CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY, 32, 3),
      error(CompileTimeErrorCode.WRONG_NUMBER_OF_TYPE_ARGUMENTS, 55, 13),
    ]);

    var node = findNode.singleAugmentedInvocation;
    assertResolvedNodeText(node, r'''
AugmentedInvocation
  augmentedKeyword: augmented
  typeArguments: TypeArgumentList
    leftBracket: <
    arguments
      NamedType
        name: int
        element: dart:core::<fragment>::@class::int
        element2: dart:core::@class::int
        type: int
      NamedType
        name: String
        element: dart:core::<fragment>::@class::String
        element2: dart:core::@class::String
        type: String
    rightBracket: >
  arguments: ArgumentList
    leftParenthesis: (
    rightParenthesis: )
  element: package:test/a.dart::<fragment>::@function::foo
  fragment: package:test/a.dart::<fragment>::@function::foo
  staticType: dynamic
''');
  }

  test_topLevel_getter_functionTyped() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

int Function(int a) get foo => throw 0;
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment int Function(int a) get foo {
  augmented(42);
  throw 0;
}
''');

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: FunctionExpressionInvocation
    function: AugmentedExpression
      augmentedKeyword: augmented
      element: package:test/a.dart::<fragment>::@getter::foo
      fragment: package:test/a.dart::<fragment>::@getter::foo
      staticType: int Function(int)
    argumentList: ArgumentList
      leftParenthesis: (
      arguments
        IntegerLiteral
          literal: 42
          parameter: root::@parameter::a
          staticType: int
      rightParenthesis: )
    staticElement: <null>
    element: <null>
    staticInvokeType: int Function(int)
    staticType: int
  semicolon: ;
''');
  }

  test_topLevel_getter_notFunctionTyped() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

int get foo => 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment int get foo {
  augmented();
  return 0;
}
''', [
      error(CompileTimeErrorCode.INVOCATION_OF_NON_FUNCTION_EXPRESSION, 43, 9),
    ]);

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: AugmentedInvocation
    augmentedKeyword: augmented
    arguments: ArgumentList
      leftParenthesis: (
      rightParenthesis: )
    element: package:test/a.dart::<fragment>::@getter::foo
    fragment: package:test/a.dart::<fragment>::@getter::foo
    staticType: InvalidType
  semicolon: ;
''');
  }

  test_topLevel_getter_notFunctionTyped_implicitCall() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {
  int call() => 0;
}

A get foo => A();
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment A get foo {
  augmented();
  return A();
}
''');

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: FunctionExpressionInvocation
    function: AugmentedExpression
      augmentedKeyword: augmented
      element: package:test/a.dart::<fragment>::@getter::foo
      fragment: package:test/a.dart::<fragment>::@getter::foo
      staticType: int Function()
    argumentList: ArgumentList
      leftParenthesis: (
      rightParenthesis: )
    staticElement: package:test/a.dart::<fragment>::@class::A::@method::call
    element: package:test/a.dart::<fragment>::@class::A::@method::call#element
    staticInvokeType: int Function()
    staticType: int
  semicolon: ;
''');
  }

  test_topLevel_getter_notFunctionTyped_implicitCall_fromExtension() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

class A {}

extension E on A {
  int call() => 0;
}

A get foo => A();
''');

    await assertNoErrorsInCode('''
part of 'a.dart';

augment A get foo {
  augmented();
  return A();
}
''');

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: FunctionExpressionInvocation
    function: AugmentedExpression
      augmentedKeyword: augmented
      element: package:test/a.dart::<fragment>::@getter::foo
      fragment: package:test/a.dart::<fragment>::@getter::foo
      staticType: int Function()
    argumentList: ArgumentList
      leftParenthesis: (
      rightParenthesis: )
    staticElement: package:test/a.dart::<fragment>::@extension::E::@method::call
    element: package:test/a.dart::<fragment>::@extension::E::@method::call#element
    staticInvokeType: int Function()
    staticType: int
  semicolon: ;
''');
  }

  test_topLevel_getter_notFunctionTyped_variableClosure() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

int get foo => 0;
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment int get foo {
  var v = () {
    augmented();
  };
  return 0;
}
''', [
      error(WarningCode.UNUSED_LOCAL_VARIABLE, 47, 1),
      error(CompileTimeErrorCode.INVOCATION_OF_NON_FUNCTION_EXPRESSION, 60, 9),
    ]);

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: AugmentedInvocation
    augmentedKeyword: augmented
    arguments: ArgumentList
      leftParenthesis: (
      rightParenthesis: )
    element: package:test/a.dart::<fragment>::@getter::foo
    fragment: package:test/a.dart::<fragment>::@getter::foo
    staticType: InvalidType
  semicolon: ;
''');
  }

  test_topLevel_setter() async {
    newFile('$testPackageLibPath/a.dart', r'''
part 'test.dart';

set foo(int _) {}
''');

    await assertErrorsInCode('''
part of 'a.dart';

augment set foo(int _) {
  augmented(0, 1);
}
''', [
      error(CompileTimeErrorCode.AUGMENTED_EXPRESSION_IS_SETTER, 46, 9),
    ]);

    var node = findNode.expressionStatement('augmented(');
    assertResolvedNodeText(node, r'''
ExpressionStatement
  expression: AugmentedInvocation
    augmentedKeyword: augmented
    arguments: ArgumentList
      leftParenthesis: (
      arguments
        IntegerLiteral
          literal: 0
          parameter: <null>
          staticType: int
        IntegerLiteral
          literal: 1
          parameter: <null>
          staticType: int
      rightParenthesis: )
    element: package:test/a.dart::<fragment>::@setter::foo
    fragment: package:test/a.dart::<fragment>::@setter::foo
    staticType: InvalidType
  semicolon: ;
''');
  }
}