Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(storage, apple): clean up event channel, stream handler and task on completion #16708

Merged
merged 2 commits into from
Nov 19, 2024
+45 −10
Merged

fix(storage, apple): clean up event channel, stream handler and task on completion #16708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7da12c1
fix(storage, apple): clean up event channel, stream handler and task …
russellwheatley Nov 18, 2024
1dc5319
chore: streamhandler has already been cancelled
russellwheatley Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/firebase_storage/firebase_storage/ios/Classes/FLTFirebaseStoragePlugin.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@

+ (NSDictionary *)parseTaskSnapshot:(FIRStorageTaskSnapshot *)snapshot;
+ (NSDictionary *)NSDictionaryFromNSError:(NSError *)error;
- (void)cleanUpTask:(NSString *)channelName handle:(NSNumber *)handle;
@end
32 changes: 26 additions & 6 deletions packages/firebase_storage/firebase_storage/ios/Classes/FLTFirebaseStoragePlugin.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,10 +412,10 @@ - (void)referencePutDataApp:(PigeonStorageFirebaseApp *)app
self->_tasks[handle] = task;
}

completion([self setupTaskListeners:task], nil);
completion([self setupTaskListeners:task handle:handle], nil);
}

- (NSString *)setupTaskListeners:(FIRStorageObservableTask *)task {
- (NSString *)setupTaskListeners:(FIRStorageObservableTask *)task handle:(NSNumber *)handle {
// Generate a random UUID to register with
NSString *uuid = [[NSUUID UUID] UUIDString];

Expand All @@ -426,7 +426,10 @@ - (NSString *)setupTaskListeners:(FIRStorageObservableTask *)task {
FlutterEventChannel *channel = [FlutterEventChannel eventChannelWithName:channelName
binaryMessenger:_binaryMessenger];
FLTTaskStateChannelStreamHandler *handler =
[[FLTTaskStateChannelStreamHandler alloc] initWithTask:task];
[[FLTTaskStateChannelStreamHandler alloc] initWithTask:task
storagePlugin:self
channelName:channelName
handle:handle];
[channel setStreamHandler:handler];

[_eventChannels setObject:channel forKey:channelName];
Expand All @@ -435,6 +438,23 @@ - (NSString *)setupTaskListeners:(FIRStorageObservableTask *)task {
return uuid;
}

- (void)cleanUpTask:(NSString *)channelName handle:(NSNumber *)handle {
NSObject<FlutterStreamHandler> *handler = [_streamHandlers objectForKey:channelName];
if (handler) {
[_streamHandlers removeObjectForKey:channelName];
}

FlutterEventChannel *channel = [_eventChannels objectForKey:channelName];
if (channel) {
[channel setStreamHandler:nil];
[_eventChannels removeObjectForKey:channelName];
}

@synchronized(self->_tasks) {
[self->_tasks removeObjectForKey:handle];
}
}

- (void)referencePutStringApp:(PigeonStorageFirebaseApp *)app
reference:(PigeonStorageReference *)reference
data:(NSString *)data
Expand All @@ -456,7 +476,7 @@ - (void)referencePutStringApp:(PigeonStorageFirebaseApp *)app
self->_tasks[handle] = task;
}

completion([self setupTaskListeners:task], nil);
completion([self setupTaskListeners:task handle:handle], nil);
}

- (void)referencePutFileApp:(PigeonStorageFirebaseApp *)app
Expand All @@ -481,7 +501,7 @@ - (void)referencePutFileApp:(PigeonStorageFirebaseApp *)app
self->_tasks[handle] = task;
}

completion([self setupTaskListeners:task], nil);
completion([self setupTaskListeners:task handle:handle], nil);
}

- (void)referenceDownloadFileApp:(PigeonStorageFirebaseApp *)app
Expand All @@ -501,7 +521,7 @@ - (void)referenceDownloadFileApp:(PigeonStorageFirebaseApp *)app
self->_tasks[handle] = task;
}

completion([self setupTaskListeners:task], nil);
completion([self setupTaskListeners:task handle:handle], nil);
}

- (void)referenceUpdateMetadataApp:(PigeonStorageFirebaseApp *)app
Expand Down
6 changes: 4 additions & 2 deletions packages/firebase_storage/firebase_storage/ios/Classes/FLTTaskStateChannelStreamHandler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
NS_ASSUME_NONNULL_BEGIN

@interface FLTTaskStateChannelStreamHandler : NSObject <FlutterStreamHandler>

- (instancetype)initWithTask:(FIRStorageObservableTask *)task;
- (instancetype)initWithTask:(FIRStorageObservableTask *)task
storagePlugin:(FLTFirebaseStoragePlugin *)storagePlugin
channelName:(NSString *)channelName
handle:(NSNumber *)handle;

@end

Expand Down
16 changes: 14 additions & 2 deletions packages/firebase_storage/firebase_storage/ios/Classes/FLTTaskStateChannelStreamHandler.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,25 @@

@implementation FLTTaskStateChannelStreamHandler {
FIRStorageObservableTask *_task;

FLTFirebaseStoragePlugin *_storagePlugin;
NSString *_channelName;
NSNumber *_handle;
FIRStorageHandle successHandle;
FIRStorageHandle failureHandle;
FIRStorageHandle pausedHandle;
FIRStorageHandle progressHandle;
}

- (instancetype)initWithTask:(FIRStorageObservableTask *)task {
- (instancetype)initWithTask:(FIRStorageObservableTask *)task
storagePlugin:(FLTFirebaseStoragePlugin *)storagePlugin
channelName:(NSString *)channelName
handle:(NSNumber *)handle {
self = [super init];
if (self) {
_task = task;
_storagePlugin = storagePlugin;
_channelName = channelName;
_handle = handle;
}
return self;
}
Expand Down Expand Up @@ -98,6 +106,10 @@ - (FlutterError *)onCancelWithArguments:(id)arguments {
}
progressHandle = nil;

if (_storagePlugin) {
[_storagePlugin cleanUpTask:_channelName handle:_handle];
}

return nil;
}

Expand Down
Loading