pkg/analyzer/test/src/dart/analysis/driver_caching_test.dart

// Copyright (c) 2020, 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 'dart:async';

import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/diagnostic/diagnostic.dart';
import 'package:analyzer/file_system/file_system.dart';
import 'package:analyzer/src/dart/analysis/driver.dart';
import 'package:analyzer_testing/package_config_file_builder.dart';
import 'package:analyzer_testing/src/expected_diagnostics.dart'
    as expected_diagnostics;
import 'package:analyzer_testing/utilities/utilities.dart';
import 'package:test/test.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import '../../../util/diff.dart';
import '../resolution/context_collection_resolution.dart';
import '../resolution/node_text_expectations.dart';

main() {
  defineReflectiveSuite(() {
    defineReflectiveTests(AnalysisDriverCachingTest);
  });
}

@reflectiveTest
class AnalysisDriverCachingTest extends PubPackageResolutionTest {
  @override
  bool get retainDataForTesting => true;

  List<Set<String>> get _linkedCycles {
    var driver = driverFor(testFile);
    return driver.testView!.libraryContext.linkedCycles;
  }

  @override
  void setUp() {
    super.setUp();

    writeTestPackageConfig(PackageConfigFileBuilder());
  }

  test_analysisOptions_strictCasts() async {
    useEmptyByteStore();

    // Configure `strict-casts: false`.
    writeTestPackageAnalysisOptionsFile(analysisOptionsContent());

    var code = r'''
dynamic a = 0;
int b = a;
''';
    addTestFile(code);

    // `strict-cast: false`, so no errors.
    await _assertTestFileDiagnostics(code: code, expected: code);

    // Configure `strict-casts: true`.
    await disposeAnalysisContextCollection();
    writeTestPackageAnalysisOptionsFile(
      analysisOptionsContent(strictCasts: true),
    );

    // `strict-cast: true`, so has errors.
    await _assertTestFileDiagnostics(
      code: code,
      expected: r'''
dynamic a = 0;
int b = a;
//      ^
// [diag.invalidAssignment] A value of type 'dynamic' can't be assigned to a variable of type 'int'.
''',
    );
  }

  test_change_factoryConstructor_addEqNothing() async {
    await resolveTestCodeWithDiagnostics(r'''
class A {
  factory A();
//        ^
// [diag.factoryWithoutBody] A non-redirecting 'factory' constructor must have a body.
}
''');

    var analysisDriver = driverFor(testFile);
    analysisDriver.changeFile(testFile.path);
    await analysisDriver.applyPendingFileChanges();

    await resolveTestCodeWithDiagnostics(r'''
class A {
  factory A() =;
//        ^
// [diag.factoryWithoutBody] A non-redirecting 'factory' constructor must have a body.
}
''');
  }

  test_change_factoryConstructor_moveStaticToken() async {
    await resolveTestCodeWithDiagnostics(r'''
class A {
  factory A();
//        ^
// [diag.factoryWithoutBody] A non-redirecting 'factory' constructor must have a body.
  static void foo<U>() {}
}
''');

    var analysisDriver = driverFor(testFile);
    analysisDriver.changeFile(testFile.path);
    await analysisDriver.applyPendingFileChanges();

    await resolveTestCodeWithDiagnostics(r'''
class A {
  factory A() =
//        ^
// [diag.factoryWithoutBody] A non-redirecting 'factory' constructor must have a body.
  static void foo<U>() {}
}
''');
  }

  test_change_field_outOfOrderStaticConst() async {
    await resolveTestCodeWithDiagnostics(r'''
class A {
  static f = Object();
//       ^
// [diag.missingConstFinalVarOrType] Variables must be declared using the keywords 'const', 'final', 'var' or a type name.
}
''');

    var analysisDriver = driverFor(testFile);
    analysisDriver.changeFile(testFile.path);
    await analysisDriver.applyPendingFileChanges();

    await resolveTestCodeWithDiagnostics(r'''
class A {
  const
  static f = Object();
// [diag.missingConstFinalVarOrType][column 2][length 1] Variables must be declared using the keywords 'const', 'final', 'var' or a type name.
}
''');
  }

