Implement reporting WarningCode.SDK_VERSION_SINCE

It is not enabled by default yet, because there are existing violations.

Bug: #34978
Change-Id: I60147d4c240d63d2f631513c8dfbd4917c35d47c
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/287660
Reviewed-by: Samuel Rawlins <[email protected]>
Commit-Queue: Konstantin Shcheglov <[email protected]>

Author: scheglov

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -2805,6 +2805,8 @@ WarningCode.SDK_VERSION_NEVER:
   notes: Deprecated
 WarningCode.SDK_VERSION_SET_LITERAL:
   status: hasFix
+WarningCode.SDK_VERSION_SINCE:
+  status: needsEvaluation
 WarningCode.SDK_VERSION_UI_AS_CODE:
   status: hasFix
 WarningCode.SDK_VERSION_UI_AS_CODE_IN_CONST_CONTEXT:

pkg/analyzer/lib/src/dart/ast/extensions.dart

@@ -165,6 +165,15 @@ extension IdentifierExtension on Identifier {
     return _readElement(this);
   }
 
+  SimpleIdentifier get simpleName {
+    final self = this;
+    if (self is SimpleIdentifier) {
+      return self;
+    } else {
+      return (self as PrefixedIdentifier).identifier;
+    }
+  }
+
   Element? get writeElement {
     return _writeElement(this);
   }

pkg/analyzer/lib/src/error/codes.g.dart

@@ -6736,6 +6736,16 @@ class WarningCode extends AnalyzerErrorCode {
     hasPublishedDocs: true,
   );
 
