Add widget for downloads chart with json encoded data (#8415)

Author: szakarias

app/lib/frontend/templates/views/pkg/score_tab.dart

@@ -2,11 +2,13 @@
 // 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.
 
-import 'package:_pub_shared/format/encoding.dart';
+import 'dart:convert';
+
+import 'package:_pub_shared/data/download_counts_data.dart';
 import 'package:_pub_shared/format/number_format.dart';
 import 'package:pana/models.dart';
-import 'package:pub_dev/service/download_counts/download_counts.dart';
 import 'package:pub_dev/shared/popularity_storage.dart';
+import 'package:pub_dev/shared/utils.dart';
 
 import '../../../../scorecard/models.dart' hide ReportStatus;
 import '../../../../shared/urls.dart' as urls;
@@ -184,31 +186,12 @@ d.Node _downloadsChart(WeeklyVersionDownloadCounts weeklyVersionDownloads) {
     id: '-downloads-chart',
     attributes: {
       'data-widget': 'downloads-chart',
-      'data-downloads-chart': _encodeForDownloadsChart(weeklyVersionDownloads)
+      'data-downloads-chart-points':
+          base64Encode(jsonUtf8Encoder.convert(weeklyVersionDownloads))
     },
   );
 }
 
-String _encodeForDownloadsChart(WeeklyVersionDownloadCounts wvcd) {
-  final date = wvcd.newestDate.toUtc().millisecondsSinceEpoch ~/ 1000;
-
-  final allCounts = <int>[];
-  final allRanges = <String>[];
-  wvcd.majorRangeWeeklyDownloads.forEach((e) => allCounts.addAll(e.counts));
-  wvcd.minorRangeWeeklyDownloads.forEach((e) => allCounts.addAll(e.counts));
-  wvcd.patchRangeWeeklyDownloads.forEach((e) => allCounts.addAll(e.counts));
-  allCounts.addAll(wvcd.totalWeeklyDownloads);
-
-  wvcd.majorRangeWeeklyDownloads.forEach((e) => allRanges.add(e.versionRange));
-  wvcd.minorRangeWeeklyDownloads.forEach((e) => allRanges.add(e.versionRange));
-  wvcd.patchRangeWeeklyDownloads.forEach((e) => allRanges.add(e.versionRange));
-
-  return [
-    encodeIntsAsLittleEndianBase64String([date, ...allCounts]),
-    allRanges
-  ].join(',');
-}
-
 final _statusIconUrls = {
   ReportStatus.passed:
       staticUrls.getAssetUrl('/static/img/report-ok-icon-green.svg'),

app/lib/scorecard/models.dart

@@ -4,11 +4,11 @@
 
 import 'dart:io';
 
+import 'package:_pub_shared/data/download_counts_data.dart';
 import 'package:_pub_shared/search/tags.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:pana/models.dart';
 import 'package:pub_dev/service/download_counts/backend.dart';
-import 'package:pub_dev/service/download_counts/download_counts.dart';
 import 'package:pub_dev/task/models.dart';
 
 import '../scorecard/backend.dart';

app/lib/service/download_counts/computations.dart

@@ -4,6 +4,7 @@
 import 'dart:async';
 import 'dart:math';
 
+import 'package:_pub_shared/data/download_counts_data.dart';
 import 'package:gcloud/storage.dart';
 import 'package:pub_dev/service/download_counts/backend.dart';
 import 'package:pub_dev/service/download_counts/download_counts.dart';

app/lib/service/download_counts/download_counts.dart

@@ -2,39 +2,13 @@
 // 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.
 
+import 'package:_pub_shared/data/download_counts_data.dart';
 import 'package:basics/basics.dart';
 import 'package:collection/collection.dart' show IterableExtension;
 import 'package:json_annotation/json_annotation.dart';
 import 'package:pub_semver/pub_semver.dart';
 part 'download_counts.g.dart';
 
-/// A [VersionRangeCount] is a tuple containing a version range and a list of
-/// download counts for periods of same length.
-///
-/// The first entry in the tuple is a string describing the `versionRange`, for
-/// instance '>=1.0.0-0 <2.0.0'.
-///
-/// The second entry in the tuple is an integer list of `counts` with download
-/// counts for each period. A period could for instance be a day, or a week etc.
-/// The `counts` list contains at most [maxAge] entries.
-///
-/// Consider the example of period being one day. The first count represents the
-/// number of downloads on `newestDate` followed by the downloads on
-/// `newestDate` - 1 and so on. E.g.
-///
-///  counts = [ 42, 21, 55 ]
-///              ▲   ▲   ▲
-///              │   │   └──────────── Download count on newestDate - 2 days
-///              │   │
-///              │   └──────────────── Download count on newestDate - 1 day
-///              │
-///              └──────────────────── Download count on newestDate
-///
-///
-/// Each entry in the `counts` list is non-negativ. A `0` entry can for a given
-/// day mean that the version range has no downloads or that there is no data.
-typedef VersionRangeCount = ({String versionRange, List<int> counts});
-
 /// The maximum number of days for which we store downloads counts for a package.
 const maxAge = 731;
 
@@ -242,46 +216,3 @@ class WeeklyDownloadCounts {
       _$WeeklyDownloadCountsFromJson(json);
   Map<String, dynamic> toJson() => _$WeeklyDownloadCountsToJson(this);
 }
-
-@JsonSerializable(includeIfNull: false)
-class WeeklyVersionDownloadCounts {
-  /// An integer list where each number is the total number of downloads for a
-  /// given 7 day period starting from [newestDate].
-  final List<int> totalWeeklyDownloads;
-
-  /// A list of [VersionRangeCount] with major version ranges and weekly
-  /// downloads for these ranges.
-  ///
-  /// E.g. each number in the `counts` list is the total number of downloads for
-  /// the range in a 7 day period starting from [newestDate].
-  final List<VersionRangeCount> majorRangeWeeklyDownloads;
-
-  /// A list of [VersionRangeCount] with minor version ranges and weekly
-  /// downloads for these ranges.
-  ///
-  /// E.g. each number in the `counts` list is the total number of downloads for
-  /// the range in a 7 day period starting from [newestDate].
-  final List<VersionRangeCount> minorRangeWeeklyDownloads;
-
-  /// A list of [VersionRangeCount] with patch version ranges and weekly
-  /// downloads for these ranges.
-  ///
-  /// E.g. each number in the `counts` list is the total number of downloads for
-  /// the range in a 7 day period starting from [newestDate].
-  final List<VersionRangeCount> patchRangeWeeklyDownloads;
-
-  /// The newest date with download counts data available.
-  final DateTime newestDate;
-
-  WeeklyVersionDownloadCounts({
-    required this.newestDate,
-    required this.majorRangeWeeklyDownloads,
-    required this.minorRangeWeeklyDownloads,
-    required this.patchRangeWeeklyDownloads,
-    required this.totalWeeklyDownloads,
-  });
-
-  factory WeeklyVersionDownloadCounts.fromJson(Map<String, dynamic> json) =>
-      _$WeeklyVersionDownloadCountsFromJson(json);
-  Map<String, dynamic> toJson() => _$WeeklyVersionDownloadCountsToJson(this);
-}

app/lib/service/download_counts/download_counts.g.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:math';
 
+import 'package:_pub_shared/data/download_counts_data.dart';
 import 'package:_pub_shared/data/package_api.dart' show VersionScore;
 import 'package:gcloud/service_scope.dart' as ss;
 import 'package:googleapis/youtube/v3.dart';

app/lib/shared/redis_cache.dart

@@ -10,6 +10,7 @@ targets:
       - 'lib/data/admin_api.dart'
       - 'lib/data/advisories_api.dart'
       - 'lib/data/completion.dart'
+      - 'lib/data/download_counts_data.dart'
       - 'lib/data/package_api.dart'
       - 'lib/data/page_data.dart'
       - 'lib/data/publisher_api.dart'

pkg/_pub_shared/build.yaml

@@ -0,0 +1,76 @@
+// 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.
+
+import 'package:json_annotation/json_annotation.dart';
+
+part 'download_counts_data.g.dart';
+
+/// A [VersionRangeCount] is a tuple containing a version range and a list of
+/// download counts for periods of same length.
+///
+/// The first entry in the tuple is a string describing the `versionRange`, for
+/// instance '>=1.0.0-0 <2.0.0'.
+///
+/// The second entry in the tuple is an integer list of `counts` with download
+/// counts for each period. A period could for instance be a day, or a week etc.
+///
+/// Consider the example of period being one day. The first count represents the
+/// number of downloads on `newestDate` followed by the downloads on
+/// `newestDate` - 1 and so on. E.g.
+///
+///  counts = [ 42, 21, 55 ]
+///              ▲   ▲   ▲
+///              │   │   └──────────── Download count on newestDate - 2 days
+///              │   │
+///              │   └──────────────── Download count on newestDate - 1 day
+///              │
+///              └──────────────────── Download count on newestDate
+///
+///
+/// Each entry in the `counts` list is non-negativ. A `0` entry can for a given
+/// day mean that the version range has no downloads or that there is no data.
+typedef VersionRangeCount = ({String versionRange, List<int> counts});
+
+@JsonSerializable(includeIfNull: false)
+class WeeklyVersionDownloadCounts {
+  /// An integer list where each number is the total number of downloads for a
+  /// given 7 day period starting from [newestDate].
+  final List<int> totalWeeklyDownloads;
+
+  /// A list of [VersionRangeCount] with major version ranges and weekly
+  /// downloads for these ranges.
+  ///
+  /// E.g. each number in the `counts` list is the total number of downloads for
+  /// the range in a 7 day period starting from [newestDate].
+  final List<VersionRangeCount> majorRangeWeeklyDownloads;
+
+  /// A list of [VersionRangeCount] with minor version ranges and weekly
+  /// downloads for these ranges.
+  ///
+  /// E.g. each number in the `counts` list is the total number of downloads for
+  /// the range in a 7 day period starting from [newestDate].
+  final List<VersionRangeCount> minorRangeWeeklyDownloads;
+
+  /// A list of [VersionRangeCount] with patch version ranges and weekly
+  /// downloads for these ranges.
+  ///
+  /// E.g. each number in the `counts` list is the total number of downloads for
+  /// the range in a 7 day period starting from [newestDate].
+  final List<VersionRangeCount> patchRangeWeeklyDownloads;
+
+  /// The newest date with download counts data available.
+  final DateTime newestDate;
+
+  WeeklyVersionDownloadCounts({
+    required this.newestDate,
+    required this.majorRangeWeeklyDownloads,
+    required this.minorRangeWeeklyDownloads,
+    required this.patchRangeWeeklyDownloads,
+    required this.totalWeeklyDownloads,
+  });
+
+  factory WeeklyVersionDownloadCounts.fromJson(Map<String, dynamic> json) =>
+      _$WeeklyVersionDownloadCountsFromJson(json);
+  Map<String, dynamic> toJson() => _$WeeklyVersionDownloadCountsToJson(this);
+}