Handling async callbacks in a for-in loop with DispatchGroup only works when all loops succeed





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







1















The code below is a rough sketch of the task. A database is queried, it returns a collection of results, that collection is looped in search of a specific property, if that property is found, a file storage is immediately queried and its async completion handler returns the file in the loop. Because I am handling async callbacks inside a for-in loop, I use a DispatchGroup to manage that. This setup works only if all of the documents in the collection have the someIdentifier property. If one document in the collection does not have the property, the dispatch group never calls notify() and we are stuck in limbo.



someDatabaseQuery.retrieveSomeData { (data, error) in

guard let data = data, error == nil else {
return
}

// database has retrieved data, create dispatch group
let dispatchGroup = DispatchGroup()

for document in data { // loop through collection

// check if document has some identifier
guard let someIdentifier = document["someIdentifier"] as? String else {
return
}

dispatchGroup.enter() // identifier found, enter dispatch

// perform async operation inside loop
Filestorage.getSomeFile(forURL: someIdentifier) { (data, error) in

guard let file = data, error == nil else {
return
}

// download the file
dispatchGroup.leave() // leave dispatch

}

}

dispatchGroup.notify(queue: .main) {

// all data grabbed, load table

}

}









share|improve this question































    1















    The code below is a rough sketch of the task. A database is queried, it returns a collection of results, that collection is looped in search of a specific property, if that property is found, a file storage is immediately queried and its async completion handler returns the file in the loop. Because I am handling async callbacks inside a for-in loop, I use a DispatchGroup to manage that. This setup works only if all of the documents in the collection have the someIdentifier property. If one document in the collection does not have the property, the dispatch group never calls notify() and we are stuck in limbo.



    someDatabaseQuery.retrieveSomeData { (data, error) in

    guard let data = data, error == nil else {
    return
    }

    // database has retrieved data, create dispatch group
    let dispatchGroup = DispatchGroup()

    for document in data { // loop through collection

    // check if document has some identifier
    guard let someIdentifier = document["someIdentifier"] as? String else {
    return
    }

    dispatchGroup.enter() // identifier found, enter dispatch

    // perform async operation inside loop
    Filestorage.getSomeFile(forURL: someIdentifier) { (data, error) in

    guard let file = data, error == nil else {
    return
    }

    // download the file
    dispatchGroup.leave() // leave dispatch

    }

    }

    dispatchGroup.notify(queue: .main) {

    // all data grabbed, load table

    }

    }









    share|improve this question



























      1












      1








      1








      The code below is a rough sketch of the task. A database is queried, it returns a collection of results, that collection is looped in search of a specific property, if that property is found, a file storage is immediately queried and its async completion handler returns the file in the loop. Because I am handling async callbacks inside a for-in loop, I use a DispatchGroup to manage that. This setup works only if all of the documents in the collection have the someIdentifier property. If one document in the collection does not have the property, the dispatch group never calls notify() and we are stuck in limbo.



      someDatabaseQuery.retrieveSomeData { (data, error) in

      guard let data = data, error == nil else {
      return
      }

      // database has retrieved data, create dispatch group
      let dispatchGroup = DispatchGroup()

      for document in data { // loop through collection

      // check if document has some identifier
      guard let someIdentifier = document["someIdentifier"] as? String else {
      return
      }

      dispatchGroup.enter() // identifier found, enter dispatch

      // perform async operation inside loop
      Filestorage.getSomeFile(forURL: someIdentifier) { (data, error) in

      guard let file = data, error == nil else {
      return
      }

      // download the file
      dispatchGroup.leave() // leave dispatch

      }

      }

      dispatchGroup.notify(queue: .main) {

      // all data grabbed, load table

      }

      }









      share|improve this question
















      The code below is a rough sketch of the task. A database is queried, it returns a collection of results, that collection is looped in search of a specific property, if that property is found, a file storage is immediately queried and its async completion handler returns the file in the loop. Because I am handling async callbacks inside a for-in loop, I use a DispatchGroup to manage that. This setup works only if all of the documents in the collection have the someIdentifier property. If one document in the collection does not have the property, the dispatch group never calls notify() and we are stuck in limbo.



      someDatabaseQuery.retrieveSomeData { (data, error) in

      guard let data = data, error == nil else {
      return
      }

      // database has retrieved data, create dispatch group
      let dispatchGroup = DispatchGroup()

      for document in data { // loop through collection

      // check if document has some identifier
      guard let someIdentifier = document["someIdentifier"] as? String else {
      return
      }

      dispatchGroup.enter() // identifier found, enter dispatch

      // perform async operation inside loop
      Filestorage.getSomeFile(forURL: someIdentifier) { (data, error) in

      guard let file = data, error == nil else {
      return
      }

      // download the file
      dispatchGroup.leave() // leave dispatch

      }

      }

      dispatchGroup.notify(queue: .main) {

      // all data grabbed, load table

      }

      }






      swift grand-central-dispatch






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 22 '18 at 6:21







      bsod

















      asked Nov 22 '18 at 2:55









      bsodbsod

      2,65721124




      2,65721124
























          2 Answers
          2






          active

          oldest

          votes


















          3














          You must call leave if you call enter. But the guard inside the getSomeFile completion block can prevent the call to leave being made even though you called enter.



          One solution is to use defer inside the completion block. Call leave inside the defer to ensure it is called no matter how you leave the block.






          share|improve this answer































            0














            guard let someIdentifier = document["someIdentifier"] as? String else {
            continue // this is the proper control flow statement
            }


            The problem was simply choosing the wrong control flow statement. When the guard failed inside the loop, return prevented the loop from finishing and never gave dispatch group a chance to notify. The else-clause in the guard should have been continue, which keeps control inside the loop (by letting it finish) and thus gives the dispatch group a chance to notify.






            share|improve this answer


























            • Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

              – Ann Catherine Jose
              Nov 25 '18 at 4:38








            • 1





              You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

              – bsod
              Nov 25 '18 at 12:33












            Your Answer






            StackExchange.ifUsing("editor", function () {
            StackExchange.using("externalEditor", function () {
            StackExchange.using("snippets", function () {
            StackExchange.snippets.init();
            });
            });
            }, "code-snippets");

            StackExchange.ready(function() {
            var channelOptions = {
            tags: "".split(" "),
            id: "1"
            };
            initTagRenderer("".split(" "), "".split(" "), channelOptions);

            StackExchange.using("externalEditor", function() {
            // Have to fire editor after snippets, if snippets enabled
            if (StackExchange.settings.snippets.snippetsEnabled) {
            StackExchange.using("snippets", function() {
            createEditor();
            });
            }
            else {
            createEditor();
            }
            });

            function createEditor() {
            StackExchange.prepareEditor({
            heartbeatType: 'answer',
            autoActivateHeartbeat: false,
            convertImagesToLinks: true,
            noModals: true,
            showLowRepImageUploadWarning: true,
            reputationToPostImages: 10,
            bindNavPrevention: true,
            postfix: "",
            imageUploader: {
            brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
            contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
            allowUrls: true
            },
            onDemand: true,
            discardSelector: ".discard-answer"
            ,immediatelyShowMarkdownHelp:true
            });


            }
            });














            draft saved

            draft discarded


















            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53423240%2fhandling-async-callbacks-in-a-for-in-loop-with-dispatchgroup-only-works-when-all%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown

























            2 Answers
            2






            active

            oldest

            votes








            2 Answers
            2






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes









            3














            You must call leave if you call enter. But the guard inside the getSomeFile completion block can prevent the call to leave being made even though you called enter.



            One solution is to use defer inside the completion block. Call leave inside the defer to ensure it is called no matter how you leave the block.






            share|improve this answer




























              3














              You must call leave if you call enter. But the guard inside the getSomeFile completion block can prevent the call to leave being made even though you called enter.



              One solution is to use defer inside the completion block. Call leave inside the defer to ensure it is called no matter how you leave the block.






              share|improve this answer


























                3












                3








                3







                You must call leave if you call enter. But the guard inside the getSomeFile completion block can prevent the call to leave being made even though you called enter.



                One solution is to use defer inside the completion block. Call leave inside the defer to ensure it is called no matter how you leave the block.






                share|improve this answer













                You must call leave if you call enter. But the guard inside the getSomeFile completion block can prevent the call to leave being made even though you called enter.



                One solution is to use defer inside the completion block. Call leave inside the defer to ensure it is called no matter how you leave the block.







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 22 '18 at 3:46









                rmaddyrmaddy

                246k27328391




                246k27328391

























                    0














                    guard let someIdentifier = document["someIdentifier"] as? String else {
                    continue // this is the proper control flow statement
                    }


                    The problem was simply choosing the wrong control flow statement. When the guard failed inside the loop, return prevented the loop from finishing and never gave dispatch group a chance to notify. The else-clause in the guard should have been continue, which keeps control inside the loop (by letting it finish) and thus gives the dispatch group a chance to notify.






                    share|improve this answer


























                    • Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                      – Ann Catherine Jose
                      Nov 25 '18 at 4:38








                    • 1





                      You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                      – bsod
                      Nov 25 '18 at 12:33
















                    0














                    guard let someIdentifier = document["someIdentifier"] as? String else {
                    continue // this is the proper control flow statement
                    }


                    The problem was simply choosing the wrong control flow statement. When the guard failed inside the loop, return prevented the loop from finishing and never gave dispatch group a chance to notify. The else-clause in the guard should have been continue, which keeps control inside the loop (by letting it finish) and thus gives the dispatch group a chance to notify.






                    share|improve this answer


























                    • Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                      – Ann Catherine Jose
                      Nov 25 '18 at 4:38








                    • 1





                      You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                      – bsod
                      Nov 25 '18 at 12:33














                    0












                    0








                    0







                    guard let someIdentifier = document["someIdentifier"] as? String else {
                    continue // this is the proper control flow statement
                    }


                    The problem was simply choosing the wrong control flow statement. When the guard failed inside the loop, return prevented the loop from finishing and never gave dispatch group a chance to notify. The else-clause in the guard should have been continue, which keeps control inside the loop (by letting it finish) and thus gives the dispatch group a chance to notify.






                    share|improve this answer















                    guard let someIdentifier = document["someIdentifier"] as? String else {
                    continue // this is the proper control flow statement
                    }


                    The problem was simply choosing the wrong control flow statement. When the guard failed inside the loop, return prevented the loop from finishing and never gave dispatch group a chance to notify. The else-clause in the guard should have been continue, which keeps control inside the loop (by letting it finish) and thus gives the dispatch group a chance to notify.







                    share|improve this answer














                    share|improve this answer



                    share|improve this answer








                    edited Nov 25 '18 at 3:59









                    Samuel Liew

                    45.5k33118157




                    45.5k33118157










                    answered Nov 22 '18 at 6:18









                    bsodbsod

                    2,65721124




                    2,65721124













                    • Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                      – Ann Catherine Jose
                      Nov 25 '18 at 4:38








                    • 1





                      You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                      – bsod
                      Nov 25 '18 at 12:33



















                    • Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                      – Ann Catherine Jose
                      Nov 25 '18 at 4:38








                    • 1





                      You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                      – bsod
                      Nov 25 '18 at 12:33

















                    Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                    – Ann Catherine Jose
                    Nov 25 '18 at 4:38







                    Good that you found the root cause. Btw, wouldn't you have to leave the DispatchGroup for the second guard as well? If not, when there is an error in retrieving the file, the group won't be notified. <!-- language: swift --> guard let file = data, error == nil else { dispatchGroup.leave() // this has to be added? return }

                    – Ann Catherine Jose
                    Nov 25 '18 at 4:38






                    1




                    1





                    You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                    – bsod
                    Nov 25 '18 at 12:33





                    You are right and in the final version I implemented the defer method as mentioned by someone else to catch returns for any reason, including that guard. But somebody edited that part of my answer out.

                    – bsod
                    Nov 25 '18 at 12:33


















                    draft saved

                    draft discarded




















































                    Thanks for contributing an answer to Stack Overflow!


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid



                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.


                    To learn more, see our tips on writing great answers.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function () {
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53423240%2fhandling-async-callbacks-in-a-for-in-loop-with-dispatchgroup-only-works-when-all%23new-answer', 'question_page');
                    }
                    );

                    Post as a guest















                    Required, but never shown





















































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown

































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown







                    Popular posts from this blog

                    Guess what letter conforming each word

                    Port of Spain

                    Run scheduled task as local user group (not BUILTIN)