+  ///  Parameters:
+  ///  0: the version specified in the `@Since()` annotation
+  ///  1: the SDK version constraints
+  static const WarningCode SDK_VERSION_SINCE = WarningCode(
+    'SDK_VERSION_SINCE',
+    "This API is available since SDK {0}, but constraints '{1}' don't "
+        "guarantee it.",
+    correctionMessage: "Try updating the SDK constraints.",
+  );
+
   ///  No parameters.
   static const WarningCode SDK_VERSION_UI_AS_CODE = WarningCode(
     'SDK_VERSION_UI_AS_CODE',

pkg/analyzer/lib/src/error/error_code_values.g.dart

@@ -993,6 +993,7 @@ const List<ErrorCode> errorCodeValues = [
   WarningCode.SDK_VERSION_IS_EXPRESSION_IN_CONST_CONTEXT,
   WarningCode.SDK_VERSION_NEVER,
   WarningCode.SDK_VERSION_SET_LITERAL,
+  WarningCode.SDK_VERSION_SINCE,
   WarningCode.SDK_VERSION_UI_AS_CODE,
   WarningCode.SDK_VERSION_UI_AS_CODE_IN_CONST_CONTEXT,
   WarningCode.SUBTYPE_OF_SEALED_CLASS,

pkg/analyzer/lib/src/hint/sdk_constraint_verifier.dart

@@ -16,6 +16,9 @@ import 'package:pub_semver/pub_semver.dart';
 /// A visitor that finds code that assumes a later version of the SDK than the
 /// minimum version required by the SDK constraints in `pubspec.yaml`.
 class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
+  /// TODO(scheglov) Fix pre-existing violations and remove.
+  static bool shouldCheckSinceSdkVersion = false;
+
   /// The error reporter to be used to report errors.
   final ErrorReporter _errorReporter;
 
@@ -123,6 +126,20 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
   bool get checkUiAsCode =>
       _checkUiAsCode ??= !before_2_2_2.intersect(_versionConstraint).isEmpty;
 
+  @override
+  void visitArgumentList(ArgumentList node) {
+    // Check (optional) positional arguments.
+    // Named arguments are checked in [NamedExpression].
+    for (final argument in node.arguments) {
+      if (argument is! NamedExpression) {
+        final parameter = argument.staticParameterElement;
+        _checkSinceSdkVersion(parameter, node, errorNode: argument);
+      }
+    }
+
+    super.visitArgumentList(node);
+  }
+
   @override
   void visitAsExpression(AsExpression node) {
     if (checkConstantUpdate2018 && node.inConstantContext) {
@@ -132,6 +149,13 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     super.visitAsExpression(node);
   }
 
+  @override
+  void visitAssignmentExpression(AssignmentExpression node) {
+    _checkSinceSdkVersion(node.readElement, node);
+    _checkSinceSdkVersion(node.writeElement, node);
+    super.visitAssignmentExpression(node);
+  }
+
   @override
   void visitBinaryExpression(BinaryExpression node) {
     if (checkTripleShift) {
@@ -171,6 +195,12 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     super.visitBinaryExpression(node);
   }
 
+  @override
+  void visitConstructorName(ConstructorName node) {
+    _checkSinceSdkVersion(node.staticElement, node);
+    super.visitConstructorName(node);
+  }
+
   @override
   void visitExtensionDeclaration(ExtensionDeclaration node) {
     if (checkExtensionMethods) {
@@ -199,6 +229,12 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     _inUiAsCode = wasInUiAsCode;
   }
 
+  @override
+  void visitFunctionExpressionInvocation(FunctionExpressionInvocation node) {
+    _checkSinceSdkVersion(node.staticElement, node);
+    super.visitFunctionExpressionInvocation(node);
+  }
+
   @override
   void visitHideCombinator(HideCombinator node) {
     // Don't flag references to either `Future` or `Stream` within a combinator.
@@ -232,6 +268,30 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     super.visitMethodDeclaration(node);
   }
 
+  @override
+  void visitMethodInvocation(MethodInvocation node) {
+    _checkSinceSdkVersion(node.methodName.staticElement, node);
+    super.visitMethodInvocation(node);
+  }
+
+  @override
+  void visitNamedType(NamedType node) {
+    _checkSinceSdkVersion(node.name.staticElement, node);
+    super.visitNamedType(node);
+  }
+
+  @override
+  void visitPrefixedIdentifier(PrefixedIdentifier node) {
+    _checkSinceSdkVersion(node.staticElement, node);
+    super.visitPrefixedIdentifier(node);
+  }
+
+  @override
+  void visitPropertyAccess(PropertyAccess node) {
+    _checkSinceSdkVersion(node.propertyName.staticElement, node);
+    super.visitPropertyAccess(node);
+  }
+
   @override
   void visitSetOrMapLiteral(SetOrMapLiteral node) {
     if (node.isSet && checkSetLiterals && !_inSetLiteral) {
@@ -254,6 +314,7 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     if (node.inDeclarationContext()) {
       return;
     }
+    _checkSinceSdkVersion(node.staticElement, node);
     var element = node.staticElement;
     if (checkFutureAndStream &&
         element is InterfaceElement &&
@@ -287,6 +348,54 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     _inUiAsCode = wasInUiAsCode;
   }
 
+  void _checkSinceSdkVersion(
+    Element? element,
+    AstNode target, {
+    AstNode? errorNode,
+  }) {
+    if (!shouldCheckSinceSdkVersion) {
+      return;
+    }
+
+    if (element != null) {
+      final sinceSdkVersion = element.sinceSdkVersion;
+      if (sinceSdkVersion != null) {
+        if (!_versionConstraint.requiresAtLeast(sinceSdkVersion)) {
+          if (errorNode == null) {
+            if (target is AssignmentExpression) {
+              target = target.leftHandSide;
+            }
+            if (target is ConstructorName) {
+              errorNode = target.name ?? target.type.name.simpleName;
+            } else if (target is FunctionExpressionInvocation) {
+              errorNode = target.argumentList;
+            } else if (target is MethodInvocation) {
+              errorNode = target.methodName;
+            } else if (target is NamedType) {
+              errorNode = target.name.simpleName;
+            } else if (target is PrefixedIdentifier) {
+              errorNode = target.identifier;
+            } else if (target is PropertyAccess) {
+              errorNode = target.propertyName;
+            } else if (target is SimpleIdentifier) {
+              errorNode = target;
+            } else {
+              throw UnimplementedError('(${target.runtimeType}) $target');
+            }
+          }
+          _errorReporter.reportErrorForNode(
+            WarningCode.SDK_VERSION_SINCE,
+            errorNode,
+            [
+              sinceSdkVersion.toString(),
+              _versionConstraint.toString(),
+            ],
+          );
+        }
+      }
+    }
+  }
+
   /// Given that the [node] is only valid when the ui-as-code feature is
   /// enabled, check that the code will not be executed with a version of the
   /// SDK that does not support the feature.
@@ -309,3 +418,22 @@ class SdkConstraintVerifier extends RecursiveAstVisitor<void> {
     }
   }
 }
+
+extension on VersionConstraint {
+  bool requiresAtLeast(Version version) {
+    final self = this;
+    if (self is Version) {
+      return self == version;
+    }
+    if (self is VersionRange) {
+      final min = self.min;
+      if (min == null) {
+        return false;
+      } else {
+        return min >= version;
+      }
+    }
+    // We don't know, but will not complain.
+    return true;
+  }
+}

pkg/analyzer/messages.yaml

@@ -22889,6 +22889,13 @@ WarningCode:
       ```dart
       var s = new Set<int>();
       ```
+  SDK_VERSION_SINCE:
+    problemMessage: "This API is available since SDK {0}, but constraints '{1}' don't guarantee it."
+    correctionMessage: Try updating the SDK constraints.
+    comment: |-
+      Parameters:
+      0: the version specified in the `@Since()` annotation
+      1: the SDK version constraints
   SDK_VERSION_UI_AS_CODE:
     problemMessage: "The for, if, and spread elements weren't supported until version 2.3.0, but this code is required to be able to run on earlier versions."
     correctionMessage: Try updating the SDK constraints.

pkg/analyzer/test/src/diagnostics/sdk_constraint_verifier_support.dart

@@ -20,4 +20,17 @@ class SdkConstraintVerifierTest extends PubPackageResolutionTest {
 
     await assertErrorsInCode(source, expectedErrors ?? []);
   }
+
+  /// Verify that the [expectedErrors] are produced if the [source] is analyzed
+  /// in a context that uses given SDK [constraints].
+  Future<void> verifyVersion2(String constraints, String source,
+      {List<ExpectedError>? expectedErrors}) async {
+    writeTestPackagePubspecYamlFile(
+      PubspecYamlFileConfig(
+        sdkVersion: constraints,
+      ),
+    );
+
+    await assertErrorsInCode(source, expectedErrors ?? []);
+  }
 }