fix(browser): allow updating total specs count #3264

matz3 · 2019-02-13T12:59:14Z

This change allows providing the total specs count after the tests have
been started.
The count will be updated in case it has been provided already.
This can be uselful for some adapters where the total specs count can
not be determined before starting the first test.

Regarding tests
I wanted to update the tests and/or create a test case but the onInfo tests are not clear to me:

'browser_dump' doesn't seem to be a valid event
I'm not sure whether the behavior of the tests is really expected or just works by chance.

So I would be happy to get feedback from you before writing a test case.

karma/test/unit/browser.spec.js

Lines 102 to 137 in c277a6b

    
           describe('onInfo', () => { 
        
             beforeEach(() => { 
        
               browser = new Browser('fake-id', 'full name', collection, emitter, socket) 
        
             }) 
        
             it('should emit "browser_log"', () => { 
        
               const spy = sinon.spy() 
        
               emitter.on('browser_log', spy) 
        
               browser.state = Browser.STATE_EXECUTING 
        
               browser.onInfo({log: 'something', type: 'info'}) 
        
               expect(spy).to.have.been.calledWith(browser, 'something', 'info') 
        
             }) 
        
             it('should emit "browser_info"', () => { 
        
               const spy = sinon.spy() 
        
               const infoData = {} 
        
               emitter.on('browser_info', spy) 
        
               browser.state = Browser.STATE_EXECUTING 
        
               browser.onInfo(infoData) 
        
               expect(spy).to.have.been.calledWith(browser, infoData) 
        
             }) 
        
             it('should ignore if browser not executing', () => { 
        
               const spy = sinon.spy() 
        
               emitter.on('browser_dump', spy) 
        
               browser.state = Browser.STATE_CONNECTED 
        
               browser.onInfo({dump: 'something'}) 
        
               browser.onInfo({total: 20}) 
        
               expect(browser.lastResult.total).to.equal(0) 
        
               expect(spy).not.to.have.been.called 
        
             }) 
        
           })

This change allows providing the total specs count after the tests have been started. The count will be updated in case it has been provided already. This can be uselful for some adapters where the total specs count can not be determined before starting the first test.

johnjbarton · 2019-02-13T16:02:25Z

'browser_dump' doesn't seem to be a valid event

I guess the test is attempting to cover:
https://github.com/karma-runner/karma/blob/master/lib/browser.js#L63

However it tests something "not happening" and many things do not happen when code is changed. Maybe the event was originally browser_dump and was renamed, but the test was not corrected. Please correct it if you can.

johnjbarton · 2019-02-13T16:09:13Z

lib/browser.js

    if (helper.isDefined(info.log)) {
      this.emitter.emit('browser_log', this, info.log, info.type)
+    } else if (helper.isDefined(info.total)) {
+      this.lastResult.total = info.total


If you guard the update to results with state EXECUTING then the tests will pass. You can add a similar test with mock state EXECUTING to verify the change.

In order to fix the test should ignore if browser not executing I would suggest to wrap all those if-clauses with a check for state EXECUTING.
Should this.refreshNoActivityTimeout() be still called then?

I think we should log events in any state, they could be error messages for corner cases. So remove the line in the test that checks the .dump path.

The this.refreshNoActivityTimeout() should always be called, it signals that the browser is still on the line.

Makes sense. I've pushed my changes.

johnjbarton · 2019-02-13T21:52:06Z

Thanks!

matz3 · 2019-02-14T08:11:20Z

Thanks for the quick handling 👍

johnjbarton suggested changes Feb 13, 2019

View reviewed changes

matz3 added 2 commits February 13, 2019 18:27

fix(browser): only update total count when executing

217a7de

test(browser): fix onInfo test case, add new test for total update

18eec87

johnjbarton approved these changes Feb 13, 2019

View reviewed changes

johnjbarton merged commit d5df723 into karma-runner:master Feb 13, 2019

matz3 deleted the fix-update-total-spec-count branch February 14, 2019 08:11

karronoli mentioned this pull request Aug 16, 2022

Bump karma from ~1.2.0 to ~6.4 in /redpen-server karronoli/redpen#10

Merged

Omrisnyk mentioned this pull request Oct 29, 2024

[Snyk] Fix for 2 vulnerabilities Omrisnyk/npm-lockfiles#201

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(browser): allow updating total specs count #3264

fix(browser): allow updating total specs count #3264

Uh oh!

matz3 commented Feb 13, 2019 •

edited

Loading

Uh oh!

johnjbarton commented Feb 13, 2019

Uh oh!

johnjbarton Feb 13, 2019

Uh oh!

matz3 Feb 13, 2019

Uh oh!

johnjbarton Feb 13, 2019

Uh oh!

matz3 Feb 13, 2019

Uh oh!

johnjbarton commented Feb 13, 2019

Uh oh!

matz3 commented Feb 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	describe('onInfo', () => {
	beforeEach(() => {
	browser = new Browser('fake-id', 'full name', collection, emitter, socket)
	})

	it('should emit "browser_log"', () => {
	const spy = sinon.spy()
	emitter.on('browser_log', spy)

	browser.state = Browser.STATE_EXECUTING
	browser.onInfo({log: 'something', type: 'info'})
	expect(spy).to.have.been.calledWith(browser, 'something', 'info')
	})

	it('should emit "browser_info"', () => {
	const spy = sinon.spy()
	const infoData = {}
	emitter.on('browser_info', spy)

	browser.state = Browser.STATE_EXECUTING
	browser.onInfo(infoData)
	expect(spy).to.have.been.calledWith(browser, infoData)
	})

	it('should ignore if browser not executing', () => {
	const spy = sinon.spy()
	emitter.on('browser_dump', spy)

	browser.state = Browser.STATE_CONNECTED
	browser.onInfo({dump: 'something'})
	browser.onInfo({total: 20})

	expect(browser.lastResult.total).to.equal(0)
	expect(spy).not.to.have.been.called
	})
	})

fix(browser): allow updating total specs count #3264

fix(browser): allow updating total specs count #3264

Uh oh!

Conversation

matz3 commented Feb 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnjbarton commented Feb 13, 2019

Uh oh!

johnjbarton Feb 13, 2019

Choose a reason for hiding this comment

Uh oh!

matz3 Feb 13, 2019

Choose a reason for hiding this comment

Uh oh!

johnjbarton Feb 13, 2019

Choose a reason for hiding this comment

Uh oh!

matz3 Feb 13, 2019

Choose a reason for hiding this comment

Uh oh!

johnjbarton commented Feb 13, 2019

Uh oh!

matz3 commented Feb 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matz3 commented Feb 13, 2019 •

edited

Loading