Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/firebase_admin_sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## 0.5.4-wip

- Fixed `Firestore` requests not carrying the SDK's usage-tracking headers (`X-Firebase-Client`, `X-Goog-Api-Client`).
Comment thread
demolaf marked this conversation as resolved.
Outdated
- Update dependency `googleapis_auth: ^2.3.3` to fix `auth/insufficient-permission`
errors with Application Default Credentials that have no quota project set.

Expand Down
1 change: 0 additions & 1 deletion packages/firebase_admin_sdk/lib/src/app.dart
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ import '../messaging.dart';
import '../security_rules.dart';
import '../storage.dart';
import 'utils/utils.dart';
import 'version.g.dart';

part 'app/app_exception.dart';
part 'app/app_options.dart';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ class FirebaseUserAgentClient extends BaseClient

@override
Future<StreamedResponse> send(BaseRequest request) {
request.headers['X-Firebase-Client'] = 'fire-admin-dart/$packageVersion';
request.headers['X-Goog-Api-Client'] =
'gl-dart/$dartVersion fire-admin/$packageVersion';
request.headers.addAll(firebaseUserAgentHeaders);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this semantically different than what was there before?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

No, same values — just centralized into one shared constant instead of duplicated at each call site.

return _client.send(request);
}

Expand Down
5 changes: 5 additions & 0 deletions packages/firebase_admin_sdk/lib/src/firestore/firestore.dart
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import 'package:google_cloud_firestore/google_cloud_firestore.dart'
import 'package:meta/meta.dart';

import '../app.dart';
import '../utils/utils.dart';

/// Default database ID used by Firestore
const String kDefaultDatabaseId = '(default)';
Expand Down Expand Up @@ -152,6 +153,10 @@ class Firestore implements FirebaseService {
settings = settings.copyWith(projectId: projectId);
}

if (settings.headers == null) {
settings = settings.copyWith(headers: firebaseUserAgentHeaders);
}
Comment thread
demolaf marked this conversation as resolved.
Outdated

return settings;
}

Expand Down
14 changes: 14 additions & 0 deletions packages/firebase_admin_sdk/lib/src/utils/utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,24 @@

import 'dart:io';

import '../version.g.dart';

/// The current Dart SDK version in semver format (e.g. "3.3.0").
String get dartVersion =>
Platform.version.split(RegExp('[^0-9]')).take(3).join('.');

/// Headers that identify a request as originating from this SDK, for
/// Firebase backend usage tracking.
///
/// Shared by `FirebaseUserAgentClient` (used by Auth, Messaging, and other
/// services that go through `FirebaseApp.client`) and the Firestore service,
/// which builds its own HTTP client and can't be wrapped by
/// `FirebaseUserAgentClient` directly.
Map<String, String> get firebaseUserAgentHeaders => {
'X-Firebase-Client': 'fire-admin-dart/$packageVersion',
'X-Goog-Api-Client': 'gl-dart/$dartVersion fire-admin/$packageVersion',
};
Comment thread
demolaf marked this conversation as resolved.
Outdated

/// Generates the update mask for the provided object.
/// Note this will ignore the last key with value `null`.
List<String> _generateUpdateMask(Object? obj, String root) {
Expand Down