flutter · LongCatIsLooong · Jun 29, 2023 · Jun 29, 2023 · Jun 30, 2023 · Jun 30, 2023
diff --git a/dev/bots/analyze.dart b/dev/bots/analyze.dart
@@ -173,7 +173,7 @@ Future<void> run(List<String> arguments) async {
     // Only run the private lints when the code is free of type errors. The
     // lints are easier to write when they can assume, for example, there is no
     // inheritance cycles.
-    final List<AnalyzeRule> rules = <AnalyzeRule>[noDoubleClamp, noStopwatches];
+    final List<AnalyzeRule> rules = <AnalyzeRule>[noDoubleClamp, noStopwatches, debugAssert];
     final String ruleNames = rules.map((AnalyzeRule rule) => '\n * $rule').join();
     printProgress('Analyzing code in the framework with the following rules:$ruleNames');
     await analyzeWithRules(flutterRoot, rules,

diff --git a/dev/bots/custom_rules/debug_assert.dart b/dev/bots/custom_rules/debug_assert.dart
diff --git a/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_access.dart b/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_access.dart
@@ -0,0 +1,140 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'debug_only_lib.dart';
+
+const Null debugAssert = null;
+
+final ProductionClassWithDebugOnlyMixin x = ProductionClassWithDebugOnlyMixin();
+ProductionClassWithDebugOnlyMixin? xx;
+ProductionClassWithDebugOnlyMixin y = ProductionClassWithDebugOnlyMixin();
+void takeAnything(Object? input) { }
+
+void badDebugAssertAccess() {
+  globalVariableFromDebugLib += 'test';
+  globalFunctionFromDebugLib();
+  void Function() f = globalFunctionFromDebugLib; // ignore: unused_local_variable
+  f = globalFunctionFromDebugLib.call;
+  MixinFromDebugLib.staticMethodFromDebugLib();
+  f = MixinFromDebugLib.staticMethodFromDebugLib;
+  x.fieldFromDebugLib; // ignore: unnecessary_statements
+  xx?.fieldFromDebugLib; // ignore: unnecessary_statements
+  x.debugGetSet;
+  xx?.debugGetSet;
+  x.debugGetSet = 2;
+  xx?.debugGetSet = 2;
+  x..fieldFromDebugLib += x.debugGetSet
+   ..debugGetSet += x.debugGetSet;
+  xx?..fieldFromDebugLib += x.debugGetSet
+   ..debugGetSet += x.debugGetSet;
+  takeAnything(xx?.methodFromDebugLib);
+  x.debugOnlyExtensionMethod();
+  takeAnything(xx?.debugOnlyExtensionMethod);
+  DebugOnlyEnum.foo; // ignore: unnecessary_statements
+  DebugOnlyEnum.values; // ignore: unnecessary_statements
+  RegularEnum.foo.debugOnlyMethod();
+
+  // Overridden Operators
+  x + x; // ignore: unnecessary_statements
+  xx! + xx!; // ignore: unnecessary_statements
+  y += x;
+  y += xx!;
+  ~x; // ignore: unnecessary_statements
+  ~xx!; // ignore: unnecessary_statements
+  x[x.debugGetSet]; // ignore: unnecessary_statements
+  xx?[x.debugGetSet]; // ignore: unnecessary_statements
+}
+
+/// Yours truly [globalVariableFromDebugLib] from the comment section with love.
+void goodDebugAssertAccess() {
+  assert(() {
+    final _DebugOnlyClass debugObject = _DebugOnlyClass();
+    debugObject
+      .debugOnlyMemberMethod();
+    final void Function() f = debugObject.debugOnlyMemberMethod;
+    f();
+    return true;
+  }());
+
+  final ProductionClassWithDebugOnlyMixin x = ProductionClassWithDebugOnlyMixin() // ignore: unused_local_variable
+    ..run();
+    RegularEnum.foo; // ignore: unnecessary_statements
+}
+
+mixin class BaseClass {
+  void run() { }
+  void stop() { }
+
+  int get value => 0;
+
+  int operator ~() => ~value;
+}
+
+@debugAssert
+class _DebugOnlyClass extends BaseClass {
+  void debugOnlyMemberMethod() {}
+}
+
+class ProductionClassWithDebugOnlyMixin extends _DebugOnlyClass with MixinFromDebugLib {
+  @override
+  ProductionClassWithDebugOnlyMixin operator +(ProductionClassWithDebugOnlyMixin rhs) {
+    return ProductionClassWithDebugOnlyMixin()
+      ..debugGetSet = debugGetSet + rhs.debugGetSet
+      ..fieldFromDebugLib = fieldFromDebugLib + rhs.fieldFromDebugLib;
+  }
+}
+
+mixin MixinOnBaseClass implements BaseClass {
+  void runAndStop() {
+    run();
+    stop();
+  }
+
+  @debugAssert
+  @override
+  int get value => -1;         // bad annotation.
+
+  @debugAssert
+  @override
+  int operator ~() => ~value;  // bad annotation.
+}
+
+class ClassWithBadAnnotation1 extends BaseClass with MixinOnBaseClass {
+  @debugAssert
+  @override
+  void run() {  }             // bad annotation.
+
+  void run1() {  }
+}
+
+class ClassWithBadAnnotation2 with MixinOnBaseClass {
+  @debugAssert
+  @override
+  void run() {  }             // bad annotation.
+
+  @override
+  void stop() {  }
+
+  @override
+  int get value => -1;
+}
+
+@debugAssert
+extension DebugOnly on ProductionClassWithDebugOnlyMixin {
+  void debugOnlyExtensionMethod() {  }
+}
+
+@debugAssert
+enum DebugOnlyEnum with BaseClass {
+  foo
+}
+
+@debugAssert
+mixin DebugOnlyMixinOnRegularEnum {
+  void debugOnlyMethod() {}
+}
+
+enum RegularEnum with DebugOnlyMixinOnRegularEnum {
+  foo
+}
diff --git a/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_constructors.dart b/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_constructors.dart
@@ -0,0 +1,73 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'debug_only_lib.dart';
+
+const Object debugAssert = Object();
+
+class ProductionClass11 extends ClassFromDebugLibWithNamedConstructor {
+  ProductionClass11() : super.constructor(); // bad: debug-only constructor invoked
+}
+
+class ProductionClass21 extends ClassFromDebugLibWithImplicitDefaultConstructor {
+  ProductionClass21(); // Good: super() is synthesized thus not considered debug-only.
+}
+
+class ProductionClass22 extends ClassFromDebugLibWithImplicitDefaultConstructor { }
+
+class ProductionClass31 extends ClassFromDebugLibWithExplicitDefaultConstructor {
+  ProductionClass31();       // Bad: super() is not synthesized.
+  ProductionClass31.named(); // Bad: super() is not synthesized.
+}
+
+class ProductionClass32 extends ClassFromDebugLibWithExplicitDefaultConstructor { }
+
+class ProductionClass41 extends ClassFromDebugLibWithExplicitConstructorAndFormalParameters {
+  ProductionClass41.named(super.value); // Bad: super(int value) is not synthesized.
+}
+
+class ProductionClass5 {
+  ProductionClass5(this.debugOnlyField);                      // Bad: accessing debug-only field.
+  ProductionClass5.named(int value) : debugOnlyField = value; // Bad: accessing debug-only field.
+
+  @debugAssert
+  final int debugOnlyField;
+}
+
+class ProductionClass33 implements ClassFromDebugLibWithExplicitDefaultConstructor { }
+
+class _DebugOnlyClass1 implements ProductionClassWithFactoryConstructors { }
+@debugAssert
+class _DebugOnlyClass2 implements ProductionClassWithFactoryConstructors {
+  _DebugOnlyClass2();
+}
+class _DebugOnlyClass3 implements ProductionClassWithFactoryConstructors {
+  @debugAssert
+  const _DebugOnlyClass3.named();
+  // ignore: unused_element
+  const _DebugOnlyClass3.nonDebug() : this.named(); // Bad: named is a debug-only constructor.
+}
+
+class ProductionClassWithFactoryConstructors {
+  // good.
+  factory ProductionClassWithFactoryConstructors.named1() = _DebugOnlyClass1;
+  // bad.
+  factory ProductionClassWithFactoryConstructors.named2() = _DebugOnlyClass2;
+  // bad.
+  factory ProductionClassWithFactoryConstructors.named3() = _DebugOnlyClass3.named;
+}
+
+void takeAnything(Object? input) { }
+
+void testConstructors() {
+  // With named constructor.
+  ProductionClass11();
+  // With synthesized default constructor.
+  ProductionClass21(); // good: the constructor isn't defined by the super class.
+  ProductionClass22(); // good: the constructor isn't defined by the super class.
+  // With explicit default constructor.
+  ProductionClass32(); // bad: the constructor is defined by the super class thus marked as debug-only.
+  takeAnything(ProductionClass32.new); // Also bad for the same reason.
+  ProductionClass33(); // good: the debug-only constructor is not inherited.
+}
diff --git a/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_lib.dart b/dev/bots/test/analyze-test-input/root/packages/flutter/lib/debug_only_lib.dart
@@ -0,0 +1,49 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+@debugAssert
+library;
+
+const String debugAssert = '';
+
+String globalVariableFromDebugLib = '';
+
+void globalFunctionFromDebugLib() { }
+
+mixin MixinFromDebugLib {
+  static int staticVarFromDebugLib = 0;
+
+  static void staticMethodFromDebugLib() {  }
+
+  int fieldFromDebugLib = 0;
+
+  int get debugGetSet => _debugGetSet;
+  int _debugGetSet = 0;
+  set debugGetSet(int value) => _debugGetSet = value;
+
+  void methodFromDebugLib() { }
+
+  MixinFromDebugLib operator +(covariant MixinFromDebugLib rhs);
+
+  int operator ~() => ~debugGetSet;
+
+  int operator [](int index) => index;
+}
+
+class ClassFromDebugLibWithNamedConstructor {
+  ClassFromDebugLibWithNamedConstructor.constructor();
+}
+
+class ClassFromDebugLibWithImplicitDefaultConstructor { }
+
+class ClassFromDebugLibWithExplicitDefaultConstructor {
+  ClassFromDebugLibWithExplicitDefaultConstructor();
+}
+
+class ClassFromDebugLibWithExplicitConstructorAndFormalParameters {
+  //ignore: avoid_unused_constructor_parameters
+  ClassFromDebugLibWithExplicitConstructorAndFormalParameters(int value);
+  //ignore: avoid_unused_constructor_parameters
+  ClassFromDebugLibWithExplicitConstructorAndFormalParameters.named(String value);
+}
diff --git a/dev/bots/test/analyze_test.dart b/dev/bots/test/analyze_test.dart
@@ -8,6 +8,7 @@ import 'package:path/path.dart' as path;
 
 import '../analyze.dart';
 import '../custom_rules/analyze.dart';
+import '../custom_rules/debug_assert.dart';
 import '../custom_rules/no_double_clamp.dart';
 import '../custom_rules/no_stop_watches.dart';
 import '../utils.dart';
@@ -267,4 +268,97 @@ void main() {
       '╚═══════════════════════════════════════════════════════════════════════════════\n'
     );
   });
