Merge branch 'master' into 2.56.1

Author: elliette

.agents/skills/adding-release-notes/SKILL.md

@@ -0,0 +1,87 @@
+---
+name: adding-release-notes
+description: Adds user-facing change descriptions to DevTools release notes. Use when documenting improvements, fixes, or new features in the NEXT_RELEASE_NOTES.md file.
+---
+
+# Adding Release Notes
+
+This skill helps automate adding release notes to `packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md`.
+
+## Workflow
+Copy this checklist into your response to track progress:
+
+```markdown
+Release Notes Progress:
+- [ ] Step 1: Formulate the entry (past tense)
+- [ ] Step 2: Find the PR number (if not already known)
+- [ ] Step 3: Determine the section (Inspector, Memory, etc.)
+- [ ] Step 4: Add the entry (use scripts/add_note.dart)
+- [ ] Step 5: Add images (if applicable)
+```
+
+## Guidelines
+
+### 1. Identify the PR Number
+If the PR number is unknown, use the following methods to find it:
+- **Local Branch**: Identify the branch name using `git branch` or `git log`. If the branch is pushed to origin, it often has a linked PR.
+- **GitHub CLI (`gh`)**: Use the GitHub CLI to find the PR associated with the current branch.
+  - **IMPORTANT**: Always use `PAGER=cat` to prevent `gh` from hanging in non-interactive terminals.
+  - Command: `PAGER=cat gh pr list --head <branch_name> --json number,title`
+- **Search by Change Description**: Search open PRs using keywords from your change title or description.
+  - Command: `PAGER=cat gh pr list --search "<keywords>" --limit 5`
+- **Web Search**: If CLI tools fail, use `search_web` to find the PR on GitHub:
+  - Query: `site:github.com/flutter/devtools "Add support for searching within the log details view"`
+
+### 2. Formulate the Entry
+- **Tense**: Always use **past tense** (e.g., "Added", "Improved", "Fixed").
+- **Punctuation**: Always end entries with a **period**.
+- **Template**: `* <Description>. [#<PR_NUMBER>](https://github.com/flutter/devtools/pull/<PR_NUMBER>)`
+- **Placeholder**: Use `TODO` if you have exhausted all search methods and the PR has not been created yet.
+- **Images**: If adding an image, indent it by two spaces to align with the bullet point, and ensure there is only one newline between the text and the image.
+  - Correct Format:
+    ```markdown
+    - Added support for XYZ. [#TODO](https://github.com/flutter/devtools/pull/TODO)
+      ![](images/my_feature.png)
+    ```
+- **Examples**:
+  - `* Added support for XYZ. [#12345](https://github.com/flutter/devtools/pull/12345)`
+  - `* Fixed a crash in the ABC screen. [#67890](https://github.com/flutter/devtools/pull/67890)`
+
+### 3. User-Facing Changes Only
+- **Criteria**: Focus on **what** changed for the user, not **how** it was implemented.
+- **Avoid**: Technical details like "Implemented XYZ with a new controller", "Updated the build method", or naming internal classes.
+- **Example (Bad)**: `* Implemented log details search using SearchControllerMixin. [#TODO](https://github.com/flutter/devtools/pull/TODO)`
+- **Example (Good)**: `* Added search support to the log details view. [#TODO](https://github.com/flutter/devtools/pull/TODO)`
+
+### 4. Determine Section
+Match the change to the section in `NEXT_RELEASE_NOTES.md`:
+- `General updates`
+- `Inspector updates`
+- `Performance updates`
+- `CPU profiler updates`
+- `Memory updates`
+- `Debugger updates`
+- `Network profiler updates`
+- `Logging updates`
+- `App size tool updates`
+- `Deep links tool updates`
+- `VS Code sidebar updates`
+- `DevTools extension updates`
+- `Advanced developer mode updates`
+
+### 5. Add to NEXT_RELEASE_NOTES.md
+Use the provided utility script to insert the note safely. The script handles replacing the TODO placeholder if it's the first entry in that section.
+
+```bash
+dart .agents/skills/adding-release-notes/scripts/add_note.dart "Inspector updates" "Added XYZ support" TODO
+```
+
+### 6. Optional: Images
+Add images to `packages/devtools_app/release_notes/images/` and reference them:
+```markdown
+![Accessible description](images/screenshot.png "Hover description")
+```
+**Constraint**: Use **dark mode** for screenshots.
+
+## Resources
+- [README.md](../../packages/devtools_app/release_notes/README.md): Official project guidance.

.agents/skills/adding-release-notes/scripts/add_note.dart

