[ios] [bookmarks] Remove observer pattern during the category files exporting #7933

Merged

root merged 3 commits from ios/share-bookmarks-with-completion-handler into master

2024-04-16 18:41:41 +00:00

kirylkaveryn commented

2024-04-16 14:01:36 +00:00

Member

For now to handle the file sharing OM uses the observing pattern tightened to the MWMBookmarksManagers, that is too complex for this straightforward task:

subscribe for the observarion
register observer
send sharing message
wait for sharing result
handle sharing result
notify observers
unsubscribe from observing

This is too complex because the c++ method that we interact with uses the completion handlers to return sharing results and there is no sense in wrapping the completion handle into observation:

void BookmarkManager::PrepareFileForSharing(kml::GroupIdCollection && categoriesIds, SharingHandler && handler)

This PR converts c++ completion handler into the objc and returns to the caller so we can share files easily with the MWMBookmarksManagers and handle result without additional overhead:

- (void)shareCategory:(MWMMarkGroupID)groupId completion:(SharingResultCompletionHandler)completion;
- (void)shareAllCategoriesWithCompletion:(SharingResultCompletionHandler)completion;

https://github.com/organicmaps/organicmaps/assets/79797627/7ceabaa2-0880-41e4-bfed-28c565911950

For now to handle the` file sharing` OM uses the observing pattern tightened to the MWMBookmarksManagers, that is too complex for this straightforward task: 1. subscribe for the observarion 2. register observer 3. send sharing message 4. wait for sharing result 5. handle sharing result 6. notify observers 7. unsubscribe from observing This is too complex because the c++ method that we interact with uses the completion handlers to return sharing results and there is no sense in wrapping the completion handle into observation: ```cpp void BookmarkManager::PrepareFileForSharing(kml::GroupIdCollection && categoriesIds, SharingHandler && handler) ``` This PR converts c++ completion handler into the objc and returns to the caller so we can share files easily with the MWMBookmarksManagers and handle result without additional overhead: ```objc - (void)shareCategory:(MWMMarkGroupID)groupId completion:(SharingResultCompletionHandler)completion; - (void)shareAllCategoriesWithCompletion:(SharingResultCompletionHandler)completion; ``` https://github.com/organicmaps/organicmaps/assets/79797627/7ceabaa2-0880-41e4-bfed-28c565911950

biodranik (Migrated from github.com) approved these changes 2024-04-16 14:14:05 +00:00

biodranik (Migrated from github.com) left a comment

Thanks, the functionality did not change, right? All cases (including errors) are properly handled now in the Bookmarks and Tracks dialog, right?

iphone/CoreApi/CoreApi/Bookmarks/MWMBookmarksManager.h

biodranik (Migrated from github.com) commented

2024-04-16 14:09:16 +00:00

Can the URL be null? Should it be documented here or somewhere else?
Is it a URL to a local file? It would be great to document it/rename it (urlToALocalFile?)

1. Can the URL be null? Should it be documented here or somewhere else? 2. Is it a URL to a local file? It would be great to document it/rename it (urlToALocalFile?)

iphone/CoreApi/CoreApi/Bookmarks/MWMBookmarksManager.mm

biodranik (Migrated from github.com) commented

2024-04-16 14:11:04 +00:00

Move one line above?

kirylkaveryn reviewed 2024-04-16 17:06:10 +00:00

iphone/CoreApi/CoreApi/Bookmarks/MWMBookmarksManager.h

kirylkaveryn commented

2024-04-16 17:06:10 +00:00

Author

Member

Yes. In case of status != .success URL will be null
Yes it is URL to the local temporary file

1. Yes. In case of `status != .success` URL will be null 2. Yes it is URL to the local temporary file

kirylkaveryn reviewed 2024-04-16 17:16:40 +00:00

iphone/CoreApi/CoreApi/Bookmarks/MWMBookmarksManager.h

kirylkaveryn commented

2024-04-16 17:16:40 +00:00

Author

Member

@biodranik I can add some documentation to clarify the usage of these methods:


/**
 Shares a specific category with the given group ID.

 @param groupId The identifier for the category to be shared.
 @param completion A block that handles the result of the share operation. This block has no return value and takes two parameters:
                   - status: The status of the share operation, of type `MWMBookmarksShareStatus`.
                   - urlToALocalFile: The local file URL containing the shared data. This parameter is guaranteed to be non-nil only if `status` is `MWMBookmarksShareStatusSuccess`. In other cases, it will be nil.
*/
- (void)shareCategory:(MWMMarkGroupID)groupId completion:(SharingResultCompletionHandler)completion;

/**
 Shares all categories.

 @param completion A block that handles the result of the share operation. This block has no return value and takes two parameters:
                   - status: The status of the share operation, of type `MWMBookmarksShareStatus`.
                   - urlToALocalFile: The local file URL containing the shared data. This parameter is guaranteed to be non-nil only if `status` is `MWMBookmarksShareStatusSuccess`.  In other cases, it will be nil.
*/
- (void)shareAllCategoriesWithCompletion:(SharingResultCompletionHandler)completion;

@biodranik I can add some documentation to clarify the usage of these methods: ```objc /** Shares a specific category with the given group ID. @param groupId The identifier for the category to be shared. @param completion A block that handles the result of the share operation. This block has no return value and takes two parameters: - status: The status of the share operation, of type `MWMBookmarksShareStatus`. - urlToALocalFile: The local file URL containing the shared data. This parameter is guaranteed to be non-nil only if `status` is `MWMBookmarksShareStatusSuccess`. In other cases, it will be nil. */ - (void)shareCategory:(MWMMarkGroupID)groupId completion:(SharingResultCompletionHandler)completion; /** Shares all categories. @param completion A block that handles the result of the share operation. This block has no return value and takes two parameters: - status: The status of the share operation, of type `MWMBookmarksShareStatus`. - urlToALocalFile: The local file URL containing the shared data. This parameter is guaranteed to be non-nil only if `status` is `MWMBookmarksShareStatusSuccess`. In other cases, it will be nil. */ - (void)shareAllCategoriesWithCompletion:(SharingResultCompletionHandler)completion; ``` <img width="380" alt="image" src="https://github.com/organicmaps/organicmaps/assets/79797627/f464d7d7-8197-4c3a-9fdf-e0b5716d94ed">