  test_change_field_staticFinal_hasConstConstructor_changeInitializer() async {
    useEmptyByteStore();

    var result = await resolveTestCodeWithDiagnostics(r'''
class A {
  static const a = 0;
  static const b = 1;
  static final Set<int> f = {a};
  const A {}
//      ^
// [diag.missingMethodParameters] Methods must have an explicit list of parameters.
//        ^
// [diag.constConstructorWithBody] Const constructors can't have a body.
}
''');

    assertType(result.findElement.field('f').type, 'Set<int>');

    // The summary for the library was linked.
    _assertContainsLinkedCycle({testFile}, andClear: true);

    // Dispose the collection, with its driver.
    // The next analysis will recreate it.
    // We will reuse the byte store, so can reuse summaries.
    await disposeAnalysisContextCollection();

    result = await resolveTestCodeWithDiagnostics(r'''
class A {
  static const a = 0;
  static const b = 1;
  static final Set<int> f = <int>{a, b, 2};
  const A {}
//      ^
// [diag.missingMethodParameters] Methods must have an explicit list of parameters.
//        ^
// [diag.constConstructorWithBody] Const constructors can't have a body.
}
''');

    assertType(result.findElement.field('f').type, 'Set<int>');

    // We changed the initializer of the final field. But it is static, so
    // even though the class has a constant constructor, we don't need its
    // initializer, so nothing should be linked.
    _assertNoLinkedCycles();
  }

  test_change_functionBody() async {
    useEmptyByteStore();

    var result = await resolveTestCodeWithDiagnostics(r'''
void f() {
  print(0);
}
''');

    expect(result.findNode.integerLiteral('0'), isNotNull);

    // The summary for the library was linked.
    _assertContainsLinkedCycle({testFile}, andClear: true);

    // Dispose the collection, with its driver.
    // The next analysis will recreate it.
    // We will reuse the byte store, so can reuse summaries.
    await disposeAnalysisContextCollection();

    result = await resolveTestCodeWithDiagnostics(r'''
void f() {
  print(1);
}
''');

    result = await resolveTestFile();
    expect(result.findNode.integerLiteral('1'), isNotNull);

    // We changed only the function body, nothing should be linked.
    _assertNoLinkedCycles();
  }

  test_getLibraryByUri_invalidated_exportNamespace() async {
    useEmptyByteStore();

    var a = newFile('$testPackageLibPath/a.dart', 'const a1 = 0;');
    newFile('$testPackageLibPath/b.dart', r'''
import 'a.dart';
''');

    var driver = driverFor(testFile);

    // Link both libraries, keep them.
    await driver.getLibraryByUri('package:test/a.dart');
    await driver.getLibraryByUri('package:test/b.dart');

    // Discard both libraries.
    driver.changeFile(a.path);

    // Read `package:test/a.dart` from bytes.
    // Don't ask for `exportNamespace`, this used to keep it in the state
    // "should be asked from LinkedElementLibrary", which will ask it
    // from the `LibraryReader` current at the moment of `exportNamespace`
    // access, not necessary the same that created this instance.
    var aResult = await driver.getLibraryByUri('package:test/a.dart');
    var aElement = (aResult as LibraryElementResult).element;

    // The element is valid at this point.
    expect(driver.isValidLibraryElement(aElement), isTrue);

    // Discard both libraries.
    driver.changeFile(a.path);

    // Read `package:test/b.dart`, actually create `LibraryElement` for it.
    // We used to create only `LibraryReader` for `package:test/a.dart`.
    await driver.getLibraryByUri('package:test/b.dart');

    // The element is not valid anymore.
    expect(driver.isValidLibraryElement(aElement), isFalse);

    // But its `exportNamespace` can be accessed.
    expect(aElement.exportNamespace.definedNames2, isNotEmpty);

    // TODO(scheglov): This is not quite right.
    // When we return `LibraryElement` that is not fully read, and read
    // anything lazily, we can be in a situation when there was a change,
    // and an imported library does not define a referenced element anymore.
    // But there is still a client that holds this `LibraryElement`, and
    // its summary information says "get element X from `package:Y"; and when
    // we attempt to get it, the might be no `X` in `Y`.
  }

