Skip to content

Commit c7c0027

Browse files
brennanMKEbrennanMKE
authored
fix(S3): removes completed tasks from dictionary and clears handlers (aws-amplify#3833)
* fix(S3): removes completed tasks from dictionary and clears handlers aws-amplify#2053 * completion dictionary was not being cleared of completed tasks * once a task is complete it no longer has to be retained * handlers should be cleared to prevent retain cycles * tested for auto-resume which works as intended
1 parent fa2b9ce commit c7c0027

7 files changed

+214
-95
lines changed

‎AWSS3/AWSS3TransferUtility.m

+19-30
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#import "AWSS3TransferUtilityDatabaseHelper.h"
2020
#import "AWSS3TransferUtilityTasks.h"
2121
#import "AWSS3CreateMultipartUploadRequest+RequestHeaders.h"
22+
#import "AWSS3TransferUtilityTasks+Completion.h"
2223

2324
#import <AWSCore/AWSFMDB.h>
2425
#import <AWSCore/AWSSynchronizedMutableDictionary.h>
@@ -1178,14 +1179,11 @@ - (void) retryUpload: (AWSS3TransferUtilityUploadTask *) transferUtilityUploadTa
11781179
if (![[NSFileManager defaultManager] fileExistsAtPath:transferUtilityUploadTask.file]) {
11791180
NSDictionary *userInfo = [NSDictionary dictionaryWithObject:@"Local file not found"
11801181
forKey:@"Message"];
1181-
11821182
NSError *error = [NSError errorWithDomain:AWSS3TransferUtilityErrorDomain
11831183
code:AWSS3TransferUtilityErrorLocalFileNotFound
11841184
userInfo:userInfo];
1185-
1186-
if (transferUtilityUploadTask.expression.completionHandler) {
1187-
transferUtilityUploadTask.expression.completionHandler(transferUtilityUploadTask, error);
1188-
}
1185+
transferUtilityUploadTask.error = error;
1186+
[self completeTask:transferUtilityUploadTask];
11891187
}
11901188
else {
11911189
//This will update the AWSS3TransferUtilityUploadTask passed into it with a new URL Session
@@ -1705,11 +1703,9 @@ -(void) retryUploadSubTask: (AWSS3TransferUtilityMultiPartUploadTask *) transfer
17051703
//cancel the multipart transfer
17061704
[transferUtilityMultiPartUploadTask cancel];
17071705
transferUtilityMultiPartUploadTask.status = AWSS3TransferUtilityTransferStatusError;
1708-
1706+
transferUtilityMultiPartUploadTask.error = subTaskCreationError;
17091707
//Call the completion handler if one was present
1710-
if (transferUtilityMultiPartUploadTask.expression.completionHandler) {
1711-
transferUtilityMultiPartUploadTask.expression.completionHandler(transferUtilityMultiPartUploadTask, subTaskCreationError);
1712-
}
1708+
[self completeTask:transferUtilityMultiPartUploadTask];
17131709
}
17141710
}
17151711

@@ -2210,10 +2206,8 @@ - (void)URLSession:(NSURLSession *)session
22102206
}
22112207

22122208
[self cleanupForUploadTask:uploadTask];
2213-
2214-
if(uploadTask.expression.completionHandler) {
2215-
uploadTask.expression.completionHandler(uploadTask,uploadTask.error);
2216-
}
2209+
2210+
[self completeTask:uploadTask];
22172211
return;
22182212
}
22192213
else if ([transferUtilityTask isKindOfClass:[AWSS3TransferUtilityMultiPartUploadTask class]]) {
@@ -2278,10 +2272,8 @@ - (void)URLSession:(NSURLSession *)session
22782272
transferUtilityMultiPartUploadTask.status = AWSS3TransferUtilityTransferStatusError;
22792273

22802274
//Execute call back if provided.
2281-
if(transferUtilityMultiPartUploadTask.expression.completionHandler) {
2282-
transferUtilityMultiPartUploadTask.expression.completionHandler(transferUtilityMultiPartUploadTask, transferUtilityMultiPartUploadTask.error);
2283-
}
2284-
2275+
[self completeTask:transferUtilityMultiPartUploadTask];
2276+
22852277
//Make sure all other parts that are in progress are canceled.
22862278
for (NSNumber *key in [transferUtilityMultiPartUploadTask.inProgressPartsDictionary allKeys]) {
22872279
AWSS3TransferUtilityUploadSubTask *subTask = [transferUtilityMultiPartUploadTask.inProgressPartsDictionary objectForKey:key];
@@ -2364,10 +2356,8 @@ - (void)URLSession:(NSURLSession *)session
23642356
userInfo:userInfo];
23652357

23662358
//Execute call back if provided.
2367-
if(transferUtilityMultiPartUploadTask.expression.completionHandler) {
2368-
transferUtilityMultiPartUploadTask.expression.completionHandler(transferUtilityMultiPartUploadTask, transferUtilityMultiPartUploadTask.error);
2369-
}
2370-
2359+
[self completeTask:transferUtilityMultiPartUploadTask];
2360+
23712361
//Abort the request, so the server can clean up any partials.
23722362
[self callAbortMultiPartForUploadTask:transferUtilityMultiPartUploadTask];
23732363

@@ -2402,9 +2392,7 @@ - (void)URLSession:(NSURLSession *)session
24022392
[self cleanupForMultiPartUploadTask:transferUtilityMultiPartUploadTask];
24032393

24042394
//Call the callback function is specified.
2405-
if(transferUtilityMultiPartUploadTask.expression.completionHandler) {
2406-
transferUtilityMultiPartUploadTask.expression.completionHandler(transferUtilityMultiPartUploadTask,error);
2407-
}
2395+
[self completeTask:transferUtilityMultiPartUploadTask];
24082396
return nil;
24092397
}];
24102398
}
@@ -2463,12 +2451,7 @@ - (void)URLSession:(NSURLSession *)session
24632451
downloadTask.expression.progressBlock(downloadTask, downloadTask.progress);
24642452
}
24652453
}
2466-
if (downloadTask.expression.completionHandler) {
2467-
downloadTask.expression.completionHandler(downloadTask,
2468-
downloadTask.location,
2469-
downloadTask.data,
2470-
downloadTask.error);
2471-
}
2454+
[self completeTask:downloadTask];
24722455
[self.completedTaskDictionary setObject:downloadTask forKey:downloadTask.transferID];
24732456
[self.taskDictionary removeObjectForKey:@(downloadTask.sessionTask.taskIdentifier)];
24742457
[AWSS3TransferUtilityDatabaseHelper deleteTransferRequestFromDB:downloadTask.transferID databaseQueue:_databaseQueue];
@@ -2539,6 +2522,12 @@ - (void)URLSession:(NSURLSession *)session
25392522

