Add information collection function

cdoky · Apr 29, 2024 · 2f62562 · 2f62562
1 parent 5a4f0d9
commit 2f62562
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 2 deletions.
diff --git a/AliyunOSSSDK/OSSClient.m b/AliyunOSSSDK/OSSClient.m
@@ -119,6 +119,7 @@ - (instancetype)initWithEndpoint:(NSString *)endpoint
             netConf.maxConcurrentRequestCount = conf.maxConcurrentRequestCount;
             netConf.enableFollowRedirects = conf.isFollowRedirectsEnable;
             netConf.HTTPMaximumConnectionsPerHost = conf.HTTPMaximumConnectionsPerHost;
+            netConf.enableNetworkMetricInfo = conf.isAllowNetworkMetricInfo;
         }
         self.networking = [[OSSNetworking alloc] initWithConfiguration:netConf];
     }

diff --git a/AliyunOSSSDK/OSSDefine.h b/AliyunOSSSDK/OSSDefine.h
@@ -59,6 +59,7 @@
 #define OSSServerErrorDomain                    @"com.aliyun.oss.serverError"
 
 #define OSSErrorMessageTOKEN                    @"ErrorMessage"
+#define OSSNetworkTaskMetrics                   @"NetworkTaskMetrics"
 
 #define OSSHttpHeaderContentDisposition         @"Content-Disposition"
 #define OSSHttpHeaderXOSSCallback               @"x-oss-callback"

diff --git a/AliyunOSSSDK/OSSModel.h b/AliyunOSSSDK/OSSModel.h
@@ -230,6 +230,9 @@ Sets the session Id for background file transmission
 /// https://developer.apple.com/documentation/foundation/urlsessionconfiguration/1407597-httpmaximumconnectionsperhost
 @property (nonatomic, assign) uint32_t HTTPMaximumConnectionsPerHost;
 
+/// Set whether to allow metric information
+@property (nonatomic, assign) BOOL isAllowNetworkMetricInfo;
+
 @end
 
 @protocol OSSRequestInterceptor <NSObject>

diff --git a/AliyunOSSSDK/OSSModel.m b/AliyunOSSSDK/OSSModel.m
@@ -304,6 +304,7 @@ - (instancetype)init {
         self.isFollowRedirectsEnable = YES;
         // When the value <= 0, do not set HTTPMaximumConnectionsPerHost and use the default value of NSURLSessionConfiguration
         self.HTTPMaximumConnectionsPerHost = 0;
+        self.isAllowNetworkMetricInfo = NO;
     }
     return self;
 }

diff --git a/AliyunOSSSDK/OSSNetworking.h b/AliyunOSSSDK/OSSNetworking.h
@@ -28,6 +28,7 @@
 @property (nonatomic, strong) NSString * proxyHost;
 @property (nonatomic, strong) NSNumber * proxyPort;
 @property (nonatomic, assign) BOOL enableFollowRedirects;
+@property (nonatomic, assign) BOOL enableNetworkMetricInfo;
 @property (nonatomic, assign) uint32_t HTTPMaximumConnectionsPerHost;
 @end
 

diff --git a/AliyunOSSSDK/OSSNetworking.m b/AliyunOSSSDK/OSSNetworking.m
@@ -95,7 +95,15 @@ - (OSSTask *)sendRequest:(OSSNetworkingRequestDelegate *)request {
         // 1.判断是否出错，如果出错的话，直接设置错误信息
         if (error)
         {
-            [taskCompletionSource setError:error];
+            if (weakRequest.metrics) {
+                NSMutableDictionary *userInfo = error.userInfo ? [NSMutableDictionary dictionaryWithDictionary:error.userInfo] : [NSMutableDictionary dictionary];
+                [userInfo oss_setObject:weakRequest.metrics forKey:OSSNetworkTaskMetrics];
+                [taskCompletionSource setError:[NSError errorWithDomain:error.domain
+                                                                   code:error.code
+                                                               userInfo:userInfo]];
+            } else {
+                [taskCompletionSource setError:error];
+            }
         }else
         {
             [self checkForCrc64WithResult:responseObject
@@ -379,7 +387,9 @@ - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)sessionTask
 
             [self dataTaskWithDelegate:delegate];
         } else {
-            delegate.completionHandler([delegate.responseParser constructResultObject], nil);
+            OSSResult *result = [delegate.responseParser constructResultObject];
+            result.metrics = delegate.metrics;
+            delegate.completionHandler(result, nil);
         }
         return nil;
     }];
@@ -440,6 +450,14 @@ - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task
     }
 }
 
+- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didFinishCollectingMetrics:(NSURLSessionTaskMetrics *)metrics {
+    if (self.configuration.enableNetworkMetricInfo) {
+        OSSNetworkingRequestDelegate *delegate = [self.sessionDelagateManager objectForKey:@(task.taskIdentifier)];
+        delegate.metrics = metrics;
+        OSSLogDebug(@"%@", metrics);
+    }
+}
+
 #pragma mark - NSURLSessionDataDelegate Methods
 
 - (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler

diff --git a/AliyunOSSSDK/OSSNetworkingRequestDelegate.h b/AliyunOSSSDK/OSSNetworkingRequestDelegate.h
@@ -50,6 +50,8 @@
 
 @property (atomic, strong) NSURLSessionDataTask *currentSessionTask;
 
+@property (nonatomic, strong) NSURLSessionTaskMetrics *metrics API_AVAILABLE(macos(10.12), ios(10.0));
+
 @property (nonatomic, copy) OSSNetworkingUploadProgressBlock uploadProgress;
 @property (nonatomic, copy) OSSNetworkingDownloadProgressBlock downloadProgress;
 @property (nonatomic, copy) OSSNetworkingRetryBlock retryCallback;

diff --git a/AliyunOSSSDK/OSSResult.h b/AliyunOSSSDK/OSSResult.h
@@ -39,4 +39,7 @@
  */
 @property (nonatomic, copy) NSString *localCRC64ecma;
 
+/// statistics information for the task.
+@property (nonatomic, strong) NSURLSessionTaskMetrics *metrics API_AVAILABLE(macos(10.12), ios(10.0));
+
 @end
diff --git a/AliyunOSSiOSTests/OSSConfigurationTest.m b/AliyunOSSiOSTests/OSSConfigurationTest.m
@@ -9,6 +9,7 @@
 #import <XCTest/XCTest.h>
 #import <AliyunOSSiOS/AliyunOSSiOS.h>
 #import "OSSTestMacros.h"
+#import "OSSTestUtils.h"
 
 @interface OSSConfigurationTest : XCTestCase {
     NSString *host;
@@ -149,4 +150,57 @@ - (void)testCustomPathPrefixEnableWithNullObject {
     }] waitUntilFinished];
 }
 
+- (void)testAllowNetworkMetricInfo {
+    OSSClientConfiguration *config = [OSSClientConfiguration new];
+    OSSAuthCredentialProvider *credentialProvider = [[OSSAuthCredentialProvider alloc] initWithAuthServerUrl:OSS_STSTOKEN_URL];
+    OSSClient *client = [[OSSClient alloc] initWithEndpoint:OSS_ENDPOINT credentialProvider:credentialProvider clientConfiguration:config];
+
+    NSString *privateBucketName = [OSSTestUtils getBucketName];
+    OSSCreateBucketRequest *createBucket = [OSSCreateBucketRequest new];
+    createBucket.bucketName = privateBucketName;
+    OSSTask *task = [client createBucket:createBucket];
+    [task waitUntilFinished];
+    XCTAssertNil(((OSSResult *)task.result).metrics);
+
+    OSSPutObjectRequest * put = [OSSPutObjectRequest new];
+    put.bucketName = privateBucketName;
+    put.objectKey = OSS_IMAGE_KEY;
+    put.uploadingFileURL = [[NSBundle mainBundle] URLForResource:@"hasky" withExtension:@"jpeg"];
+    task = [client putObject:put];
+    [task waitUntilFinished];
+    XCTAssertNil(((OSSResult *)task.result).metrics);
+
+    OSSGetObjectRequest *get = [OSSGetObjectRequest new];
+    get.bucketName = privateBucketName;
+    get.objectKey = @"error";
+    get.onRecieveData = ^(NSData * _Nonnull data) {
+    };
+    task = [client getObject:get];
+    [task waitUntilFinished];
+    XCTAssertNil(task.error.userInfo[OSSNetworkTaskMetrics]);
+
+    config = [OSSClientConfiguration new];
+    config.isAllowNetworkMetricInfo = YES;
+    client = [[OSSClient alloc] initWithEndpoint:OSS_ENDPOINT credentialProvider:credentialProvider clientConfiguration:config];
+
+    put = [OSSPutObjectRequest new];
+    put.bucketName = privateBucketName;
+    put.objectKey = OSS_IMAGE_KEY;
+    put.uploadingFileURL = [[NSBundle mainBundle] URLForResource:@"hasky" withExtension:@"jpeg"];
+    task = [client putObject:put];
+    [task waitUntilFinished];
+    XCTAssertNotNil(((OSSResult *)task.result).metrics);
+
+    get = [OSSGetObjectRequest new];
+    get.bucketName = privateBucketName;
+    get.objectKey = @"error";
+    get.onRecieveData = ^(NSData * _Nonnull data) {
+    };
+    task = [client getObject:get];
+    [task waitUntilFinished];
+    XCTAssertNotNil(task.error.userInfo[OSSNetworkTaskMetrics]);
+
+    [OSSTestUtils cleanBucket:privateBucketName with:client];
+}
+
 @end
diff --git a/AliyunOSSiOSTests/OSSTestUtils.h b/AliyunOSSiOSTests/OSSTestUtils.h
@@ -12,6 +12,7 @@
 @interface OSSTestUtils : NSObject
 + (void)cleanBucket: (NSString *)bucket with: (OSSClient *)client;
 + (void) putTestDataWithKey: (NSString *)key withClient: (OSSClient *)client withBucket: (NSString *)bucket;
++ (NSString *)getBucketName;
 @end
 
 @interface OSSProgressTestUtils : NSObject

diff --git a/AliyunOSSiOSTests/OSSTestUtils.m b/AliyunOSSiOSTests/OSSTestUtils.m
@@ -71,6 +71,10 @@ + (void) putTestDataWithKey: (NSString *)key withClient: (OSSClient *)client wit
     [task waitUntilFinished];
 }
 
++ (NSString *)getBucketName {
+    return [NSString stringWithFormat:@"bucket-%ld", @([NSDate date].timeIntervalSince1970).integerValue];
+}
+
 @end
 
 @interface OSSProgressTestUtils()