  test_lint_dependOnReferencedPackage_update_pubspec_addDependency() async {
    useEmptyByteStore();

    var aaaPackageRootPath = '$packagesRootPath/aaa';
    newFile('$aaaPackageRootPath/lib/a.dart', '');

    writeTestPackageConfig(
      PackageConfigFileBuilder()
        ..add(name: 'aaa', rootFolder: getFolder(aaaPackageRootPath)),
    );

    // Configure with the lint.
    writeTestPackageAnalysisOptionsFile(
      analysisOptionsContent(rules: ['depend_on_referenced_packages']),
    );

    // Configure without dependencies, but with a (required) name.
    // So, the lint rule will be activated.
    writeTestPackagePubspecYamlFile(pubspecYamlContent(name: 'my_test'));

    var code = r'''
// ignore:unused_import
import 'package:aaa/a.dart';
''';
    addTestFile(code);

    // We don't have a dependency on `package:aaa`, so there is a lint.
    await _assertTestFileDiagnostics(
      code: code,
      expected: r'''
// ignore:unused_import
import 'package:aaa/a.dart';
//     ^^^^^^^^^^^^^^^^^^^^
// [diag.dependOnReferencedPackages] The imported package 'aaa' isn't a dependency of the importing package.
''',
    );

    // The summary for the library was linked.
    _assertContainsLinkedCycle({testFile}, andClear: true);

    // We will recreate it with new pubspec.yaml content.
    // But we will reuse the byte store, so can reuse summaries.
    await disposeAnalysisContextCollection();

    // Add dependency on `package:aaa`.
    writeTestPackagePubspecYamlFile(
      pubspecYamlContent(name: 'my_test', dependencies: ['aaa']),
    );

    // With dependency on `package:aaa` added, no lint is reported.
    await _assertTestFileDiagnostics(code: code, expected: code);

    // Lints don't affect summaries, nothing should be linked.
    _assertNoLinkedCycles();
  }

  test_lints() async {
    useEmptyByteStore();

    // Configure without any lint, but without experiments as well.
    writeTestPackageAnalysisOptionsFile(analysisOptionsContent());

    var code = r'''
void f() {
  ![0].isEmpty;
}
''';

    // We don't have any lints configured, so no errors.
    await resolveTestCodeWithDiagnostics(code);

    // The summary for the library was linked.
    _assertContainsLinkedCycle({testFile}, andClear: true);

    // We will recreate it with new analysis options.
    // But we will reuse the byte store, so can reuse summaries.
    await disposeAnalysisContextCollection();

    // Configure to run a lint.
    writeTestPackageAnalysisOptionsFile(
      analysisOptionsContent(rules: ['prefer_is_not_empty']),
    );

    // Check that the lint was run, and reported.
    await resolveTestCodeWithDiagnostics(r'''
void f() {
  ![0].isEmpty;
//^^^^^^^^^^^^
// [diag.preferIsNotEmpty] Use 'isNotEmpty' rather than negating the result of 'isEmpty'.
}
''');

    // Lints don't affect summaries, nothing should be linked.
    _assertNoLinkedCycles();
  }

  void _assertContainsLinkedCycle(
    Set<File> expectedFiles, {
    bool andClear = false,
  }) {
    var expected = expectedFiles.map((file) => file.path).toSet();
    expect(_linkedCycles, contains(unorderedEquals(expected)));
    if (andClear) {
      _linkedCycles.clear();
    }
  }

  void _assertNoLinkedCycles() {
    expect(_linkedCycles, isEmpty);
  }

  Future<void> _assertTestFileDiagnostics({
    required String code,
    required String expected,
  }) async {
    // This helper intentionally doesn't write `code`.
    // The tests that use it check what happens when environment changes.
    expect(testFile.readAsStringSync(), code);

    var actual = expected_diagnostics.updateExpectedDiagnostics(
      content: code,
      actualDiagnostics: await _computeTestFileDiagnostics(),
    );
    if (actual != expected) {
      NodeTextExpectationsCollector.add(actual);
      if (NodeTextExpectationsCollector.shouldPrintFailureDetails) {
        printPrettyDiff(expected, actual);
      }
      fail('See the difference above.');
    }
  }

  /// Note that we intentionally use this method, we don't want to use
  /// [resolveFile] instead. Resolving a file will force to produce its
  /// resolved AST, and as a result to recompute the diagnostics.
  ///
  /// But this method is used to check returning diagnostics from the cache, or
  /// recomputing when the cache key is expected to be different.
  Future<List<Diagnostic>> _computeTestFileDiagnostics() async {
    var analysisSession = contextFor(testFile).currentSession;
    var errorsResult = await analysisSession.getErrors(testFile.path);
    errorsResult as ErrorsResult;
    return errorsResult.diagnostics;
  }
}

extension on AnalysisDriver {
  bool isValidLibraryElement(LibraryElement element) {
    return identical(element.session, currentSession);
  }
}