8000 fix(storage, web): fix putData when using UInt8List (#13466) · firebase/flutterfire@2bfb549 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2bfb549

Browse files
LyokoneLyokone
authored
fix(storage, web): fix putData when using UInt8List (#13466)
1 parent 7fcdbee commit 2bfb549

File tree

5 files changed

+91
-28
lines changed

5 files changed

+91
-28
lines changed

‎packages/firebase_storage/firebase_storage/example/lib/main.dart‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// BSD-style license that can be found in the LICENSE file.
44

55
import 'dart:async';
6+
import 'dart:convert';
67
import 'dart:io' as io;
78

89
import 'package:firebase_core/firebase_core.dart';
@@ -42,6 +43,9 @@ enum UploadType {
4243
/// Uploads a file from the device.
4344
file,
4445

46+
/// Uploads a Uint8List to Storage.
47+
uint8List,
48+
4549
/// Clears any tasks from the list.
4650
clear,
4751
}
@@ -135,6 +139,23 @@ class _TaskManager extends State<TaskManager> {
135139
);
136140
}
137141

142+
Future<UploadTask> uploadUint8List() async {
143+
UploadTask uploadTask;
144+
145+
// Create a Reference to the file
146+
Reference ref = FirebaseStorage.instance
147+
.ref()
148+
.child('flutter-tests')
149+
.child('/some-json.json');
150+
151+
const response = '{"key": "value", "number": 42}';
152+
final data = jsonDecode(response);
153+
154+
uploadTask = ref.putData(Uint8List.fromList(utf8.encode(jsonEncode(data))));
155+
156+
return Future.value(uploadTask);
157+
}
158+
138159
/// Handles the user pressing the PopupMenuItem item.
139160
Future<void> handleUploadType(UploadType type) async {
140161
switch (type) {
@@ -153,6 +174,12 @@ class _TaskManager extends State<TaskManager> {
153174
});
154175
}
155176
break;
177+
case UploadType.uint8List:
178+
final task = await uploadUint8List();
179+
setState(() {
180+
_uploadTasks = [..._uploadTasks, task];
181+
});
182+
break;
156183
case UploadType.clear:
157184
setState(() {
158185
_uploadTasks = [];
@@ -241,6 +268,11 @@ class _TaskManager extends State<TaskManager> {
241268
child: Text('Upload local file'),
242269
value: UploadType.file,
243270
),
271+
const PopupMenuItem(
272+
// ignore: sort_child_properties_last
273+
child: Text('Upload Uint8List'),
274+
value: UploadType.uint8List,
275+
),
244276
if (_uploadTasks.isNotEmpty)
245277
const PopupMenuItem(
246278
// ignore: sort_child_properties_last

‎packages/firebase_storage/firebase_storage/example/pubspec.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ dependencies:
99
firebase_storage: ^12.3.2
1010
flutter:
1111
sdk: flutter
12-
image_picker: ^1.0.2
13-
image_picker_for_web: ^2.1.12
12+
image_picker: ^1.1.2
13+
image_picker_for_web: ^3.0.5
1414
web: ^1.0.0
1515

1616
flutter:

‎packages/firebase_storage/firebase_storage_web/lib/src/interop/storage.dart‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,9 @@ class StorageReference
179179
/// Uploads data [blob] to the actual location with optional [metadata].
180180
/// Returns the [UploadTask] which can be used to monitor and manage
181181
/// the upload.
182-
UploadTask put(dynamic blob, [UploadMetadata? metadata]) {
182+
///
183+
/// `blob` can be a [Uint8List] or [Blob].
184+
UploadTask put(JSAny blob, [UploadMetadata? metadata]) {
183185
storage_interop.UploadTaskJsImpl taskImpl;
184186
if (metadata != null) {
185187
taskImpl = storage_interop.uploadBytesResumable(

‎packages/firebase_storage/firebase_storage_web/lib/src/reference_web.dart‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// BSD-style license that can be found in the LICENSE file.
55

66
import 'dart:convert';
7+
import 'dart:js_interop';
78
import 'dart:typed_data';
89

910
import 'package:firebase_storage_platform_interface/firebase_storage_platform_interface.dart';
@@ -143,7 +144,7 @@ class ReferenceWeb extends ReferencePlatform {
143144
return TaskWeb(
144145
this,
145146
_ref.put(
146-
data,
147+
data.toJS,
147148
settableMetadataToFbUploadMetadata(
148149
_cache.store(metadata),
149150
),
@@ -186,18 +187,24 @@ class ReferenceWeb extends ReferencePlatform {
186187
PutStringFormat format, [
187188
SettableMetadata? metadata,
188189
]) {
189-
dynamic _data = data;
190+
late Uint8List _data;
190191

191192
// The universal package is converting raw to base64, so we need to convert
192193
// Any base64 string values into a Uint8List.
193194
if (format == PutStringFormat.base64) {
194195
_data = base64Decode(data);
196+
} else if (format == PutStringFormat.base64Url) {
197+
_data = base64Url.decode(data);
198+
} else {
199+
// If the format is not base64 or base64Url, we need to encode the data
200+
// as a base64 string.
201+
_data = Uint8List.fromList(base64Encode(utf8.encode(data)).codeUnits);
195202
}
196203

197204
return TaskWeb(
198205
this,
199206
_ref.put(
200-
_data,
207+
_data.toJS,
201208
settableMetadataToFbUploadMetadata(
202209
_cache.store(metadata),
203210
// md5 is computed server-side, so we don't have to unpack a potentially huge Blob.

‎tests/integration_test/firebase_storage/reference_e2e.dart‎

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -240,33 +240,36 @@ void setupReferenceTests() {
240240
group(
241241
'putData',
242242
() {
243-
test('uploads a file with buffer and download to check content matches',
244-
() async {
245-
const text = 'put data text to compare with uploaded and downloaded';
246-
List<int> list = utf8.encode(text);
243+
test(
244+
'uploads a file with buffer and download to check content matches',
245+
() async {
246+
const text =
247+
'put data text to compare with uploaded and downloaded';
248+
List<int> list = utf8.encode(text);
247249

248-
Uint8List data = Uint8List.fromList(list);
250+
Uint8List data = Uint8List.fromList(list);
249251

250-
final Reference ref =
251-
storage.ref('flutter-tests').child('flt-ok.txt');
252+
final Reference ref =
253+
storage.ref('flutter-tests').child('flt-ok.txt');
252254

253-
final TaskSnapshot complete = await ref.putData(
254-
data,
255-
SettableMetadata(
256-
contentLanguage: 'en',
257-
),
258-
);
255+
final TaskSnapshot complete = await ref.putData(
256+
data,
257+
SettableMetadata(
258+
contentLanguage: 'en',
259+
),
260+
);
259261

260-
expect(complete.metadata?.size, text.length);
261-
expect(complete.metadata?.contentLanguage, 'en');
262+
expect(complete.metadata?.size, text.length);
263+
expect(complete.metadata?.contentLanguage, 'en');
262264

263-
// Download the file from Firebase Storage
264-
final downloadedData = await ref.getData();
265-
final downloadedContent = String.fromCharCodes(downloadedData!);
265+
// Download the file from Firebase Storage
266+
final downloadedData = await ref.getData();
267+
final downloadedContent = String.fromCharCodes(downloadedData!);
266268

267-
// Verify that the downloaded content matches the original content
268-
expect(downloadedContent, equals(text));
269-
});
269+
// Verify that the downloaded content matches the original content
270+
expect(downloadedContent, equals(text));
271+
},
272+
);
270273

271274
//TODO(pr-mais): causes the emulator to crash
272275
// test('errors if permission denied', () async {
@@ -282,8 +285,27 @@ void setupReferenceTests() {
282285
// .having((e) => e.message, 'message',
283286
// 'User is not authorized to perform the desired action.')));
284287
// });
288+
289+
test(
290+
'upload a json file',
291+
() async {
292+
final Map<String, dynamic> data = <String, dynamic>{
293+
'name': 'John Doe',
294+
'age': 30,
295+
};
296+
final Uint8List jsonData = utf8.encode(jsonEncode(data));
297+
final Reference ref =
298+
storage.ref('flutter-tests').child('flt-web-ok.json');
299+
final TaskSnapshot complete = await ref.putData(
300+
jsonData,
301+
SettableMetadata(
302+
contentType: 'application/json',
303+
),
304+
);
305+
expect(complete.metadata?.contentType, 'application/json');
306+
},
307+
);
285308
},
286-
skip: kIsWeb,
287309
);
288310

289311
group('putBlob', () {

0 commit comments

Comments
 (0)
0