-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix unit tests #13
base: master
Are you sure you want to change the base?
Fix unit tests #13
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
module.exports = function(config) { | ||
config.set({ | ||
frameworks: ['mocha', 'chai', 'sinon'], | ||
preprocessors: { | ||
'src/appmetrics.js': ['babel'], | ||
'test/**/*.js': ['babel'] | ||
}, | ||
files: ['src/appmetrics.js', 'test/**/*.js'], | ||
reporters: ['progress'], | ||
port: 9876, // karma web server port | ||
colors: true, | ||
logLevel: config.LOG_INFO, | ||
browsers: ['ChromeHeadless'], | ||
autoWatch: false, | ||
singleRun: true, // Karma captures browsers, runs the tests and exits | ||
concurrency: Infinity | ||
}); | ||
}; |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,7 +40,9 @@ describe('appmetrics.js', function() { | |
|
||
describe('init', function() { | ||
it('constructor fails without name', function() { | ||
assert.throws(function test() { return new Metric(); }); | ||
assert.throws(function test() { | ||
return new Metric(); | ||
}); | ||
}); | ||
it('name is correct', function() { | ||
assert.equal(metric.name, 'test_metric'); | ||
|
@@ -127,80 +129,34 @@ describe('appmetrics.js', function() { | |
}); | ||
|
||
describe('sendToAnalytics()', function() { | ||
it('sends default request', function(done) { | ||
const observer = new PerformanceObserver(list => { | ||
observer.disconnect(); | ||
|
||
const entries = list.getEntries().filter(entry => { | ||
return isAnalyticsRequest(entry) && | ||
entry.name.includes(Math.round(metric.duration)) && | ||
entry.name.includes(metric.name) && | ||
entry.name.includes('category_name'); | ||
}); | ||
|
||
assert.equal(entries.length, 1, 'single timing entry'); | ||
done(); | ||
}); | ||
observer.observe({entryTypes: ['resource']}); | ||
|
||
let spy; | ||
beforeEach(() => { | ||
spy = sinon.spy(window, 'ga'); | ||
}); | ||
afterEach(() => { | ||
spy.restore(); | ||
}); | ||
it('sends default request', function() { | ||
metric.sendToAnalytics('category_name'); | ||
assert(spy.calledWith('send', 'timing', 'category_name', metric.name, Math.round(metric.duration))); | ||
}); | ||
|
||
it('can override duration and name', function(done) { | ||
const observer = new PerformanceObserver(list => { | ||
observer.disconnect(); | ||
|
||
const entries = list.getEntries().filter(entry => { | ||
return isAnalyticsRequest(entry) && | ||
entry.name.includes('1234567890') && | ||
entry.name.includes('category_name') && | ||
entry.name.includes('metric_name'); | ||
}); | ||
|
||
assert.equal(entries.length, 1, 'one timing entry'); | ||
done(); | ||
}); | ||
observer.observe({entryTypes: ['resource']}); | ||
|
||
it('can override duration and name', function() { | ||
metric.sendToAnalytics('category_name', 'metric_name', 1234567890); | ||
assert(spy.calledWith('send', 'timing', 'category_name', 'metric_name', 1234567890)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are testing that the GA api call is made, not that the entries are properly recorded in the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tried leaving it as it was. However, when I first ran the tests they always failed. They were sending the wrong payload, metric.name was always The tests were previously more like integration tests and covered part of the internals of GA, which I'm not really sure is necessary. Since GA is a 'soft' peer dependency, as long as GA behaves then we shouldn't care except that we call the interface correctly. |
||
}); | ||
|
||
it('can send a duration without measuring', function(done) { | ||
it('can send a duration without measuring', function() { | ||
const duration = Date.now(); | ||
|
||
const observer = new PerformanceObserver(list => { | ||
observer.disconnect(); | ||
|
||
const entries = list.getEntries().filter(entry => { | ||
return isAnalyticsRequest(entry) && | ||
entry.name.includes(duration) && | ||
entry.name.includes('category_name') && | ||
entry.name.includes('override_duration'); | ||
}); | ||
|
||
assert.equal(entries.length, 1, 'one timing entry'); | ||
done(); | ||
}); | ||
observer.observe({entryTypes: ['resource']}); | ||
|
||
const metric = new Metric('override_duration'); | ||
metric.sendToAnalytics('category_name', metric.name, duration); | ||
assert(spy.calledWith('send', 'timing', 'category_name', metric.name, duration)); | ||
}); | ||
|
||
it('no requests are to GA before a measurement', function(done) { | ||
// If the perf observer sees a request, the test should fail. | ||
const observer = new PerformanceObserver(list => { | ||
observer.disconnect(); | ||
assert.fail( | ||
false, true, 'Google Analytics request was sent before a measurement was made.'); | ||
done(); | ||
}); | ||
observer.observe({entryTypes: ['resource']}); | ||
|
||
it('no requests are to GA before a measurement', function() { | ||
const metric = new Metric('test_metric'); | ||
metric.sendToAnalytics('should_not_be_sent'); | ||
|
||
setTimeout(done, 500); | ||
assert(spy.notCalled); | ||
}); | ||
}); | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these should be
devDependencies
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to get rid of "chai" and "mocha" deps? Do the "karma-*" deps cover those?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just tested it, we can get rid of mocha. But chai and sinon are not covered by karma-*