@@ -0,0 +1,72 @@
+// Copyright 2019 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file or at https://developers.google.com/open-source/licenses/bsd.
+
+import 'dart:io';
+
+void main(List<String> args) {
+  if (args.length < 3) {
+    print('Usage: dart add_note.dart <section> <note> <pr_number>');
+    exit(1);
+  }
+
+  final section = args[0].trim();
+  final note = args[1].trim();
+  final pr = args[2].trim();
+
+  final prLink = pr == 'TODO' 
+      ? '[TODO](https://github.com/flutter/devtools/pull/TODO)'
+      : '[#$pr](https://github.com/flutter/devtools/pull/$pr)';
+
+  final filePath = 'packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md';
+  final file = File(filePath);
+
+  if (!file.existsSync()) {
+    print('Error: $filePath not found.');
+    exit(1);
+  }
+
+  var content = file.readAsStringSync();
+
+  if (!content.contains('## $section')) {
+    print("Error: Section '$section' not found.");
+    exit(1);
+  }
+
+  final noteWithPeriod = note.endsWith('.') ? note : '$note.';
+  final newEntry = '- $noteWithPeriod $prLink\n';
+
+  // Check for TODO placeholder.
+  const todoText = 'TODO: Remove this section if there are not any updates.';
+  final todoPattern = RegExp(
+    '## ${RegExp.escape(section)}\\s*\\n\\s*${RegExp.escape(todoText)}\\s*\\n*',
+  );
+
+  if (todoPattern.hasMatch(content)) {
+    content = content.replaceFirst(todoPattern, '## $section\n\n$newEntry\n');
+  } else {
+    // Append to existing list in the section.
+    final sectionHeader = '## $section';
+    final sectionStart = content.indexOf(sectionHeader);
+
+    // Find the next section start or the end of the file.
+    var nextSectionStart = content.indexOf('\n## ', sectionStart + 1);
+    if (nextSectionStart == -1) {
+      nextSectionStart =
+          content.indexOf('\n# Full commit history', sectionStart + 1);
+    }
+    if (nextSectionStart == -1) {
+      nextSectionStart = content.length;
+    }
+
+    var sectionContent =
+        content.substring(sectionStart, nextSectionStart).trimRight();
+    sectionContent += '\n$newEntry';
+
+    content =
+        '${content.substring(0, sectionStart)}$sectionContent\n${content.substring(nextSectionStart).trimLeft()}';
+  }
+
+  file.writeAsStringSync(content);
+  print('Successfully added note to $section.');
+}

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,19 +1,46 @@
-*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*
-
 *List which issues are fixed by this PR.*
 
-*Please add a note to `packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md` if your change requires release notes. Otherwise, add the 'release-notes-not-required' label to the PR.*
+*Replace this paragraph with a description of what this PR is changing or adding, and why. If your PR is updating any UI functionality, please include include before/after screenshots and/or a gif of the UI interaction.*
 
 ## Pre-launch Checklist
 
+### General checklist
+
 - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
 - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities.
 - [ ] I read the [Flutter Style Guide] _recently_, and have followed its advice.
 - [ ] I signed the [CLA].
-- [ ] I listed at least one issue that this PR fixes in the description above.
 - [ ] I updated/added relevant documentation (doc comments with `///`).
-- [ ] I added new tests to check the change I am making, or there is a reason for not adding tests.
 
+### Issues checklist
+
+- [ ] I listed at least one issue that this PR fixes in the description above.
+- [ ] I listed at least one issue which has the [`contributions-welcome`] or [`good-first-issue`] label. 
+- [ ] I did not list at least one issue with the [`contributions-welcome`] or [`good-first-issue`] label. I understand this means my PR might take longer to be reviewed. 
+
+### Tests checklist
+
+- [ ] I added new tests to check the change I am making...
+- [ ] OR there is a reason for not adding tests, which I explained in the PR description.
+
+### AI-tooling checklist
+
+- [ ] I did not use any AI tooling in creating this PR.
+- [ ] OR I did use AI tooling, and...
+    * [ ] I read the [AI contributions guidelines] and agree to follow them.
+    * [ ] I reviewed all AI-generated code before opening this PR.
+    * [ ] I understand and am able to discuss the code in this PR.
+    * [ ] I have verifed the accuracy of any AI-generated text included in the PR description.
+    * [ ] I commit to verifying the accuracy of any AI-generated code or text that I upload in response to review comments.
+
+### Feature-change checklist 
+
+- [ ] This PR does not change the DevTools UI or behavior and...
+    * [ ] I added the `release-notes-not-required` label or left a comment requesting the label be added.
+- [ ] OR this PR does change the DevTools UI or behavior and...
+    * [ ] I added an entry to `packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md`.
+    * [ ] I included before/after screenshots and/or a GIF demo of the new UI to my PR description.
+    * [ ] I ran the DevTools app locally to manually verify my changes.
 
 ![build.yaml badge]
 