+
+  test('analyze.dart - debugAssert', () async {
+    final String result = await capture(() => analyzeWithRules(
+      testRootPath,
+      <AnalyzeRule>[debugAssert],
+      includePaths: <String>['packages/flutter/lib'],
+    ), shouldHaveErrors: true);
+
+    final String badAnnotations = <String>[
+      '║ packages/flutter/lib/debug_only_access.dart: class member BaseClass.value is not annotated wtih @debugAssert, but its override MixinOnBaseClass.value is.',
+      '║ packages/flutter/lib/debug_only_access.dart: class member BaseClass.~ is not annotated wtih @debugAssert, but its override MixinOnBaseClass.~ is.',
+      '║ packages/flutter/lib/debug_only_access.dart: class member BaseClass.run is not annotated wtih @debugAssert, but its override ClassWithBadAnnotation1.run is.',
+      '║ packages/flutter/lib/debug_only_access.dart: class member BaseClass.run is not annotated wtih @debugAssert, but its override ClassWithBadAnnotation2.run is.',
+    ]
+    .map((String line) => line.replaceAll('/', Platform.isWindows ? r'\' : '/'))
+    .join('\n');
+
+    expect(result,
+      startsWith(
+        '╔═╡ERROR╞═══════════════════════════════════════════════════════════════════════\n'
+        '║ Overriding a framework class member that was not annotated with @debugAssert and marking the override @debugAssert is not allowed.\n'
+        '║ A framework method/getter/setter not marked as debug-only itself cannot have a debug-only override.\n'
+        '║ \n'
+        '$badAnnotations\n'
+        '║ \n'
+        '║ Consider either removing the @debugAssert annotation, or adding the annotation to the class member that is being overridden instead.\n'
+        '╚═══════════════════════════════════════════════════════════════════════════════\n'
+      )
+    );
+
+    final String badConstructorAccesses = <String>[
+      '║ packages/flutter/lib/debug_only_constructors.dart:10: ClassFromDebugLibWithNamedConstructor.constructor accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:20: ClassFromDebugLibWithExplicitDefaultConstructor.new accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:21: ClassFromDebugLibWithExplicitDefaultConstructor.new accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:27: ClassFromDebugLibWithExplicitConstructorAndFormalParameters.new accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:31: debugOnlyField accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:32: debugOnlyField accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:49: _DebugOnlyClass3.named accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:56: _DebugOnlyClass2.new accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:58: _DebugOnlyClass3.named accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:70: ProductionClass32.new accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_constructors.dart:71: ProductionClass32.new accessed outside of an assert.\n',
+    ].map((String line) => line.replaceAll('/', Platform.isWindows ? r'\' : '/'))
+     .join();
+
+    final String otherBadAccesses = <String>[
+      '║ packages/flutter/lib/debug_only_access.dart:15: globalVariableFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:15: globalVariableFromDebugLib= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:16: globalFunctionFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:17: globalFunctionFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:18: globalFunctionFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:19: MixinFromDebugLib.staticMethodFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:20: MixinFromDebugLib.staticMethodFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:21: MixinFromDebugLib.fieldFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:22: MixinFromDebugLib.fieldFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:23: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:24: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:25: MixinFromDebugLib.debugGetSet= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:26: MixinFromDebugLib.debugGetSet= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:27: MixinFromDebugLib.fieldFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:27: MixinFromDebugLib.fieldFromDebugLib= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:27: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:28: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:28: MixinFromDebugLib.debugGetSet= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:28: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:29: MixinFromDebugLib.fieldFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:29: MixinFromDebugLib.fieldFromDebugLib= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:29: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:30: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:30: MixinFromDebugLib.debugGetSet= accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:30: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:31: MixinFromDebugLib.methodFromDebugLib accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:32: debugOnlyExtensionMethod accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:33: debugOnlyExtensionMethod accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:34: DebugOnlyEnum.foo accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:35: DebugOnlyEnum.values accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:36: DebugOnlyMixinOnRegularEnum.debugOnlyMethod accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:39: ProductionClassWithDebugOnlyMixin.+ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:40: ProductionClassWithDebugOnlyMixin.+ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:41: ProductionClassWithDebugOnlyMixin.+ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:42: ProductionClassWithDebugOnlyMixin.+ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:43: MixinFromDebugLib.~ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:44: MixinFromDebugLib.~ accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:45: MixinFromDebugLib.[] accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:45: MixinFromDebugLib.debugGetSet accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:46: MixinFromDebugLib.[] accessed outside of an assert.\n',
+      '║ packages/flutter/lib/debug_only_access.dart:46: MixinFromDebugLib.debugGetSet accessed outside of an assert.',
+    ].map((String line) => line.replaceAll('/', Platform.isWindows ? r'\' : '/'))
+     .join();
+
+    expect(result, contains(badConstructorAccesses));
+    expect(result, contains(otherBadAccesses));
+  });
 }