Skip to content

feat(sql_connect): add "X-Client-Platform" and "X-Client-Version" headers #18484

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.

Sign up for GitHub

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

Draft
dconeybe wants to merge 1 commit into
base: main
Choose a base branch
from
+84 −2
Draft

feat(sql_connect): add "X-Client-Platform" and "X-Client-Version" headers #18484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion packages/firebase_data_connect/firebase_data_connect/lib/src/network/rest_transport.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,9 @@ class RestTransport implements DataConnectTransport {
'Content-Type': 'application/json',
'Accept': 'application/json',
'x-goog-api-client': getGoogApiVal(sdkType, packageVersion),
'x-firebase-client': getFirebaseClientVal(packageVersion)
'x-firebase-client': getFirebaseClientVal(packageVersion),
'x-client-platform': 'flutter',
'x-client-version': packageVersion,
};
String? appCheckToken;
try {
Expand Down
8 changes: 7 additions & 1 deletion ...ages/firebase_data_connect/firebase_data_connect/lib/src/network/websocket_transport.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,16 @@ class WebSocketTransport implements DataConnectTransport {

bool get isConnected => _channel != null;

@visibleForTesting
Map<String, String> buildHeaders(String? authToken, String? appCheckToken) =>
_buildHeaders(authToken, appCheckToken);

Map<String, String> _buildHeaders(String? authToken, String? appCheckToken) {
Map<String, String> headers = {
'x-goog-api-client': getGoogApiVal(sdkType, packageVersion),
'x-firebase-client': getFirebaseClientVal(packageVersion)
'x-firebase-client': getFirebaseClientVal(packageVersion),
'x-client-platform': 'flutter',
'x-client-version': packageVersion
};
if (authToken != null) {
headers['X-Firebase-Auth-Token'] = authToken;
Expand Down
74 changes: 74 additions & 0 deletions ...ges/firebase_data_connect/firebase_data_connect/test/src/network/rest_transport_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,80 @@ void main() {
).called(1);
});

test(
'invokeOperation should include x-client-platform headers',
() async {
final mockResponse = http.Response('{"data": {"key": "value"}}', 200);
when(
mockHttpClient.post(
any,
headers: anyNamed('headers'),
body: anyNamed('body'),
),
).thenAnswer((_) async => mockResponse);

String deserializer(String data) => 'Deserialized Data';

await transport.invokeOperation(
'testQuery',
'executeQuery',
deserializer,
null,
null,
'authToken123',
);

verify(
mockHttpClient.post(
any,
headers: argThat(
allOf(
containsPair('x-client-platform', 'flutter'),
),
named: 'headers',
),
body: anyNamed('body'),
),
).called(1);
});

test(
'invokeOperation should include x-client-version headers',
() async {
final mockResponse = http.Response('{"data": {"key": "value"}}', 200);
when(
mockHttpClient.post(
any,
headers: anyNamed('headers'),
body: anyNamed('body'),
),
).thenAnswer((_) async => mockResponse);

String deserializer(String data) => 'Deserialized Data';

await transport.invokeOperation(
'testQuery',
'executeQuery',
deserializer,
null,
null,
'authToken123',
);

verify(
mockHttpClient.post(
any,
headers: argThat(
allOf(
containsPair('x-client-version', packageVersion),
),
named: 'headers',
),
body: anyNamed('body'),
),
).called(1);
});

test(
'regression #17290 - invokeOperation should correctly decode UTF-8 response with international characters',
() async {
Expand Down
Loading