@@ -24,5 +51,8 @@ If you need help, consider asking for help on [Discord].
 [Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md
 [Flutter Style Guide]: https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
 [CLA]: https://cla.developers.google.com/
-[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
+[`contributions-welcome`]: https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Acontributions-welcome
+[`good-first-issue`]: https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Agood-first-issue
+[AI contributions guideline]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
 [build.yaml badge]: https://github.com/flutter/devtools/actions/workflows/build.yaml/badge.svg
+[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md

.gitignore

@@ -8,6 +8,7 @@
 # Exclude pubspec.lock files in tests and example fixtures.
 packages/devtools_app/test/**/pubspec.lock
 packages/devtools_extensions/example/**/pubspec.lock
+third_party/**/pubspec.lock
 
 .idea/
 .data_dir/

CONTRIBUTING.md

@@ -22,6 +22,10 @@ We gladly accept contributions via GitHub pull requests! We encourage you to rea
 framework's contributing guide, as all of that information applies to contributing to the `flutter/devtools`
 repo as well.
 
+We prioritize reviewing PRs that address issues with the following labels:
+* [`good-first-issue`](https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Agood-first-issue): Small and easy issues that can be tackled by a first-time contributor.
+* [`contributions-welcome`](https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Acontributions-welcome): Issues of any size or difficulty that we consider high-priority fixes.
+
 We communicate primarily over GitHub and [Discord](https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md) on the
 [#hackers-devtools](https://discord.com/channels/608014603317936148/1106667330093723668) channel.
 

flutter-candidate.txt

@@ -1 +1 @@
-3.42.0-0.4.pre
+f84b3c836acca76cb163a2d1174ab32a1e73cb11

packages/devtools_app/benchmark/devtools_benchmarks_test.dart

@@ -9,6 +9,7 @@ import 'dart:convert' show JsonEncoder;
 import 'dart:io';
 
 import 'package:collection/collection.dart';
+import 'package:devtools_test/helpers.dart';
 import 'package:test/test.dart';
 import 'package:web_benchmarks/metrics.dart';
 import 'package:web_benchmarks/server.dart';
@@ -44,29 +45,51 @@ void main() {
       },
       timeout: const Timeout(Duration(minutes: 15)),
       retry: 0,
-      // TODO(elliette): Re-enable once flakiness is addressed.
-      skip: 'https://github.com/flutter/devtools/issues/9674',
     );
   }
 }
 
 Future<void> _runBenchmarks({bool useWasm = false}) async {
   stdout.writeln('Starting web benchmark tests ...');
 
-  final benchmarkPort = await _findAvailablePort(startingAt: 9999);
-  final chromePort = await _findAvailablePort(startingAt: benchmarkPort + 1);
+  var benchmarkPort = await _findAvailablePort(startingAt: 9999);
+  var chromePort = await _findAvailablePort(startingAt: benchmarkPort + 1);
 
-  final taskResult = await serveWebBenchmark(
-    benchmarkAppDirectory: projectRootDirectory(),
-    entryPoint: generateBenchmarkEntryPoint(useWasm: useWasm),
-    compilationOptions: useWasm
-        ? const CompilationOptions.wasm()
-        : const CompilationOptions.js(),
-    treeShakeIcons: false,
-    benchmarkPath: benchmarkPath(useWasm: useWasm),
-    benchmarkServerPort: benchmarkPort,
-    chromeDebugPort: chromePort,
+  // TODO(elliette): Retry logic can likely be removed after
+  // https://github.com/flutter/flutter/issues/183335 is resolved.
+  final taskResult = await retryAsync<BenchmarkResults?>(
+    () async {
+      try {
+        logStatus(
+          'Serving benchmarks (server port: $benchmarkPort, chrome port: $chromePort)',
+        );
+        return await serveWebBenchmark(
+          benchmarkAppDirectory: projectRootDirectory(),
+          entryPoint: generateBenchmarkEntryPoint(useWasm: useWasm),
+          compilationOptions: useWasm
+              ? const CompilationOptions.wasm()
+              : const CompilationOptions.js(),
+          treeShakeIcons: false,
+          benchmarkPath: benchmarkPath(useWasm: useWasm),
+          benchmarkServerPort: benchmarkPort,
+          chromeDebugPort: chromePort,
+        );
+      } catch (e) {
+        logStatus('Serving benchmarks failed with error: $e');
+        return null;
+      }
+    },
+    condition: (result) => result != null,
+    onRetry: () async {
+      logStatus('Retrying with new ports...');
+      benchmarkPort = await _findAvailablePort(startingAt: chromePort + 1);
+      chromePort = await _findAvailablePort(startingAt: benchmarkPort + 1);
+    },
   );
+  if (taskResult == null) {
+    throw Exception('Failed to serve benchmarks after retries.');
+  }
+
   stdout.writeln('Web benchmark tests finished.');
 
   expect(

packages/devtools_app/lib/devtools.dart

@@ -10,4 +10,4 @@
 /// Note: a regexp in the `dt update-version' command logic matches the constant
 /// declaration `const version =`. If you change the declaration you must also
 /// modify the regex in the `dt update-version' command logic.
-const version = '2.56.1';
+const version = '2.57.0-dev.0';

packages/devtools_app/lib/src/extensions/extension_screen.dart

@@ -132,6 +132,8 @@ class ExtensionView extends StatelessWidget {
 
 extension ExtensionConfigExtension on DevToolsExtensionConfig {
   IconData get icon =>
+      // The code point is dynamic. Flutter Icon Tree Shaking disabled.
+      // ignore: non_const_argument_for_const_parameter
       IconData(materialIconCodePoint, fontFamily: 'MaterialIcons');
 
   String get screenId => '${name}_ext';