25402523
#pragma mark - Helper methods
25412524

2525+
- (void)completeTask:(AWSS3TransferUtilityTask *)task {
2526+
[task complete];
2527+
// complete task before removing from dictionary
2528+
[self.completedTaskDictionary removeObjectForKey:task.transferID];
2529+
}
2530+
25422531
- (void) cleanupForMultiPartUploadTask: (AWSS3TransferUtilityMultiPartUploadTask *) task {
25432532

25442533
//Add it to list of completed Tasks

‎AWSS3/AWSS3TransferUtilityTasks+Completion.h

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
//
2+
// Copyright 2010-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License").
5+
// You may not use this file except in compliance with the License.
6+
// A copy of the License is located at
7+
//
8+
// http://aws.amazon.com/apache2.0
9+
//
10+
// or in the "license" file accompanying this file. This file is distributed
11+
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
// express or implied. See the License for the specific language governing
13+
// permissions and limitations under the License.
14+
//
15+
16+
#import <Foundation/Foundation.h>
17+
18+
#import "AWSS3TransferUtilityTasks.h"
19+
20+
NS_ASSUME_NONNULL_BEGIN
21+
22+
@interface AWSS3TransferUtilityTask (Completion)
23+
24+
- (void)complete;
25+
26+
@end
27+
28+
@interface AWSS3TransferUtilityUploadTask (Completion)
29+
30+
- (void)complete;
31+
- (void)completeWithError:(NSError * _Nullable)error;
32+
33+
@end
34+
35+
@interface AWSS3TransferUtilityDownloadTask (Completion)
36+
37+
- (void)complete;
38+
- (void)completeWithLocation:(NSURL * _Nullable)location
39+
data:(NSData * _Nullable)data
40+
error:(NSError * _Nullable)error;
41+
42+
@end
43+
44+
@interface AWSS3TransferUtilityMultiPartUploadTask (Completion)
45+
46+
- (void)complete;
47+
- (void)completeWithError:(NSError * _Nullable)error;
48+
49+
@end
50+
51+
NS_ASSUME_NONNULL_END

‎AWSS3/AWSS3TransferUtilityTasks+Completion.m

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
//
2+
// Copyright 2010-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License").
5+
// You may not use this file except in compliance with the License.
6+
// A copy of the License is located at
7+
//
8+
// http://aws.amazon.com/apache2.0
9+
//
10+
// or in the "license" file accompanying this file. This file is distributed
11+
// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
// express or implied. See the License for the specific language governing
13+
// permissions and limitations under the License.
14+
//
15+
16+
#import "AWSS3TransferUtilityTasks+Completion.h"
17+
18+
@implementation AWSS3TransferUtilityTask (Completion)
19+
20+
- (void)complete {
21+
if ([self isKindOfClass:[AWSS3TransferUtilityUploadTask class]]) {
22+
AWSS3TransferUtilityUploadTask *task = (AWSS3TransferUtilityUploadTask *)self;
23+
[task complete];
24+
} else if ([self isKindOfClass:[AWSS3TransferUtilityDownloadTask class]]) {
25+
AWSS3TransferUtilityDownloadTask *task = (AWSS3TransferUtilityDownloadTask *)self;
26+
[task complete];
27+
} else if ([self isKindOfClass:[AWSS3TransferUtilityMultiPartUploadTask class]]) {
28+
AWSS3TransferUtilityMultiPartUploadTask *task = (AWSS3TransferUtilityMultiPartUploadTask *)self;
29+
[task complete];
30+
}
31+
}
32+
33+
@end
34+
35+
36+
@interface AWSS3TransferUtilityUploadTask()
37+
@property (strong, nonatomic) NSError *error;
38+
@property (strong, nonatomic) AWSS3TransferUtilityUploadExpression *expression;
39+
@end
40+
41+
@interface AWSS3TransferUtilityUploadExpression ()
42+
@property (copy, atomic) AWSS3TransferUtilityUploadCompletionHandlerBlock completionHandler;
43+
@end
44+
45+
@implementation AWSS3TransferUtilityUploadTask (Completion)
46+
47+
- (void)complete {
48+
[self completeWithError:self.error];
49+
}
50+
51+
- (void)completeWithError:(NSError * _Nullable)error {
52+
if (self.expression.completionHandler) {
53+
self.expression.completionHandler(self, error);
54+
// release handlers
55+
self.expression.completionHandler = nil;
56+
self.expression.progressBlock = nil;
57+
}
58+
}
59+
60+
@end
61+
62+
@interface AWSS3TransferUtilityDownloadTask ()
63+
@property (strong, nonatomic) NSURL *location;
64+
@property (strong, nonatomic) NSData *data;
65+
@property (strong, nonatomic) NSError *error;
66+
@property (strong, nonatomic) AWSS3TransferUtilityDownloadExpression *expression;
67+
@end
68+
69+
@interface AWSS3TransferUtilityDownloadExpression ()
70+
@property (copy, atomic) AWSS3TransferUtilityDownloadCompletionHandlerBlock completionHandler;
71+
@end
72+
73+
@implementation AWSS3TransferUtilityDownloadTask (Completion)
74+
75+
- (void)complete {
76+
[self completeWithLocation:self.location data:self.data error:self.error];
77+
}
78+
79+
- (void)completeWithLocation:(NSURL * _Nullable)location
80+
data:(NSData * _Nullable)data
81+
error:(NSError * _Nullable)error {
82+
if (self.expression.completionHandler) {
83+
self.expression.completionHandler(self, location, data, error);
84+
// release handlers
85+
self.expression.completionHandler = nil;
86+
self.expression.progressBlock = nil;
87+
}
88+
}
89+
90+
@end
91+
92+
@interface AWSS3TransferUtilityMultiPartUploadTask ()
93+
@property (strong, nonatomic) NSError *error;
94+
@property (strong, nonatomic) AWSS3TransferUtilityMultiPartUploadExpression *expression;
95+
@end
96+
97+
@interface AWSS3TransferUtilityMultiPartUploadExpression ()
98+
@property (copy, atomic) AWSS3TransferUtilityMultiPartUploadCompletionHandlerBlock completionHandler;
99+
@end
100+
101+
@implementation AWSS3TransferUtilityMultiPartUploadTask (Completion)
102+
103+
- (void)complete {
104+
[self completeWithError:self.error];
105+
}
106+
107+
- (void)completeWithError:(NSError * _Nullable)error {
108+
if (self.expression.completionHandler) {
109+
self.expression.completionHandler(self, error);
110+
// release handlers
111+
self.expression.completionHandler = nil;
112+
self.expression.progressBlock = nil;
113+
}
114+
}
115+
116+
@end

‎AWSS3/AWSS3TransferUtilityTasks.h

+1-42
Original file line numberDiff line numberDiff line change
@@ -179,48 +179,7 @@ typedef void (^AWSS3TransferUtilityMultiPartProgressBlock) (AWSS3TransferUtility
179179
/**
180180
The task object to represent a multipart upload task.
181181
*/
182-
@interface AWSS3TransferUtilityMultiPartUploadTask: NSObject
183-
184-
/**
185-
An identifier uniquely identifies the transferID.
186-
*/
187-
@property (readonly) NSString *transferID;
188-
189-
/**
190-
The Amazon S3 bucket name associated with the transfer.
191-
*/
192-
@property (readonly) NSString *bucket;
193-
194-
/**
195-
The Amazon S3 object key name associated with the transfer.
196-
*/
197-
@property (readonly) NSString *key;
198-
199-
/**
200-
The transfer progress.
201-
*/
202-
@property (readonly) NSProgress *progress;
203-
204-
/**
205-
the status of the Transfer.
206-
*/
207-
@property (readonly) AWSS3TransferUtilityTransferStatusType status;
208-
209-
210-
/**
211-
Cancels the task.
212-
*/
213-
- (void)cancel;
214-
215-
/**
216-
Resumes the task, if it is suspended.
217-
*/
218-
- (void)resume;
219-
220-
/**
221-
Temporarily suspends a task.
222-
*/
223-
- (void)suspend;
182+
@interface AWSS3TransferUtilityMultiPartUploadTask: AWSS3TransferUtilityTask
224183

225184
/**
226185
set completion handler for task

0 commit comments

Comments
 (0)