Comparing Node.js Promises, Try/Catch, Angular Zone.js and Zone

45 points by alexgorbatchev 11 years ago | 20 comments
  • ulisesrmzroche 11 years ago
    Generators are the best, though I'm starting to worry I'm using them too much.

    edit: I'm using koa, so co is working in the background here. Should have said that earlier, my bad.

    var save = function*(){ try { yield db.insertUser(); } catch (e) { throw e; } }

    • eldude 11 years ago
      A major limitation of using try/catch is that V8 will DEOPT your function call, which can be a 5-10x performance hit (to the current closure). The best way to avoid this is with a silly hack:

          function trycatchit(fn, that, args) {
            try {
              return fn.apply(that, args)
            } catch(e) {
             return e
            }
          }
      
          var value = trycatchit(fn, null, 'someValue')
          if (value instanceof Error) {
            ...
          }
      
      Really though, you should just let co or whatever generator library you're using catch the error and rethrow it (or pass it to a callback) or be mindful to minimize your error handling.

      [1] https://github.com/CrabDude/trycatch/blob/master/lib/trycatc...

      • bajtos 11 years ago
        That's not entirely true. If "db.insertUser()" is opening a database connection, who is going to close it on error?

        The idea behind Zones for Node.js is to auto-attach new resources to the current zone, so that they can be cleaned when the zone exits.

        AFAIK there is no solution for that at the moment.

        • ulisesrmzroche 11 years ago
          I'm thinking whatever db plugin you're using, but also this pseudo code actually has a lot of implicit things going in the background (koa/co, thunks, etc).

          It makes for some readable app code though.

        • alexgorbatchev 11 years ago
          have you tried Co (https://github.com/visionmedia/co) and if so what's your experience?
        • spankalee 11 years ago
          One thing missing from this picture is Streams - the multivalued analog to Promises (Futures in Dart). The button click example would be quite easy to handle, even without Zones, if the button had an onClick event stream, rather than taking a callback.

          This code, which doesn't work as intended:

            function thirdPartyFunction() {
               function fakeXHR() {
                 throw new Error("Invalid dependencies");
               }
           
              setTimeout(fakeXHR, 100);
             }
           
            function main() {
               button.on("click", function onClick() {
                 thirdPartyFunction();
               });
             }
           
            main();
          
          would instead look like this with a Streams-based API (I'm assuming a Dart-like API, since I don't know the proposed Stream API for JS):

            function thirdPartyFunction() {
               function fakeXHR() {
                 throw new Error("Invalid dependencies");
               }
           
              setTimeout(fakeXHR, 100);
             }
           
            function main() {
               button.on("click")
                 .listen(function onClick() {
                   thirdPartyFunction();
                 })
                 .onError(function onError() {
                   console.log("now it works with errors");
                 })
             }
           
            main();
          
          Since onClick is executed by the Stream, even a synchronous exception in thirdPartyFunction will be caught and given to the onError callback. JavaScript could really use a better DOM API with Promises and Streams in place of most callbacks. I think most of the Streams work is here: https://github.com/whatwg/streams

          So Zones aren't really needed here. They are very useful though. AngularDart uses them to intercept any external trigger of the event loop so that it can run it's change detection code (this is why they ported Zones to JavaScript). Dart's unittest library runs each test in a Zone to wait for outstanding microtasks and catch async errors that might happen after a test appears to have completed and associate it with the correct test. And of course using Zones to string together async stack traces or debugging is invaluable.

          • olalonde 11 years ago
            The author does not seem like an experienced Node.js developer. All those

                if (err) {
                  done(err);
                }
                else {
                  // ...
                }
            
            are usually written in this style:

               if (err) return done(err);
               // ...
            
            I personally don't like promises and tend to avoid libraries who use them. I don't really see the problem they are trying to solve which is not already solvable in a more flexible way through libraries like async.
            • alexgorbatchev 11 years ago
              I agree that libraries should not be handling errors in any unusual way, or better yet just re/throw them and let consumer take care of that. That's where the promises/zones might be useful.
              • olalonde 11 years ago
                Right. I don't mind if people want to use promises in their own code as long as they don't force their use on library users.
            • inglor 11 years ago
              Cute, although if you promisify all your async primitives promises are throw safe and the Bluebird library makes this really easy.

              I hope they're able to get to as fast as Bluebird performance , which is almost as fast as callbacks and faster than the async module.

              • dharbin 11 years ago
                q.js can properly handle exceptions thrown in a handler. see the examples here: https://github.com/kriskowal/q#chaining
              • eldude 11 years ago
                > Up until recently that was pretty much all we had.

                [Edit: see my comment below[0]. This is more a coincidence of wording than a StrongLoop marketing line]

                When StrongLoop talked at my south bay node.js meetup group, BayNode[1], at Hacker Dojo last month, they demoed Zone.js. Before demoing though, they asked if anyone in the group had "solved this" to which I made it very clear that, "Yes, I did about 2 years ago with trycatch[2]." Their response could be summed up as, "Oh?"

                Long story short, not only does my async try/catch library solve this, I can say with near certainty that it solves it in a better, more consistent, more tested, more battle proven, more performant manner. We use trycatch at LinkedIn and have not had to worry about async error handling since.

                Additionally, adding it to any control-flow of your choice is trivial, as I have done with my stepup library[3]. Further, their main bullet-points are about enforcing the callback contract, something EVERY control-flow library should be doing, (I previously went into more detail here[4]) and the primary reason for the popularity of promises since they formalized this contract.

                In fact, I teach these core contract rules in my monthly week-long node.js bootcamp I give here at LinkedIn[5], and the only thing they have to do with control-flow is that your control-flow library of choice should enforce them, as stepup and promises do. I do add a few rules:

                * Function that takes 2 arguments: 1. first argument is an error, 2. second argument is the result, 3. Never pass both, 4. error should be instanceof Error

                * Must never excecute on the same tick of the event loop

                * Must be passed as last argument to function

                * Return value is ignored

                * Must not throw / must pass resulting errors

                * Must never be called more than once

                Long story short, domains are broken, try/catch is insufficient, use trycatch because I solved this problem over 2 years ago and have been perfecting it since.

                [0] https://news.ycombinator.com/item?id=7598983

                [1] http://www.meetup.com/BayNode/

                [2] https://github.com/CrabDude/trycatch

                [3] https://github.com/CrabDude/stepup

                [4] https://news.ycombinator.com/item?id=7020054

                [5] https://gist.github.com/CrabDude/10907185

                • spankalee 11 years ago
                  The article only covered error handling, but Zones are a lot more powerful than that. They are nestable (forkable), they can store arbitrary values, intercept microtasks, timers, wrap closures to be associated with the Zone, and a few more things.

                  Then the key part in Dart is that all of the APIs that invoke callbacks based on external events run the callbacks in the Zone they were registered in. This is what allows Zones to be used to easily run code at the beginning or end of every event loop turn.

                  • eldude 11 years ago
                    > They are nestable

                    trycatch is nestable as well.

                    > they can store arbitrary values, timers

                    Nice. I am currently decoupling trycatch's hooking layer to allow for this arbitrarily[1]. The continuation-local-storage library[2] allows for this functionality as well.

                    > intercept microtasks

                    Care to elaborate?

                    > wrap closures to be associated with the Zone

                    Yup, similar to domains, though I do wonder when this is necessary? One use case that came up with trycatch was finally support, or the need to exit the current domain/trycatch context.[3]

                    Lastly, there's one consistent failure I see in all these domain-like, async listener-like, long-stack-trace, event-source modules and that's long-lived resources or how they incorrectly handle EventEmitter handler's context[4], with the core issue being the boundary at which the hook is applied (From Trevor Norris' comment):

                        After thinking this over, it occurred to me that trycatch is a top down approach. Whereas AsyncListener is bottom up.
                    
                    Long story short, things like keep-alive sockets will retain a domain/context/zone(?) and their handlers will be called with the incorrect context.

                    Do you fix this in your zone.js implementation?

                    [1] https://github.com/CrabDude/trycatch/issues/38

                    [2] https://github.com/othiym23/node-continuation-local-storage

                    [3] https://github.com/CrabDude/trycatch/issues/37

                    [4] https://github.com/CrabDude/trycatch/issues/32

                    • spankalee 11 years ago
                      >> They are nestable > trycatch is nestable as well.

                      By nestable I mean that you can fork a Zone, configure different values and handlers (for things like intercepting microtasks and timers), and run some code in the forked Zone. All async callbacks spawned from that code will run in the forked Zone.

                      >> intercept microtasks > Care to elaborate?

                      Dart has an API for scheduling microtasks inside the event loop: scheduleMicrotask(callback). Zones can intercept this call to do things like keep track of the size of the queue and do something when it empties, or manually and synchronously execute the tasks for controlling time in tests.

                      >> wrap closures to be associated with the Zone > Yup, similar to domains, though I do wonder when this is necessary?

                      It's useful for interacting with external systems and preserving Zone affinity. This is how dart:html ensures that event subscription callbacks are run in the correct Zone, it wraps callbacks (only if necessary - if there's an installed Zone) in the Zone and then hands them to the browser. The wrapper installs the correct Zone before executing the callback.

                      > Long story short, things like keep-alive sockets will retain a domain/context/zone(?) and their handlers will be called with the incorrect context. > > Do you fix this in your zone.js implementation?

                      Zone.js is a port of Dart's Zone, so I don't know how faithfully it reproduces it. In Dart, I don't know of any API that doesn't execute callbacks in the correct Zone, except for a bug in dart:js that's being worked on.

                  • bilalq 11 years ago
                    This seems really cool! I'm surprised I haven't heard about this until now.

                    However, this solution seems to be Node specific. The example where they lament about how this "was pretty much all we had" was about a browser error. Angular's Zone.js seems to be the closest project to solving the problem in that context.

                    • alexgorbatchev 11 years ago
                      It's not StrongLoop marketing. I wrote the article and also haven't heard about your modules. I try to stay up to date with NPM (running http://npmawesome.com/) and unfortunately completely missed your work :(
                      • eldude 11 years ago
                        Ah, sorry then for my strong rebuke. I am making the incorrect assumption then that this was a StrongLoop marketing line, not a coincidental similarity.
                        • bilalq 11 years ago
                          You should write a blog post about this. There are a lot of parallel efforts going on to bring sanity to async errors in JS, and it would be great to see what the outcome of cross-pollinating these ideas would be.