Async Improvement to check if it's completed from external code

Async Improvement to check if it's completed from external code

Hi, I'd like to propose a change to the QUnit async function that I found useful.  Specifically testing if another async function has not completed this could be a cause for issues.  Therefore this change proposes a way to check for this by attaching a state variable to the returning function:

  1. // Increment this Test's semaphore counter, then return a single-use function that
  2. // decrements that counter a maximum of once.
  3. async: function() {
  4. var test = this.test,
  5. popped = false;

  7. test.semaphore += 1;
  8. test.usedAsync = true;
  9. pauseProcessing();
  10.         
  11.        //the point of this change is to check if an async has been triggered from
  12.                //within a unit test; if we find it isn't we can raise an assert failure
  13.        //create our state object within scope; note this needs a wrapper arround the
  14.        //complete; i tried to do without it but couldn't figure it out
  15.                //this might be a better solution anyways
  16. var state = {
  17.     complete: false,
  18.                     calltime: null,
  19. };

  21.                 //the orriginal QUnit function; modified
  22. fn = function () {
  23.     state.complete = true; //added; note the scope
  24.     state.calltime = new Date();

  26.     if (!popped) {
  27.         test.semaphore -= 1;
  28.         popped = true;
  29.         resumeProcessing();
  30.     } else {
  31.         test.pushFailure("Called the callback returned from `assert.async` more than once",
  32.                     sourceFromStacktrace(2));
  33.     }
  34. };

  36.                 //assign our scope variable as a propery as well so it's externally accessable
  37. fn.state = state;

  39. return fn;

  41.     /**
  42.         orriginal

  44. return function done() {
  45. if ( !popped ) {
  46. test.semaphore -= 1;
  47. popped = true;
  48. resumeProcessing();
  49. } else {
  50. test.pushFailure( "Called the callback returned from `assert.async` more than once",
  51. sourceFromStacktrace( 2 ) );
  52. }
  53. };*/
  54. },

Then you can use it:

  1. var asyncTest1 = assert.async();

  3. /////// some code /////

  5. if (!asyncTest1.status.complete) {
  6.      assert.ok(false, "async test1 did not complete before this point");
  7. }