feat(web): add registerVersion support for packages

melos.yaml

@@ -19,6 +19,7 @@ command:
       preCommit: |
         dart run scripts/generate_firebaseai_version.dart && \
         dart run scripts/generate_dataconnect_version.dart && \
+        dart run scripts/generate_versions_web.dart && \
         dart run scripts/generate_versions_spm.dart && \
         git add packages/firebase_data_connect/firebase_data_connect/lib/src/dataconnect_version.dart
       post: |

packages/cloud_firestore/cloud_firestore_web/lib/cloud_firestore_web.dart

@@ -25,9 +25,13 @@ import 'src/query_web.dart';
 import 'src/transaction_web.dart';
 import 'src/write_batch_web.dart';
 
+import 'src/cloud_firestore_version.dart';
+
 /// Web implementation for [FirebaseFirestorePlatform]
 /// delegates calls to firestore web plugin
 class FirebaseFirestoreWeb extends FirebaseFirestorePlatform {
+  static const String _libraryName = 'cloud_firestore';
+
   /// instance of Firestore from the web plugin
   firestore_interop.Firestore? _webFirestore;
 
@@ -41,6 +45,8 @@ class FirebaseFirestoreWeb extends FirebaseFirestorePlatform {
 
   /// Called by PluginRegistry to register this plugin for Flutter Web
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService('firestore');
     FirebaseFirestorePlatform.instance = FirebaseFirestoreWeb();
   }

packages/cloud_firestore/cloud_firestore_web/lib/src/cloud_firestore_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '6.0.2';

packages/cloud_functions/cloud_functions_web/lib/cloud_functions_web.dart

@@ -13,8 +13,12 @@ import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'https_callable_web.dart';
 import 'interop/functions.dart' as functions_interop;
 
+import 'src/cloud_functions_version.dart';
+
 /// Web implementation of [FirebaseFunctionsPlatform].
 class FirebaseFunctionsWeb extends FirebaseFunctionsPlatform {
+  static const String _libraryName = 'cloud_functions';
+
   /// The entry point for the [FirebaseFunctionsWeb] class.
   FirebaseFunctionsWeb({FirebaseApp? app, required String region})
       : super(app, region);
@@ -36,6 +40,8 @@ class FirebaseFunctionsWeb extends FirebaseFunctionsPlatform {
 
   /// Create the default instance of the [FirebaseFunctionsPlatform] as a [FirebaseFunctionsWeb]
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService('functions');
     FirebaseFunctionsPlatform.instance = FirebaseFunctionsWeb.instance;
   }

packages/cloud_functions/cloud_functions_web/lib/src/cloud_functions_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '6.0.2';

packages/firebase_analytics/firebase_analytics_web/lib/firebase_analytics_web.dart

@@ -10,10 +10,14 @@ import 'package:firebase_core_web/firebase_core_web_interop.dart'
     as core_interop;
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 
+import 'src/firebase_analytics_version.dart';
+
 import 'interop/analytics.dart' as analytics_interop;
 
 /// Web implementation of [FirebaseAnalyticsPlatform]
 class FirebaseAnalyticsWeb extends FirebaseAnalyticsPlatform {
+  static const String _libraryName = 'firebase_analytics';
+
   /// instance of Analytics from the web plugin
   analytics_interop.Analytics? _webAnalytics;
 
@@ -36,6 +40,8 @@ class FirebaseAnalyticsWeb extends FirebaseAnalyticsPlatform {
 
   /// Called by PluginRegistry to register this plugin for Flutter Web
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService('analytics');
     FirebaseAnalyticsPlatform.instance = FirebaseAnalyticsWeb();
   }

packages/firebase_analytics/firebase_analytics_web/lib/src/firebase_analytics_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '12.0.2';

packages/firebase_app_check/firebase_app_check_web/lib/firebase_app_check_web.dart

@@ -16,7 +16,10 @@ import 'package:web/web.dart' as web;
 import 'src/internals.dart';
 import 'src/interop/app_check.dart' as app_check_interop;
 
+import 'src/firebase_app_check_version.dart';
+
 class FirebaseAppCheckWeb extends FirebaseAppCheckPlatform {
+  static const String _libraryName = 'firebase_app_check';
   static const recaptchaTypeV3 = 'recaptcha-v3';
   static const recaptchaTypeEnterprise = 'enterprise';
   static Map<String, StreamController<String?>> _tokenChangesListeners = {};
@@ -32,6 +35,8 @@ class FirebaseAppCheckWeb extends FirebaseAppCheckPlatform {
 
   /// Called by PluginRegistry to register this plugin for Flutter Web
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService(
       'app-check',
       productNameOverride: 'app_check',

packages/firebase_app_check/firebase_app_check_web/lib/src/firebase_app_check_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '0.4.1';

packages/firebase_app_installations/firebase_app_installations_web/lib/firebase_app_installations_web.dart

@@ -12,7 +12,11 @@ import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'src/guard.dart';
 import 'src/interop/installations.dart' as installations_interop;
 
+import 'src/firebase_app_installations_version.dart';
+
 class FirebaseAppInstallationsWeb extends FirebaseAppInstallationsPlatform {
+  static const String _libraryName = 'firebase_app_installations';
+
   /// The entry point for the [FirebaseAppInstallationsWeb] class.
   FirebaseAppInstallationsWeb({FirebaseApp? app}) : super(app);
 
@@ -33,6 +37,8 @@ class FirebaseAppInstallationsWeb extends FirebaseAppInstallationsPlatform {
 
   /// Create the default instance of the [FirebaseAppInstallationsPlatform] as a [FirebaseAppInstallationsWeb]
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService('installations');
     FirebaseAppInstallationsPlatform.instance =
         FirebaseAppInstallationsWeb.instance;

packages/firebase_app_installations/firebase_app_installations_web/lib/src/firebase_app_installations_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '0.4.0+2';

packages/firebase_auth/firebase_auth_web/lib/firebase_auth_web.dart

@@ -17,6 +17,8 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'package:web/web.dart' as web;
 
+import 'src/firebase_auth_version.dart';
+
 import 'src/firebase_auth_web_confirmation_result.dart';
 import 'src/firebase_auth_web_recaptcha_verifier_factory.dart';
 import 'src/firebase_auth_web_user.dart';
@@ -28,6 +30,8 @@ enum StateListener { authStateChange, userStateChange, idTokenChange }
 
 /// The web delegate implementation for [FirebaseAuth].
 class FirebaseAuthWeb extends FirebaseAuthPlatform {
+  static const String _libraryName = 'firebase_auth';
+
   /// Stub initializer to allow the [registerWith] to create an instance without
   /// registering the web delegates or listeners.
   FirebaseAuthWeb._()
@@ -46,6 +50,8 @@ class FirebaseAuthWeb extends FirebaseAuthPlatform {
 
   /// Called by PluginRegistry to register this plugin for Flutter Web
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService(
       'auth',
       ensurePluginInitialized: (firebaseApp) async {

packages/firebase_auth/firebase_auth_web/lib/src/firebase_auth_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '6.1.0';

packages/firebase_core/firebase_core_web/lib/firebase_core_web.dart

@@ -8,8 +8,10 @@ import 'dart:js_interop';
 import 'dart:js_interop_unsafe';
 
 import 'package:firebase_core_platform_interface/firebase_core_platform_interface.dart';
+import 'package:firebase_core_web/src/firebase_core_version.dart';
 import 'package:firebase_core_web/src/interop/package_web_tweaks.dart';
 import 'package:firebase_core_web/src/interop/utils/es6_interop.dart';
+import 'package:flutter/foundation.dart';
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'package:meta/meta.dart';
 import 'package:web/web.dart' as web;

packages/firebase_core/firebase_core_web/lib/src/firebase_core_version.dart

@@ -0,0 +1,16 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/// generated version number for the package, do not manually edit
+const packageVersion = '4.1.1';

packages/firebase_core/firebase_core_web/lib/src/firebase_core_web.dart

@@ -39,6 +39,8 @@ class FirebaseCoreWeb extends FirebasePlatform {
     'core': FirebaseWebService._('app', override: 'core'),
   };
 
+  static Map<String, String> _libraryVersions = {};
+
   /// Internally registers a Firebase Service to be initialized.
   static void registerService(
     String service, {
@@ -55,11 +57,38 @@ class FirebaseCoreWeb extends FirebasePlatform {
     );
   }
 
+  static const String _libraryName = 'firebase_core';
+
   /// Registers that [FirebaseCoreWeb] is the platform implementation.
   static void registerWith(Registrar registrar) {
     FirebasePlatform.instance = FirebaseCoreWeb();
   }
 
+  /// Registers a library's name and version for platform logging purposes if needed.
+  static void _registerVersionIfNeeded(
+    String libraryName,
+    String packageVersion,
+  ) {
+    final sessionKey = _getSessionStorageKey(libraryName);
+    final sessionItem = web.window.sessionStorage.getItem(sessionKey);
+    if (sessionItem == null) {
+      web.window.sessionStorage.setItem(sessionKey, packageVersion);
+      firebase.registerVersion(libraryName, packageVersion);
+    }
+  }
+
+  static void registerLibraryVersion(String libraryName, String version) {
+    _libraryVersions[libraryName] = version;
+  }
+
+  static String _getSessionStorageKey(String libraryName) {
+    return 'flutterfire-$libraryName';
+  }
+
+  static void _registerAllLibraryVersions() {
+    _libraryVersions.forEach(_registerVersionIfNeeded);
+  }
+
   /// Returns the Firebase JS SDK Version to use.
   ///
   /// You can override the supported version by attaching a version string to
@@ -195,6 +224,8 @@ class FirebaseCoreWeb extends FirebasePlatform {
         );
       }),
     );
+    registerLibraryVersion(_libraryName, packageVersion);
+    _registerAllLibraryVersions();
   }
 
   /// Returns all created [FirebaseAppPlatform] instances.

packages/firebase_core/firebase_core_web/lib/src/interop/core.dart

@@ -61,6 +61,15 @@ App app([String? name]) {
   );
 }
 
+void registerVersion(String libraryKeyOrName, String version,
+    [String? variant]) {
+  firebase_interop.registerVersion(
+    libraryKeyOrName.toJS,
+    version.toJS,
+    variant?.toJS ?? 'flutter-firebase'.toJS,
+  );
+}
+
 class FirebaseError {
   final String code;
   final String message;

packages/firebase_core/firebase_core_web/lib/src/interop/core_interop.dart

@@ -31,6 +31,13 @@ external AppJsImpl getApp([JSString? name]);
 @JS()
 external JSPromise deleteApp(AppJsImpl app);
 
+@JS()
+external void registerVersion(
+  JSString libraryKeyOrName,
+  JSString version, [
+  JSString? variant,
+]);
+
 /// FirebaseError is a subclass of the standard Error object.
 /// In addition to a message string, it contains a string-valued code.
 ///

packages/firebase_database/firebase_database_web/lib/firebase_database_web.dart

@@ -15,6 +15,8 @@ import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 
 import 'src/interop/database.dart' as database_interop;
 
+import 'src/firebase_database_version.dart';
+
 part './src/data_snapshot_web.dart';
 part './src/database_event_web.dart';
 part './src/database_reference_web.dart';
@@ -27,6 +29,8 @@ part './src/utils/snapshot_utils.dart';
 /// Web implementation for [DatabasePlatform]
 /// delegates calls to firebase web plugin
 class FirebaseDatabaseWeb extends DatabasePlatform {
+  static const String _libraryName = 'firebase_database';
+
   /// Instance of Database from web plugin
   database_interop.Database? _firebaseDatabase;
 
@@ -41,6 +45,8 @@ class FirebaseDatabaseWeb extends DatabasePlatform {
 
   /// Called by PluginRegistry to register this plugin for Flutter Web
   static void registerWith(Registrar registrar) {
+    FirebaseCoreWeb.registerLibraryVersion(_libraryName, packageVersion);
+
     FirebaseCoreWeb.registerService('database');
     DatabasePlatform.instance = FirebaseDatabaseWeb();
   }