KS-66 修复上传进度相关问题 (#102)

* 修复表单上传进度粒度

* 修复分片上传重试导致的进度异常

* 更新Dio

* 添加example

* 更新example的environment

* fix ci

* review fix

Author: zhangzqs

base/example/.gitignore

@@ -0,0 +1,3 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/

base/example/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

base/example/README.md

@@ -0,0 +1,2 @@
+A sample command-line application with an entrypoint in `bin/`, library code
+in `lib/`, and example unit test in `test/`.

base/example/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

base/example/bin/qiniu_dart_sdk_example.dart

@@ -0,0 +1,44 @@
+import 'dart:io';
+import 'package:qiniu_sdk_base/qiniu_sdk_base.dart';
+import 'package:logger/logger.dart';
+
+final logger = Logger(
+  printer: PrettyPrinter(
+    methodCount: 1,
+    dateTimeFormat: DateTimeFormat.dateAndTime,
+  ),
+  level: Level.trace,
+  filter: ProductionFilter(),
+);
+
+void main(List<String> arguments) async {
+  final token = "<uptoken>";
+  final file = File("<file path>");
+  assert(file.existsSync());
+
+  final storage = Storage();
+  final controller = PutController();
+  controller.addProgressListener((progress) {
+    logger.d("Progress: $progress");
+  });
+  controller.addStatusListener((status) {
+    logger.d("Status: $status");
+  });
+  controller.addSendProgressListener((sendProgress) {
+    logger.d("Send Progress: $sendProgress");
+  });
+
+  final now = DateTime.now();
+  await storage.putFile(
+    file,
+    token,
+    options: PutOptions(
+      forceBySingle: true, // 强制表单上传
+      controller: controller,
+      partSize: 4,
+    ),
+  );
+  logger.d(
+    "Upload completed in ${DateTime.now().difference(now).inSeconds} seconds",
+  );
+}

base/example/pubspec.yaml

@@ -0,0 +1,17 @@
+name: qiniu_dart_sdk_example
+description: A sample command-line application.
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: ">=3.0.0 <4.0.0"
+
+dependencies:
+  qiniu_sdk_base:
+    path: ../
+  dio: ^5.8.0+1
+  logger: ^2.6.0
+
+dev_dependencies:
+  test: any
+  lints: any

base/lib/src/storage/methods/put/by_part/upload_part_task.dart

@@ -66,7 +66,7 @@ class UploadPartTask extends RequestTask<UploadPart> {
 
     final response = await client.put<Map<String, dynamic>>(
       paramUrl,
-      data: Stream.fromIterable([bytes.cast<int>()]),
+      data: Stream.value(bytes),
       // 在 data 是 stream 的场景下， interceptor 传入 cancelToken 这里不传会有 bug
       cancelToken: controller?.cancelToken,
       options: Options(

base/lib/src/storage/methods/put/by_part/upload_parts_task.dart

@@ -144,7 +144,7 @@ class UploadPartsTask extends RequestTask<List<Part>> with CacheMixin {
       // partNumber 按照后端要求必须从 1 开始
       final partNumber = ++_uploadingPartIndex;
 
-      await for (var bytes in resource.stream) {
+      await for (final bytes in resource.stream) {
         // 跳过上传过的分片
         final uploadedPart = _uploadedPartMap[partNumber];
         if (uploadedPart != null) {
@@ -189,7 +189,9 @@ class UploadPartsTask extends RequestTask<List<Part>> with CacheMixin {
     controller
       // UploadPartTask 一次上传一个 chunk，通知一次进度
       ..addSendProgressListener((percent) {
-        _sentPartCount++;
+        if (!task.isRetrying) {
+          _sentPartCount++;
+        }
         notifySendProgress();
       })
       // UploadPartTask 上传完成后触发

base/lib/src/storage/methods/put/by_single/put_by_single_task.dart

@@ -1,12 +1,12 @@
 import 'package:dio/dio.dart';
 
+import '../../../../util/chunk_list.dart' show chunkList;
 import '../../../../../qiniu_sdk_base.dart';
 import '../../../resource/resource.dart';
 
 // 直传任务
 class PutBySingleTask extends RequestTask<PutResponse> {
-  late Resource resource;
-
+  final Resource resource;
   final PutOptions options;
 
   /// 上传凭证
@@ -56,7 +56,11 @@ class PutBySingleTask extends RequestTask<PutResponse> {
     await resource.open();
 
     final multipartFile = MultipartFile.fromStream(
-      resource.getStream,
+      () {
+        return resource
+            .getStream()
+            .expand((data) => chunkList(data, 64 * 1024));
+      },
       resource.length,
       // 与其他 sdk 保持一致，没有 filename 就是问号
       filename: filename ?? '?',

base/lib/src/storage/storage.dart

@@ -20,11 +20,10 @@ export 'config/config.dart';
 
 /// 客户端
 class Storage {
-  late final Config config;
+  final Config config;
   late final RequestTaskManager taskManager;
 
-  Storage({Config? config}) {
-    this.config = config ?? Config();
+  Storage({Config? config}) : config = config ?? Config() {
     taskManager = RequestTaskManager(config: this.config);
   }