Skip to content

Commit a7a842e

Browse files
cynthiajoancynthiajoan
authored
fix(vertexai): follow up changes for LiveModel (#17236)
* follow up changes for LiveModel * remove unnecessary comment
1 parent f3502cd commit a7a842e

File tree

6 files changed

+195
-21
lines changed

6 files changed

+195
-21
lines changed

‎packages/firebase_vertexai/firebase_vertexai/example/lib/pages/bidi_page.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class _BidiPageState extends State<BidiPage> {
5959
super.initState();
6060

6161
final config = LiveGenerationConfig(
62-
speechConfig: SpeechConfig(voice: Voice.Fenrir),
62+
speechConfig: SpeechConfig(voice: Voice.fenrir),
6363
responseModalities: [
6464
ResponseModalities.audio,
6565
],

‎packages/firebase_vertexai/firebase_vertexai/lib/src/error.dart

+11-2
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,15 @@ final class LiveWebSocketClosedException implements Exception {
138138
final String message;
139139

140140
@override
141-
String toString() => message;
141+
String toString() {
142+
if (message.contains('DEADLINE_EXCEEDED')) {
143+
return 'The current live session has expired. Please start a new session.';
144+
} else if (message.contains('RESOURCE_EXHAUSTED')) {
145+
return 'You have exceeded the maximum number of concurrent sessions. '
146+
'Please close other sessions and try again later.';
147+
}
148+
return message;
149+
}
142150
}
143151

144152
/// Parse the error json object.
@@ -150,7 +158,8 @@ VertexAIException parseError(Object jsonObject) {
150158
} =>
151159
InvalidApiKey(message),
152160
{'message': UnsupportedUserLocation._message} => UnsupportedUserLocation(),
153-
{'message': final String message} when message.contains('quota') =>
161+
{'message': final String message}
162+
when message.toLowerCase().contains('quota') =>
154163
QuotaExceeded(message),
155164
{
156165
'message': final String _,

‎packages/firebase_vertexai/firebase_vertexai/lib/src/live_api.dart

+10-10
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@ import 'error.dart';
1717

1818
/// The available voice options for speech synthesis.
1919
enum Voice {
20-
// ignore: public_member_api_docs, constant_identifier_names
21-
Aoede('Aoede'),
20+
// ignore: public_member_api_docs
21+
aoede('Aoede'),
2222

23-
// ignore: public_member_api_docs, constant_identifier_names
24-
Charon('Charon'),
23+
// ignore: public_member_api_docs
24+
charon('Charon'),
2525

26-
// ignore: public_member_api_docs, constant_identifier_names
27-
Fenrir('Fenrir'),
26+
// ignore: public_member_api_docs
27+
fenrir('Fenrir'),
2828

29-
// ignore: public_member_api_docs, constant_identifier_names
30-
Kore('Kore'),
29+
// ignore: public_member_api_docs
30+
kore('Kore'),
3131

32-
// ignore: public_member_api_docs, constant_identifier_names
33-
Puck('Puck');
32+
// ignore: public_member_api_docs
33+
puck('Puck');
3434

3535
const Voice(this._jsonString);
3636
final String _jsonString;

‎packages/firebase_vertexai/firebase_vertexai/lib/src/live_session.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class LiveSession {
131131
void _checkWsStatus() {
132132
if (_ws.closeCode != null) {
133133
var message =
134-
'WebSocket status: Closed, closeCode: ${_ws.closeCode}, closeReason: ${_ws.closeReason}';
134+
'WebSocket Closed, closeCode: ${_ws.closeCode}, closeReason: ${_ws.closeReason}';
135135

136136
throw LiveWebSocketClosedException(message);
137137
}

‎packages/firebase_vertexai/firebase_vertexai/test/error_test.dart

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
// Copyright 2025 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
import 'package:firebase_vertexai/src/error.dart';
16+
import 'package:flutter_test/flutter_test.dart';
17+
18+
void main() {
19+
group('VertexAI Exceptions', () {
20+
test('VertexAIException toString', () {
21+
final exception = VertexAIException('Test message');
22+
expect(exception.toString(), 'VertexAIException: Test message');
23+
});
24+
25+
test('InvalidApiKey toString', () {
26+
final exception = InvalidApiKey('Invalid API key provided.');
27+
expect(exception.toString(), 'Invalid API key provided.');
28+
});
29+
30+
test('UnsupportedUserLocation message', () {
31+
final exception = UnsupportedUserLocation();
32+
expect(
33+
exception.message, 'User location is not supported for the API use.');
34+
});
35+
36+
test('ServiceApiNotEnabled message', () {
37+
final exception = ServiceApiNotEnabled('projects/test-project');
38+
expect(
39+
exception.message,
40+
'The Vertex AI in Firebase SDK requires the Vertex AI in Firebase API '
41+
'(`firebasevertexai.googleapis.com`) to be enabled in your Firebase project. Enable this API '
42+
'by visiting the Firebase Console at '
43+
'https://console.firebase.google.com/project/test-project/genai '
44+
'and clicking "Get started". If you enabled this API recently, wait a few minutes for the '
45+
'action to propagate to our systems and then retry.');
46+
});
47+
48+
test('QuotaExceeded toString', () {
49+
final exception = QuotaExceeded('Quota for this API has been exceeded.');
50+
expect(exception.toString(), 'Quota for this API has been exceeded.');
51+
});
52+
53+
test('ServerException toString', () {
54+
final exception = ServerException('Server error occurred.');
55+
expect(exception.toString(), 'Server error occurred.');
56+
});
57+
58+
test('VertexAISdkException toString', () {
59+
final exception = VertexAISdkException('SDK failed to parse response.');
60+
expect(
61+
exception.toString(),
62+
'SDK failed to parse response.\n'
63+
'This indicates a problem with the Vertex AI in Firebase SDK. '
64+
'Try updating to the latest version '
65+
'(https://pub.dev/packages/firebase_vertexai/versions), '
66+
'or file an issue at '
67+
'https://github.com/firebase/flutterfire/issues.');
68+
});
69+
70+
test('ImagenImagesBlockedException toString', () {
71+
final exception =
72+
ImagenImagesBlockedException('All images were blocked.');
73+
expect(exception.toString(), 'All images were blocked.');
74+
});
75+
76+
test('LiveWebSocketClosedException toString - DEADLINE_EXCEEDED', () {
77+
final exception = LiveWebSocketClosedException(
78+
'DEADLINE_EXCEEDED: Connection timed out.');
79+
expect(exception.toString(),
80+
'The current live session has expired. Please start a new session.');
81+
});
82+
83+
test('LiveWebSocketClosedException toString - RESOURCE_EXHAUSTED', () {
84+
final exception = LiveWebSocketClosedException(
85+
'RESOURCE_EXHAUSTED: Too many connections.');
86+
expect(
87+
exception.toString(),
88+
'You have exceeded the maximum number of concurrent sessions. '
89+
'Please close other sessions and try again later.');
90+
});
91+
92+
test('LiveWebSocketClosedException toString - Other', () {
93+
final exception =
94+
LiveWebSocketClosedException('WebSocket connection closed.');
95+
expect(exception.toString(), 'WebSocket connection closed.');
96+
});
97+
98+
group('parseError', () {
99+
test('parses API_KEY_INVALID', () {
100+
final json = {
101+
'message': 'Invalid API key',
102+
'details': [
103+
{'reason': 'API_KEY_INVALID'}
104+
]
105+
};
106+
final exception = parseError(json);
107+
expect(exception, isInstanceOf<InvalidApiKey>());
108+
expect(exception.message, 'Invalid API key');
109+
});
110+
111+
test('parses UNSUPPORTED_USER_LOCATION', () {
112+
final json = {
113+
'message': 'User location is not supported for the API use.'
114+
};
115+
final exception = parseError(json);
116+
expect(exception, isInstanceOf<UnsupportedUserLocation>());
117+
});
118+
119+
test('parses QUOTA_EXCEEDED', () {
120+
final json = {'message': 'Quota exceeded: Limit reached.'};
121+
final exception = parseError(json);
122+
expect(exception, isInstanceOf<QuotaExceeded>());
123+
expect(exception.message, 'Quota exceeded: Limit reached.');
124+
});
125+
126+
test('parses SERVICE_API_NOT_ENABLED', () {
127+
final json = {
128+
'message': 'API not enabled',
129+
'status': 'PERMISSION_DENIED',
130+
'details': [
131+
{
132+
'metadata': {
133+
'service': 'firebasevertexai.googleapis.com',
134+
'consumer': 'projects/my-project-id',
135+
}
136+
}
137+
]
138+
};
139+
final exception = parseError(json);
140+
expect(exception, isInstanceOf<ServiceApiNotEnabled>());
141+
expect(
142+
(exception as ServiceApiNotEnabled).message,
143+
'The Vertex AI in Firebase SDK requires the Vertex AI in Firebase API '
144+
'(`firebasevertexai.googleapis.com`) to be enabled in your Firebase project. Enable this API '
145+
'by visiting the Firebase Console at '
146+
'https://console.firebase.google.com/project/my-project-id/genai '
147+
'and clicking "Get started". If you enabled this API recently, wait a few minutes for the '
148+
'action to propagate to our systems and then retry.');
149+
});
150+
151+
test('parses SERVER_ERROR', () {
152+
final json = {'message': 'Internal server error.'};
153+
final exception = parseError(json);
154+
expect(exception, isInstanceOf<ServerException>());
155+
expect(exception.message, 'Internal server error.');
156+
});
157+
158+
test('parses UNHANDLED_FORMAT', () {
159+
final json = {'unexpected': 'format'};
160+
expect(() => parseError(json),
161+
throwsA(isInstanceOf<VertexAISdkException>()));
162+
});
163+
});
164+
});
165+
}

‎packages/firebase_vertexai/firebase_vertexai/test/live_test.dart

+7-7
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ import 'package:flutter_test/flutter_test.dart';
2121
void main() {
2222
group('LiveAPI Tests', () {
2323
test('Voices enum toJson() returns correct value', () {
24-
expect(Voice.Aoede.toJson(), 'Aoede');
25-
expect(Voice.Charon.toJson(), 'Charon');
26-
expect(Voice.Fenrir.toJson(), 'Fenrir');
27-
expect(Voice.Kore.toJson(), 'Kore');
28-
expect(Voice.Puck.toJson(), 'Puck');
24+
expect(Voice.aoede.toJson(), 'Aoede');
25+
expect(Voice.charon.toJson(), 'Charon');
26+
expect(Voice.fenrir.toJson(), 'Fenrir');
27+
expect(Voice.kore.toJson(), 'Kore');
28+
expect(Voice.puck.toJson(), 'Puck');
2929
});
3030

3131
test('SpeechConfig toJson() returns correct JSON', () {
32-
final speechConfigWithVoice = SpeechConfig(voice: Voice.Aoede);
32+
final speechConfigWithVoice = SpeechConfig(voice: Voice.aoede);
3333
expect(speechConfigWithVoice.toJson(), {
3434
'voice_config': {
3535
'prebuilt_voice_config': {'voice_name': 'Aoede'}
@@ -49,7 +49,7 @@ void main() {
4949

5050
test('LiveGenerationConfig toJson() returns correct JSON', () {
5151
final liveGenerationConfig = LiveGenerationConfig(
52-
speechConfig: SpeechConfig(voice: Voice.Charon),
52+
speechConfig: SpeechConfig(voice: Voice.charon),
5353
responseModalities: [ResponseModalities.text, ResponseModalities.audio],
5454
candidateCount: 2,
5555
maxOutputTokens: 100,

0 commit comments

Comments
 (0)