feat(testing): use zones to avoid the need for injectAsync #5375

juliemr · 2015-11-19T02:48:37Z

Use a zone counting timeouts and microtasks to determine when a test
is finished, instead of requiring the test writer to use
injectAsync and return a promise.

See #5322

juliemr · 2015-11-19T02:51:04Z

cc @vicb @IgorMinar

Zones seem to work smoothly and remove complexity for the user for the async tests. All tests which use inject are now being run asynchronously, which as we discussed before adds a very small (couple ms) penalty time to each test. I like this overall - thoughts?

juliemr · 2015-11-19T02:52:28Z

Note that this isn't actually a breaking change, because both inject and injectAsync do the same thing now and the return value doesn't matter. A cleanup would remove injectAsync entirely.

0x-r4bbit · 2015-11-19T16:51:31Z

This is awesome Julie!

On Thu, Nov 19, 2015, 3:52 AM Julie Ralph [email protected] wrote:

Note that this isn't actually a breaking change, because both inject and
injectAsync do the same thing now and the return value doesn't matter. A
cleanup would remove injectAsync entirely.

—
Reply to this email directly or view it on GitHub
#5375 (comment).

vicb · 2015-11-19T18:25:42Z

modules/angular2/src/testing/testing.ts

+  var pendingMicrotasks = 0;
+  var pendingTimeouts = [];
+
+  var ngTestZone = (<NgZoneZone>global.zone)


<Zone>global.zone

Good catch, done.

vicb · 2015-11-19T18:52:29Z

modules/angular2/test/testing/testing_public_spec.ts

