Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking change: add and remove parameters from the Event.devtoolsEvent constructor #1193

Merged
merged 6 commits into from
Nov 8, 2024

Conversation

kenzieschmoll
Copy link
Contributor

Rational for the breaking change:

  1. the screen parameter is required for each DevTools event. This metadata did not get migrated over to the DevTools unified_analytics implementation and it was included with each legacy DevTools GA4 event.
  2. Adding or removing metrics to the Event.devtoolsEvent constructor causes unnecessary churn. The screen metrics are likely to change more frequently than the optional parameters sent with each event. This is because the screen metrics are unique to specific events and features that may change over time. Replacing these metric parameters with a single map additionalMetrics allows for flexibility on the DevTools side without requiring changes to the unified_analytics package.

Copy link

github-actions bot commented Nov 8, 2024

Package publishing

Package Version Status Publish tag (post-merge)
package:unified_analytics 7.0.0 ready to publish unified_analytics-v7.0.0
package:bazel_worker 1.1.3-wip WIP (no publish necessary)
package:benchmark_harness 2.3.1 already published at pub.dev
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.4.2 already published at pub.dev
package:clock 1.1.2 already published at pub.dev
package:code_builder 4.10.1 already published at pub.dev
package:coverage 1.10.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.1 already published at pub.dev
package:file_testing 3.0.2 already published at pub.dev
package:graphs 2.3.3-wip WIP (no publish necessary)
package:html 0.15.5 already published at pub.dev
package:json_rpc_2 3.0.3 already published at pub.dev
package:mime 2.0.0 already published at pub.dev
package:oauth2 2.0.4-wip WIP (no publish necessary)
package:source_map_stack_trace 2.1.3-wip WIP (no publish necessary)

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

Copy link

github-actions bot commented Nov 8, 2024

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
unified_analytics Breaking 6.1.5 7.0.0 7.0.0 ✔️
Changelog Entry ✔️
Package Changed Files

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

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

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 symbols
unified_analytics Condition
PersistedSurvey
GAClient
UserProperty

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

License Headers ✔️
// Copyright (c) 2024, 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/bazel_worker/example/client.dart
pkgs/bazel_worker/example/worker.dart
pkgs/bazel_worker/lib/src/worker_protocol.pb.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/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

Copy link
Contributor

@bkonyi bkonyi left a comment

Choose a reason for hiding this comment

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

The overall idea SGTM, just one question.

@kenzieschmoll kenzieschmoll merged commit 66afa68 into dart-lang:main Nov 8, 2024
13 checks passed
@kenzieschmoll kenzieschmoll deleted the ua-devtools branch November 8, 2024 19:09
@devoncarew
Copy link
Member

@kenzieschmoll - I'm seeing failures when trying to roll the latest commit from here into the sdk repo. I think we'll need to roll this version of package:unified_analytics into google3 in the same commit as an updated version of devtools.

[devtools_app/lib/src/shared/analytics/_analytics_web.dart:880](https://cs.corp.google.com/piper///depot/google3/third_party/dart/devtools_app/lib/src/shared/analytics/_analytics_web.dart?l=880&ws=dart-sdk-rolls-jobs/342096&snapshot=8)
The named parameter 'screen' is required, but there's no corresponding argument. #missing_required_argument

  return ua.Event.devtoolsEvent(
         ^^^^^^^^^^^^^^^^^^^^^^

@kenzieschmoll
Copy link
Contributor Author

I just landed the DevTools update here: flutter/devtools#8514. And then I attached the DevTools g3 roll (cl/695452581) as a hotfix for https://dart-review.googlesource.com/c/sdk/+/394006.

@devoncarew
Copy link
Member

Ah! I'd forgotten about your roll PR from last week.

@kenzieschmoll
Copy link
Contributor Author

@devoncarew https://dart-review.googlesource.com/c/sdk/+/394006 has been merged, so the g3 roll should be unblocked now.

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.

3 participants