Skip to content

Conversation

@pq
Copy link
Member

@pq pq commented Oct 29, 2025

Noodling on a retargetable idePluginEvent.

Example uses might look like:

Flutter App Actions (Reload, Restart, ReloadAll, RestartAll)

Event.idePluginEvent(
          name: "Flutter.ReloadFlutterApp", // ReloadFlutterApp.ID
          ide: IDE.intellij,
          additionalData: ActionData(
            // A user may ask for a reload but we determined that a restart is necessary.
            requiredRestart: true,
            // Whether invoked from the 'GoToAction' dialog
            goToAction: false,
          ),
        );

Event.idePluginEvent(
          name: "Flutter.RestartFlutterApp", // RestartFlutterApp.ID
          ide: IDE.intellij,
          additionalData: ActionData(
            // Google3 support needs to be explicitly enabled.
            google3: true,
          ),
        );

Flutter SDK Actions (Attach Debugger, Clean, Doctor, etc.)

Event.idePluginEvent(
          name: "Flutter.FlutterCleanAction",
          ide: IDE.intellij,
          additionalData: ActionData(
            // Flutter clean can only be run within a directory with a pubspec.yaml file
            pubRootFound: false,
          ),
        );

Event.idePluginEvent(
          name: "Flutter.FlutterDoctorAction",
          ide: IDE.intellij,
          additionalData: ActionData(
            bazelContext: true,
            // Script not found in the flutter.json file.
            doctorScriptFound: false,
          ),
        );

Feedback and input most welcome!


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

Note: The Dart team is trialing Gemini Code Assist. Don't take its comments as final Dart team feedback. Use the suggestions if they're helpful; otherwise, wait for a human reviewer.

@pq pq requested review from a team and bkonyi as code owners October 29, 2025 18:39
@pq pq marked this pull request as draft October 29, 2025 18:40
@pq pq requested review from bwilkerson and keertip October 29, 2025 18:40
@github-actions
Copy link

github-actions bot commented Oct 29, 2025

Package publishing

Package Version Status Publish tag (post-merge)
package:bazel_worker 1.1.4 already published at pub.dev
package:benchmark_harness 2.4.0-wip WIP (no publish necessary)
package:boolean_selector 2.1.2 already published at pub.dev
package:browser_launcher 1.1.3 already published at pub.dev
package:cli_config 0.2.1-wip WIP (no publish necessary)
package:cli_util 0.5.0-wip WIP (no publish necessary)
package:clock 1.1.3-wip WIP (no publish necessary)
package:code_builder 4.11.0 already published at pub.dev
package:coverage 1.15.0 already published at pub.dev
package:csslib 1.0.2 already published at pub.dev
package:extension_discovery 2.1.0 already published at pub.dev
package:file 7.0.2-wip WIP (no publish necessary)
package:file_testing 3.1.0-wip WIP (no publish necessary)
package:glob 2.1.3 already published at pub.dev
package:graphs 2.3.3-wip WIP (no publish necessary)
package:html 0.15.7-wip WIP (no publish necessary)
package:io 1.1.0-wip WIP (no publish necessary)
package:json_rpc_2 4.0.0 already published at pub.dev
package:markdown 7.3.1-wip WIP (no publish necessary)
package:mime 2.0.0 already published at pub.dev
package:oauth2 2.0.5 already published at pub.dev
package:package_config 2.3.0-wip WIP (no publish necessary)
package:pool 1.5.2 already published at pub.dev
package:process 5.0.5 already published at pub.dev
package:pub_semver 2.2.0 already published at pub.dev
package:pubspec_parse 1.5.1-wip WIP (no publish necessary)
package:source_map_stack_trace 2.1.3-wip WIP (no publish necessary)
package:source_maps 0.10.14-wip WIP (no publish necessary)
package:source_span 1.10.1 already published at pub.dev
package:sse 4.1.8 already published at pub.dev
package:stack_trace 1.12.2-wip (error) pubspec version (1.12.2-wip) and changelog (1.12.2-dev) don't agree
package:stream_channel 2.1.4 already published at pub.dev
package:stream_transform 2.1.2-wip WIP (no publish necessary)
package:string_scanner 1.4.1 already published at pub.dev
package:term_glyph 1.2.3-wip WIP (no publish necessary)
package:test_reflective_loader 0.5.0 ready to publish test_reflective_loader-v0.5.0
package:timing 1.0.2 already published at pub.dev
package:unified_analytics 9.0.0 ready to publish unified_analytics-v9.0.0
package:watcher 1.1.5-wip WIP (no publish necessary)
package:yaml 3.1.3 already published at pub.dev
package:yaml_edit 2.2.2 already published at pub.dev

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new Event.idePluginEvent for analytics from IDE plugins, which is a great addition. The implementation is clear, follows existing patterns, and is accompanied by a new test case. My main concern is that a maintenance test that verifies constructor coverage (Confirm all constructors were checked in event_test.dart) seems to have been missed. It needs to be updated to account for the new constructor to prevent test failures. I've also pointed out a minor typo in a description string.