-                        ' returned value was: true');
-      restoreJasmineBeforeEach();
-    });
+    it('should fail when an asyncornous error is thrown', (done) => {


typo: asynchronous

vicb · 2015-11-19T18:53:41Z

A few minor comments, otherwise LGTM.
Great PR !

IgorMinar · 2015-11-19T22:22:59Z

@wardbell fyi - this will affect testing docs

IgorMinar · 2015-11-19T22:35:21Z

looks great! Please deprecate injectAsync and add docs about the async behavior for inject

IgorMinar · 2015-11-19T22:39:39Z

OMG, I just realized that this might mean that we don't need to refactor all of our tests in angular2/angular2 to return promises. Now I'm really stoked.

Do we properly detect errors and surface them or will we still see jasmine timeouts when an error occurs in an async test?

juliemr · 2015-11-19T22:42:47Z

Errors should be properly output: As in this test:

    it('should fail when an asynchronous error is thrown', (done) => {
      var itPromise = patchJasmineIt();

      it('throws an async error',
         inject([], () => { setTimeout(() => { throw new Error('bar'); }, 0); }));

      itPromise.then(() => { done.fail('Expected function to throw, but it did not'); }, (err) => {
        expect(err.message).toEqual('bar'); // <-- bar not just timeout!
        done();
      });
      restoreJasmineIt();
    });

wardbell · 2015-11-19T23:33:18Z

Big win! Looking forward to trying this.

juliemr · 2015-11-19T23:53:11Z

Deprecation notice and docs are done.

vsavkin · 2015-11-25T19:29:11Z

Could you rebase?

Use a zone counting timeouts and microtasks to determine when a test is finished, instead of requiring the test writer to use injectAsync and return a promise. See angular#5322

juliemr · 2015-11-25T19:33:27Z

@vsavkin done!

IgorMinar · 2015-11-25T22:07:00Z

let's get this in! :)

vsavkin · 2015-11-30T22:06:46Z

Merged via 0c9596a

Before angular#5375, injectAsync would check the return value and fail if it was not a promise, to help users remember that they need to return a promise from an async test. angular#5375 removed that with the introduction of the testing zone. This un-deprecates `injectAsync` until we can resolve angular#5515. To be clear, this means that `inject` and `injectAsync` are now identical except that `injectAsync` will fail if the test does not return a promise.

Before angular#5375, injectAsync would check the return value and fail if it was not a promise, to help users remember that they need to return a promise from an async test. angular#5375 removed that with the introduction of the testing zone. This un-deprecates `injectAsync` until we can resolve angular#5515. To be clear, this means that `inject` and `injectAsync` are now identical except that `injectAsync` will fail if the test does not return a promise, and `inject` will fail if the test returns any value.

Before #5375, injectAsync would check the return value and fail if it was not a promise, to help users remember that they need to return a promise from an async test. #5375 removed that with the introduction of the testing zone. This un-deprecates `injectAsync` until we can resolve #5515. To be clear, this means that `inject` and `injectAsync` are now identical except that `injectAsync` will fail if the test does not return a promise, and `inject` will fail if the test returns any value. Closes #5721

angular-automatic-lock-bot · 2019-09-07T14:22:25Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

googlebot added the cla: yes label Nov 19, 2015

juliemr added the area: testing Issues related to Angular testing features, such as TestBed label Nov 19, 2015

juliemr added the action: review The PR is still awaiting reviews from at least one requested reviewer label Nov 19, 2015

juliemr added this to the beta-00 milestone Nov 19, 2015

vicb reviewed Nov 19, 2015
View reviewed changes

juliemr mentioned this pull request Nov 19, 2015

Investigate using zones to avoid the need for injectAsync #5322

Closed

vicb reviewed Nov 19, 2015
View reviewed changes

juliemr force-pushed the zones-for-tests branch 2 times, most recently from 53f6396 to d3f814c Compare November 19, 2015 18:58

juliemr assigned IgorMinar Nov 19, 2015

IgorMinar added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews pr_state: LGTM and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Nov 19, 2015

IgorMinar assigned juliemr and unassigned IgorMinar Nov 19, 2015

juliemr force-pushed the zones-for-tests branch from d3f814c to 08be30d Compare November 19, 2015 23:52

juliemr added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Nov 19, 2015

juliemr mentioned this pull request Nov 24, 2015

Tests need a way to handle asynchronous behavior that happens through the template #5468

Closed

vsavkin added zomg_admin: do merge and removed zomg_admin: do merge labels Nov 25, 2015

vsavkin added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: merge The PR is ready for merge by the caretaker labels Nov 25, 2015

feat(testing): use zones to avoid the need for injectAsync

7d3de24

Use a zone counting timeouts and microtasks to determine when a test is finished, instead of requiring the test writer to use injectAsync and return a promise. See angular#5322

juliemr force-pushed the zones-for-tests branch from c49380d to 7d3de24 Compare November 25, 2015 19:33

juliemr removed the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Nov 25, 2015

juliemr assigned vsavkin and unassigned alxhub Nov 25, 2015

vsavkin added action: merge The PR is ready for merge by the caretaker zomg_admin: do merge and removed zomg_admin: do merge labels Nov 30, 2015

vsavkin closed this Nov 30, 2015

juliemr mentioned this pull request Nov 30, 2015

In tests, catch errors from rejected promises automatically #5515

Closed

juliemr mentioned this pull request Dec 9, 2015

refactor(testing): reenable injectAsync checking for return value #5721

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(testing): use zones to avoid the need for injectAsync #5375

feat(testing): use zones to avoid the need for injectAsync #5375

juliemr commented Nov 19, 2015

juliemr commented Nov 19, 2015

juliemr commented Nov 19, 2015

0x-r4bbit commented Nov 19, 2015

vicb Nov 19, 2015

juliemr Nov 19, 2015

vicb Nov 19, 2015

vicb commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

juliemr commented Nov 19, 2015

wardbell commented Nov 19, 2015

juliemr commented Nov 19, 2015

vsavkin commented Nov 25, 2015

juliemr commented Nov 25, 2015

IgorMinar commented Nov 25, 2015

vsavkin commented Nov 30, 2015

angular-automatic-lock-bot bot commented Sep 7, 2019

feat(testing): use zones to avoid the need for injectAsync #5375

feat(testing): use zones to avoid the need for injectAsync #5375

Conversation

juliemr commented Nov 19, 2015

juliemr commented Nov 19, 2015

juliemr commented Nov 19, 2015

0x-r4bbit commented Nov 19, 2015

vicb Nov 19, 2015

Choose a reason for hiding this comment

juliemr Nov 19, 2015

Choose a reason for hiding this comment

vicb Nov 19, 2015

Choose a reason for hiding this comment

vicb commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

IgorMinar commented Nov 19, 2015

juliemr commented Nov 19, 2015

wardbell commented Nov 19, 2015

juliemr commented Nov 19, 2015

vsavkin commented Nov 25, 2015

juliemr commented Nov 25, 2015

IgorMinar commented Nov 25, 2015

vsavkin commented Nov 30, 2015

angular-automatic-lock-bot bot commented Sep 7, 2019