warren/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions 9 Packages Projects Releases Wiki Activity

Deprecate non-Error arguments passed to done()

Browse Source 
[Finishes #178267600]
This commit is contained in:
Steve Gravrock
2021-07-24 09:18:24 -07:00
parent 10601f5af6
commit 70d49e5b57
7 changed files with 147 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
lib/jasmine-core/jasmine.js
View File

@@ -861,10 +861,11 @@ getJasmineRequireObj().Spec = function(j$) {
self.onException.apply(self, arguments);
},
onComplete: function() {
onComplete(
self.result.status === 'failed' &&
new j$.StopExecutionError('spec failed')
);
if (self.result.status === 'failed') {
onComplete(new j$.StopExecutionError('spec failed'));
} else {
onComplete();
}
},
userContext: this.userContext()
};
@@ -3863,7 +3864,6 @@ getJasmineRequireObj().deprecatingSuiteProxy = function(j$) {
};
DeprecatingSuiteProxyHandler.prototype.set = function(target, prop, value) {
debugger;
this._maybeDeprecate(target, prop);
return (target[prop] = value);
};
@@ -8176,6 +8176,12 @@ getJasmineRequireObj().QueueRunner = function(j$) {
self.fail(err);
}
self.errored = errored = true;
} else if (typeof err !== 'undefined' && !self.errored) {
self.deprecated(
'Any argument passed to a done callback will be treated as an ' +
'error in a future release. Call the done callback without ' +
"arguments if you don't want to trigger a spec failure."
);
}
function runNext() {
@@ -8281,7 +8287,12 @@ getJasmineRequireObj().QueueRunner = function(j$) {
this.clearStack(function() {
self.globalErrors.popListener(self.handleFinalError);
self.onComplete(self.errored && new StopExecutionError());
if (self.errored) {
self.onComplete(new StopExecutionError());
} else {
self.onComplete();
}
});
};

123
spec/core/QueueRunnerSpec.js
View File

@@ -149,31 +149,111 @@ describe('QueueRunner', function() {
expect(queueableFn2.fn).toHaveBeenCalled();
});
it('explicitly fails an async function when next is called with an Error and moves to the next function', function() {
var err = new Error('foo'),
queueableFn1 = {
fn: function(done) {
setTimeout(function() {
done(err);
}, 100);
}
},
queueableFn2 = { fn: jasmine.createSpy('fn2') },
failFn = jasmine.createSpy('fail'),
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn1, queueableFn2],
fail: failFn
describe('When next is called with an argument', function() {
describe('that is an Error', function() {
it('explicitly fails and moves to the next function', function() {
var err = new Error('foo'),
queueableFn1 = {
fn: function(done) {
setTimeout(function() {
done(err);
}, 100);
}
},
queueableFn2 = { fn: jasmine.createSpy('fn2') },
failFn = jasmine.createSpy('fail'),
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn1, queueableFn2],
fail: failFn
});
queueRunner.execute();
expect(failFn).not.toHaveBeenCalled();
expect(queueableFn2.fn).not.toHaveBeenCalled();
jasmine.clock().tick(100);
expect(failFn).toHaveBeenCalledWith(err);
expect(queueableFn2.fn).toHaveBeenCalled();
});
queueRunner.execute();
it('does not log a deprecation', function() {
var err = new Error('foo'),
queueableFn1 = {
fn: function(done) {
setTimeout(function() {
done(err);
}, 100);
}
},
deprecated = jasmine.createSpy('deprecated'),
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn1],
deprecated: deprecated
});
expect(failFn).not.toHaveBeenCalled();
expect(queueableFn2.fn).not.toHaveBeenCalled();
queueRunner.execute();
jasmine.clock().tick(100);
jasmine.clock().tick(100);
expect(failFn).toHaveBeenCalledWith(err);
expect(queueableFn2.fn).toHaveBeenCalled();
expect(deprecated).not.toHaveBeenCalled();
});
});
describe('that is not an Error', function() {
it('logs a deprecation', function() {
var queueableFn1 = {
fn: function(done) {
setTimeout(function() {
done('not an Error');
}, 100);
}
},
deprecated = jasmine.createSpy('deprecated'),
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn1],
deprecated: deprecated
});
queueRunner.execute();
jasmine.clock().tick(100);
expect(deprecated).toHaveBeenCalledWith(
'Any argument passed to a done callback will be treated as an ' +
'error in a future release. Call the done callback without ' +
"arguments if you don't want to trigger a spec failure."
);
});
it('moves to the next function without failing', function() {
var queueableFn1 = {
fn: function(done) {
setTimeout(function() {
done('not an Error');
}, 100);
}
},
queueableFn2 = { fn: jasmine.createSpy('fn2') },
failFn = jasmine.createSpy('fail'),
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn1, queueableFn2],
fail: failFn,
deprecated: function() {}
});
queueRunner.execute();
expect(failFn).not.toHaveBeenCalled();
expect(queueableFn2.fn).not.toHaveBeenCalled();
jasmine.clock().tick(100);
expect(failFn).not.toHaveBeenCalled();
expect(queueableFn2.fn).toHaveBeenCalled();
});
});
});
it('does not cause an explicit fail if execution is being stopped', function() {
@@ -523,8 +603,7 @@ describe('QueueRunner', function() {
queueRunner = new jasmineUnderTest.QueueRunner({
queueableFns: [queueableFn],
deprecated: deprecated
}),
env = jasmineUnderTest.getEnv();
});
queueRunner.execute();

7
spec/core/integration/CustomAsyncMatchersSpec.js
View File

@@ -161,7 +161,12 @@ describe('Custom Async Matchers (Integration)', function() {
};
spyOn(env, 'deprecated');
env.addReporter({ specDone: specExpectations, jasmineDone: done });
env.addReporter({
specDone: specExpectations,
jasmineDone: function() {
done();
}
});
env.execute();
});
});

7
spec/core/integration/CustomMatchersSpec.js
View File

@@ -313,7 +313,12 @@ describe('Custom Matchers (Integration)', function() {
);
};
env.addReporter({ specDone: specExpectations, jasmineDone: done });
env.addReporter({
specDone: specExpectations,
jasmineDone: function() {
done();
}
});
env.execute();
});
});

13
src/core/QueueRunner.js
View File

@@ -105,6 +105,12 @@ getJasmineRequireObj().QueueRunner = function(j$) {
self.fail(err);
}
self.errored = errored = true;
} else if (typeof err !== 'undefined' && !self.errored) {
self.deprecated(
'Any argument passed to a done callback will be treated as an ' +
'error in a future release. Call the done callback without ' +
"arguments if you don't want to trigger a spec failure."
);
}
function runNext() {
@@ -210,7 +216,12 @@ getJasmineRequireObj().QueueRunner = function(j$) {
this.clearStack(function() {
self.globalErrors.popListener(self.handleFinalError);
self.onComplete(self.errored && new StopExecutionError());
if (self.errored) {
self.onComplete(new StopExecutionError());
} else {
self.onComplete();
}
});
};

9
src/core/Spec.js
View File

@@ -129,10 +129,11 @@ getJasmineRequireObj().Spec = function(j$) {
self.onException.apply(self, arguments);
},
onComplete: function() {
onComplete(
self.result.status === 'failed' &&
new j$.StopExecutionError('spec failed')
);
if (self.result.status === 'failed') {
onComplete(new j$.StopExecutionError('spec failed'));
} else {
onComplete();
}
},
userContext: this.userContext()
};

1
src/core/deprecatingSuiteProxy.js
View File

@@ -65,7 +65,6 @@ getJasmineRequireObj().deprecatingSuiteProxy = function(j$) {
};
DeprecatingSuiteProxyHandler.prototype.set = function(target, prop, value) {
debugger;
this._maybeDeprecate(target, prop);
return (target[prop] = value);
};