@pq pq requested a review from helin24 October 29, 2025 18:42
@github-actions
Copy link

github-actions bot commented Oct 29, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
unified_analytics Breaking 8.0.5 9.0.0 9.0.0 ✔️

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

Coverage ⚠️
File Coverage
pkgs/unified_analytics/lib/src/constants.dart 💔 Not covered
pkgs/unified_analytics/lib/src/enums.dart 💚 100 %
pkgs/unified_analytics/lib/src/event.dart 💚 98 % ⬆️ 0 %

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ⚠️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources
unified_analytics Condition survey_handler.dart::Survey::conditionList
survey_handler.dart::Survey::new::conditionList
unified_analytics PersistedSurvey survey_handler.dart::SurveyHandler::fetchPersistedSurveys
unified_analytics GAClient analytics.dart::Analytics::fake::gaClient
analytics.dart::AnalyticsImpl::new::gaClient
unified_analytics UserProperty analytics.dart::FakeAnalytics::userProperty

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️
// Copyright (c) 2025, 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.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/bazel_worker/benchmark/benchmark.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/coverage/lib/src/coverage_options.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/html/test/trie_test.dart
pkgs/html/tool/generate_trie.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

This check can be disabled by tagging the PR with skip-license-check.

Copy link
Member

@bwilkerson bwilkerson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to update this package because none of the code in it will actually be invoked. Curious to know what your rationale was. If I'm right, then the good news is that you won't need to update or version this package in order to update the analytics being sent from the plugins.

It looks like the IDE enum is only being used to pass in an event name. I don't think that will be necessary when you write this in Java for IntelliJ based IDEs and in TypeScript for VS Code based IDEs; you can just hard code it to the one appropriate choice.

@bwilkerson
Copy link
Member

I forgot to mention, but I suspect you're going to want to add a field (outside of additionalData) that can be used to determine the shape of the additionalData.

@pq
Copy link
Member Author

pq commented Oct 29, 2025

I don't think it's necessary to update this package because none of the code in it will actually be invoked. Curious to know what your rationale was.

My thinking is that IDEs will communicate with UA via DTD and that we'll want to update DTD to create and send these new events.

@helin24
Copy link

helin24 commented Oct 29, 2025

I don't think it's necessary to update this package because none of the code in it will actually be invoked. Curious to know what your rationale was.

My thinking is that IDEs will communicate with UA via DTD and that we'll want to update DTD to create and send these new events.

That's what I imagined also. I don't think we want to communicate with UA ourselves when we can use DTD.

This formatting of data also seems reasonable to me. I'm curious, what happens to all of the things inside ActionData? Do they get mapped to defined fields or dropped into a field that we query later? We can discuss later this week also.

@bwilkerson
Copy link
Member

Interesting. That does take care of the need to duplicate the package (twice). But I do wonder about the security implications. Will every DevTools extension to be able to send analytics, or is there a way to ensure that it's only the IDE plugins we own that can do so? If the former, I'd like to discuss this more offline.

If going through DTD is the plan, then we might want to consider what the DTD message will look like at the same time in order to make sure everything works together.

I'd still get rid of IDE; it's going to be easier to just pass the event name directly to the DTD message (rather than the name of an enum constant which then has to be looked up so that you can access the event name).

pq added a commit to flutter/flutter-intellij that referenced this pull request Nov 4, 2025
Companion to dart-lang/tools#2229 that noodles a
bit on an analytics reporting API.

If this looks good, I'll follow up with documentation and fill in some
more implementation for the remaining actions (see:
#8598).

Implementing a `UnifiedAnalyticsReporter` that connects with the
`UnifiedAnalytics` implementation may feed changes back to this too.

(I'll schedule some time to chat through that since it'd probably be
best done synchronously.)


---

- [x] I’ve reviewed the contributor guide and applied the relevant
portions to this PR.

<details>
  <summary>Contribution guidelines:</summary><br>

- See our [contributor
guide]([https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md](https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview)
for general expectations for PRs.
- Larger or significant changes should be discussed in an issue before
creating a PR.
- Dart contributions to our repos should follow the [Dart style
guide](https://dart.dev/guides/language/effective-dart) and use `dart
format`.
- Java and Kotlin contributions should strive to follow Java and Kotlin
best practices
([discussion](#8098)).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants