Merge pull request SDWebImage#3797 from dreampiggy/feature/remove_asyncMainQueue

Change the default callback queue policy to SafeAsyncMainThread, don't need main queue check at all

Author: dreampiggy

SDWebImage/Core/SDCallbackQueue.h

@@ -17,18 +17,16 @@ typedef NS_ENUM(NSUInteger, SDCallbackPolicy) {
     SDCallbackPolicyDispatch = 1,
     /// Ignore any async/sync and just directly invoke `block` in current queue (without `dispatch_async`/`dispatch_sync`)
     SDCallbackPolicyInvoke = 2,
-    /// Ensure callback in main queue (no gurantee on main thread). Do `dispatch_async` if the current queue is not main queue; else do invoke `block`. Never use `dispatch_sync`, suitable for general UI-related code
-    SDCallbackPolicySafeAsyncMainQueue = 3,
     /// Ensure callback in main thread. Do `dispatch_async` if the `NSThread.isMainTrhead == true` ; else do invoke `block`. Never use `dispatch_sync`, suitable for special UI-related code
-    SDCallbackPolicySafeAsyncMainThread = 4,
+    SDCallbackPolicySafeAsyncMainThread = 3,
 };
 
 /// SDCallbackQueue is a wrapper used to control how the completionBlock should perform on queues, used by our `Cache`/`Manager`/`Loader`.
 /// Useful when you call SDWebImage in non-main queue and want to avoid it callback into main queue, which may cause issue.
 @interface SDCallbackQueue : NSObject
 
 /// The main queue. This is the default value, has the same effect when passing `nil` to `SDWebImageContextCallbackQueue`
-/// The policy defaults to `SDCallbackPolicySafeAsyncMainQueue`
+/// The policy defaults to `SDCallbackPolicySafeAsyncMainThread`
 @property (nonnull, class, readonly) SDCallbackQueue *mainQueue;
 
 /// The caller current queue. Using `dispatch_get_current_queue`. This is not a dynamic value and only keep the first call time queue.
@@ -52,7 +50,7 @@ typedef NS_ENUM(NSUInteger, SDCallbackPolicy) {
 
 /// Submits a block for execution and returns after that block finishes executing.
 /// - Parameter block: The block that contains the work to perform.
-- (void)sync:(nonnull dispatch_block_t)block;
+- (void)sync:(nonnull dispatch_block_t)block API_DEPRECATED("No longer use, may cause deadlock when misused", macos(10.10, 10.10), ios(8.0, 8.0), tvos(9.0, 9.0), watchos(2.0, 2.0));;
 
 /// Schedules a block asynchronously for execution.
 /// - Parameter block: The block that contains the work to perform.

SDWebImage/Core/SDCallbackQueue.m

@@ -15,20 +15,7 @@ @interface SDCallbackQueue ()
 
 @end
 
-static inline void SDSafeMainQueueAsync(dispatch_block_t _Nonnull block) {
-    if (NSThread.isMainThread) {
-        // Match exists `dispatch_main_async_safe` behavior
-        const char *currentLabel = dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL);
-        const char *mainLabel = dispatch_queue_get_label(dispatch_get_main_queue());
-        if (mainLabel == currentLabel) {
-            block();
-            return;
-        }
-    }
-    dispatch_async(dispatch_get_main_queue(), block);
-}
-
-static inline void SDSafeMainThreadAsync(dispatch_block_t _Nonnull block) {
+static inline void SDSafeAsyncMainThread(dispatch_block_t _Nonnull block) {
     if (NSThread.isMainThread) {
         block();
     } else {
@@ -71,7 +58,7 @@ - (instancetype)initWithDispatchQueue:(dispatch_queue_t)queue {
 
 + (SDCallbackQueue *)mainQueue {
     SDCallbackQueue *queue = [[SDCallbackQueue alloc] initWithDispatchQueue:dispatch_get_main_queue()];
-    queue->_policy = SDCallbackPolicySafeAsyncMainQueue;
+    queue->_policy = SDCallbackPolicySafeAsyncMainThread;
     return queue;
 }
 
@@ -99,11 +86,8 @@ - (void)sync:(nonnull dispatch_block_t)block {
         case SDCallbackPolicyInvoke:
             block();
             break;
-        case SDCallbackPolicySafeAsyncMainQueue:
-            SDSafeMainQueueAsync(block);
-            break;
         case SDCallbackPolicySafeAsyncMainThread:
-            SDSafeMainThreadAsync(block);
+            SDSafeAsyncMainThread(block);
             break;
         default:
             NSCAssert(NO, @"unexpected policy %tu", self.policy);
@@ -122,11 +106,8 @@ - (void)async:(nonnull dispatch_block_t)block {
         case SDCallbackPolicyInvoke:
             block();
             break;
-        case SDCallbackPolicySafeAsyncMainQueue:
-            SDSafeMainQueueAsync(block);
-            break;
         case SDCallbackPolicySafeAsyncMainThread:
-            SDSafeMainThreadAsync(block);
+            SDSafeAsyncMainThread(block);
             break;
         default:
             NSCAssert(NO, @"unexpected policy %tu", self.policy);

Tests/Tests/SDUtilsTests.m

@@ -171,9 +171,12 @@ - (void)testSDCallbackQueue {
     dispatch_queue_t queue = dispatch_queue_create("testSDCallbackQueue", NULL);
     SDCallbackQueue *callbackQueue = [[SDCallbackQueue alloc] initWithDispatchQueue:queue];
     __block BOOL called = NO;
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     [callbackQueue sync:^{
         called = YES;
     }];
+#pragma clang diagnostic pop
     expect(called).beTruthy();
 
     __block BOOL called1 = NO;