Angular 6 Unit Tests: An error was thrown in afterAll\nReferenceError: Can't find variable: $ thrown
AngularKarma RunnerAngular6Angular Problem Overview
When running my unit tests, from time to time, even if they pass, at the end of all the tests running, I will get the following error.
On my Jenkins CI build running PhantomJS:
.PhantomJS 2.1.1 (Linux 0.0.0) ERROR
{
"message": "An error was thrown in afterAll\nReferenceError: Can't find variable: $ thrown",
"str": "An error was thrown in afterAll\nReferenceError: Can't find variable: $ thrown"
}
Or on Chrome:
Chrome 67.0.3396 (Windows 7 0.0.0) ERROR
{
"message": "An error was thrown in afterAll\n[object ErrorEvent] thrown",
"str": "An error was thrown in afterAll\n[object ErrorEvent] thrown"
}
I also have really unreliable tests, without changing anything some times they would succeed and other times the same tests would fail, so I knew something weird was going on.
Angular Solutions
Solution 1 - Angular
My issue was that I had a race condition in my tests due to a very stupid way of setting up my tests, but I wanted to document it here anyways because I struggled to find the answer to my issue on the internet.
What I had somehow done was to declare two beforeEach
functions to setup my test, and one of the two was asynchronous, so I had a race condition where sometimes they ran out of order and failed.
Here is how my test looked:
beforeEach(async(() => {
TestBed.configureTestingModule({
declarations: [ HomeComponent ]
})
.compileComponents();
}));
beforeEach(() => {
fixture = TestBed.createComponent(HomeComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
So to resolve this I put all the setup into one, synchronous beforeEach.
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [HomeComponent]
}).compileComponents();
fixture = TestBed.createComponent(HomeComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
I wasted too much time trying to figure this out, so I'm putting it here to save someone else.
Solution 2 - Angular
I had a similar problem, it seems that since Angular v6 & Karma v3 this vague afterAll
error has started to appear (https://github.com/jasmine/jasmine/issues/1523).
For myself this error doesn't fail the test but fails the suite.
After looking at many answers to this problem, it seems that the cause is nearly always different which makes it hard to find help online. One can hope that a patch update will be added at some point to bubble up a better error.
My Error
[INFO] HeadlessChrome 71.0.3542 (Linux 0.0.0) DialogComponent #apply should save. FAILED
[INFO] Uncaught TypeError: Cannot read property 'nativeElement' of undefined thrown
[INFO] [31m✗ [39m[31mshould save.[39m
[INFO] Uncaught TypeError: Cannot read property 'nativeElement' of undefined thrown
[INFO]
[INFO] HeadlessChrome 71.0.3542 (Linux 0.0.0) DialogComponent #apply should save. FAILED
[INFO] Uncaught TypeError: Cannot read property 'nativeElement' of undefined thrown
[INFO] HeadlessChrome 71.0.3542 (Linux 0.0.0) DialogComponent #apply should save. FAILED
[INFO] Uncaught TypeError: Cannot read property 'nativeElement' of undefined thrown
[INFO] HeadlessChrome 71.0.3542 (Linux 0.0.0) ERROR
[INFO] {
[INFO] "message": "An error was thrown in afterAll\nUncaught TypeError: Cannot read property 'nativeElement' of undefined thrown\nUncaught TypeError: Cannot read property 'nativeElement' of undefined thrown",
[INFO] "str": "An error was thrown in afterAll\nUncaught TypeError: Cannot read property 'nativeElement' of undefined thrown\nUncaught TypeError: Cannot read property 'nativeElement' of undefined thrown"
[INFO] }
Finding the problematic test
I got this afterAll
error message and had no idea what was causing it, or what test triggered it.
The first thing I did was install the karma-spec-reporter
:
npm install karma-spec-reporter --save-dev
Add this to the plugins array in the karma.conf.js
file:
require('karma-spec-reporter')
This gives you the spec reporter, and add spec
into the reporters array: reporters: ['spec'],
Next time you run the test you will see the afterAll
error in the console after the problematic test.
My Issue / Solution
I found that the test was calling htmlElement.click()
.
I changed this to: htmlElement.dispatchEvent(new Event('click))
And voila the tests started to pass.
Summary
As a general rule I avoid using .click()
on HTMLElement's now.
Also when users interact with the UI it's done via events, so it mimics the users actions more correctly which is always a good thing when testing.
Solution 3 - Angular
Another thing which has helped me as well and solved a few of my problems was to add the statement to destroy the fixture after each test
afterEach(() => {
fixture.destroy();
});
Solution 4 - Angular
We were facing similar issues, both with the same intermittent error and the intermittent failing tests. This came up when, after upgrading to Angular 6 we also upgraded to Jasmine 3 wherein running tests in random order is now the default.
As noted by @marsraits below, that such a change was the source of these errors means that our tests were improperly sharing dependencies, and thus the true source of the error is in our own code. That being said, rather than rewriting numerous legacy tests, by turning random off for the test runner we were able to quickly resolve the issue.
We did this by adding this setting in the karma.conf.js:
config.set({
client: {
jasmine: {
random: false
}
}
})
Solution 5 - Angular
When this error happens, check the browser opened by karma and check its console for errors.
Typically there will be a stack trace there which will help you fix the issue. This also applies for other errors thrown by karma which are not informative.
Solution 6 - Angular
My specific issue with this error was caused by not mocking sub-components of the component I was testing. In this case I had a homepage component with two sub components, which required declarations for the sub components, which I failed to mock.
As a result the sub components had real dependencies which would intermittently cause the tests to fail in this non-obvious manner (it looks like different tests are randomly failing, but it is not the case).
Mocking as follows works pretty well in this case:
@Component({
selector: 'app-exercise',
template: '<p>Mock Exercise Component</p>'
})
class MockExerciseComponent {
}
@Component({
selector: 'app-user',
template: '<p>Mock User Component</p>'
})
class MockUserComponent {
}
describe('HomepageComponent', () => {
let component: HomepageComponent;
let fixture: ComponentFixture<HomepageComponent>;
beforeEach(async(() => {
TestBed.configureTestingModule({
// note you need to mock sub components!
declarations: [HomepageComponent, MockExerciseComponent, MockUserComponent],
Solution 7 - Angular
I'm extremely grateful to Oisin, as his answer pointed me into the right direction. Please consider this answer as a complement to his.
There are, however, two aspects which, IMHO, need clarification:
-
We're not dealing with a race condition.
A race condition would mean the two instances ofbeforeEach
run in parallel and we cannot determine which one finishes first. In reality, the non-asyncbeforeEach
runs first and theasync
one runs second.
Every single time.
When you have twobeforeEach
s and one of them isasync
(including the ones using the shinywaitForAsync
wrapper provided by@angular/core/testing
), the async instance's execution gets pushed at the end of the execution queue. -
I also find Oisin's proposed solution:
> [...] put all the setup into one, synchronous beforeEach.
... too limiting. It doesn't have to be synchronous. It can be asynchronous without a problem.
The important bit is that, TestBed.createComponent()
should run after TestBed.configureTestingModule()
has resolved.
That's all there is to it.
To make it crystal clear, this random example:
import { TestBed, waitForAsync } from '@angular/core/testing';
// more imports...
describe('SomeComponent', () => {
beforeEach(waitForAsync(() => {
TestBed.configureTestingModule({
declarations: [SomeComponent],
imports: [SharedModule, RouterTestingModule, HttpClientTestingModule],
providers: [{
provide: SomeService, useValue: {
someObservableMethod$: () => of()
} as Partial<SomeService>
}]
})
.overrideModule(MatIconModule, MatIconModuleMock)
.compileComponents();
}));
beforeEach(() => {
fixture = TestBed.createComponent(SomeComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
/* tests here */
});
... should be turned into:
import { TestBed, waitForAsync } from '@angular/core/testing';
// more imports...
describe('SomeComponent', () => {
beforeEach(waitForAsync(() => {
TestBed.configureTestingModule({
declarations: [SomeComponent],
imports: [SharedModule, RouterTestingModule, HttpClientTestingModule],
providers: [{
provide: SomeService, useValue: {
someObservableMethod$: () => of()
} as Partial<SomeService>
}]
})
.overrideModule(MatIconModule, MatIconModuleMock)
.compileComponents();
fixture = TestBed.createComponent(SomeComponent);
component = fixture.componentInstance;
fixture.detectChanges();
}));
/* tests here */
});
The code in the second (synchronous) beforeEach
was appended to the first (asynchronous) beforeEach
. That's it.
Solution 8 - Angular
I've just had faced this problem. My problem was related to HttpClient. I was mocking a httpClient to return error 503 and I was not creating the error function on the subscribe:
httpClient.get('/api').subscribe(() => {
fail('Should not return success');
}, (data) => {
expect(data.status).toEqual(503); // without adding this callback here, you will get the error of this question
});
const request = mock.expectOne('/api');
request.flush({data: 'test'}, { status: 503, statusText: 'Internal Error'});
Solution 9 - Angular
I had similar issue as well. In my angular 10 project. Out of 10 times, 8 times it would fail with afterall error. Turns out, in spec.ts files, the imports should have HttpClientTestingModule instead of HttpClientModule. Try this. It might solve the random error in Afterall issue.
Solution 10 - Angular
In my case
I am using karma-parallel
and when I updated the executors number it worked (don't know why)
parallelOptions: {
executors: 4, // Earlier it was 5 I have updated it to 4 and it worked
shardStrategy: 'round-robin',
......
}
Solution 11 - Angular
One possible problem is that one of your components runs a third-party script that makes a CORS request that fails. (My problem was solved by https://github.com/karma-runner/karma/issues/1268#issuecomment-70422477) This can make tests appear to work on Chrome and fail intermittently on your CI.
When in doubt, follow the advice of Rui (https://stackoverflow.com/a/56662721/3370010) and open up your console, even if all the tests are passing.
Solution 12 - Angular
In my case, using jasmine, the problem was that I throw an error in tested function. So this thrown error appears in afterAll.
this.userService.getUsers().subscribe(
(data: User[]) => {
if (data?.length === 0) {
...
} else if (data?.length !== 0) {
...
} else {
throw new Error('Not valid response'); // This cause the error in afterAll if tested
}
}
);
Solution 13 - Angular
In my case, the problem seems to be the lack of "catch".
Instead of just :
this.service.getUsers().subscribe( r => { doSomething... } );
I have to do :
this.service.getUsers().subscribe( r => { doSomething... }, err => { doSomething... } );
Solution 14 - Angular
In my case: the problem seems to be the lack of "catch". Instead of just :
this.service.method().subscribe( r => { doSomething... } );
I have to do :
this.service.method().subscribe( r => { doSomething... }, err => { doSomething... } );