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

Breaking change: Env#execute no longer takes a callback

Browse Source 
Use the returned promise instead.
This commit is contained in:
Steve Gravrock
2022-08-21 16:35:12 -07:00
parent 4fcdbd39fb
commit 0bfbda720d
3 changed files with 8 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1638,18 +1638,12 @@ getJasmineRequireObj().Env = function(j$) {
/**
* Executes the specs.
*
* If called with no parameters or with a falsy value as the first parameter,
* If called with no parameter or with a falsy parameter,
* all specs will be executed except those that are excluded by a
* [spec filter]{@link Configuration#specFilter} or other mechanism. If the
* first parameter is a list of spec/suite IDs, only those specs/suites will
* parameter is a list of spec/suite IDs, only those specs/suites will
* be run.
*
* Both parameters are optional, but a completion callback is only valid as
* the second parameter. To specify a completion callback but not a list of
* specs/suites to run, pass null or undefined as the first parameter. The
* completion callback is supported for backward compatibility. In most
* cases it will be more convenient to use the returned promise instead.
*
* execute should not be called more than once unless the env has been
* configured with `{autoCleanClosures: false}`.
*
@@ -1663,19 +1657,11 @@ getJasmineRequireObj().Env = function(j$) {
* @since 2.0.0
* @function
* @param {(string[])=} runablesToRun IDs of suites and/or specs to run
* @param {Function=} onComplete Function that will be called after all specs have run
* @return {Promise<JasmineDoneInfo>}
*/
this.execute = function(runablesToRun, onComplete) {
this.execute = function(runablesToRun) {
installGlobalErrors();
return runner.execute(runablesToRun).then(function(jasmineDoneInfo) {
if (onComplete) {
onComplete();
}
return jasmineDoneInfo;
});
return runner.execute(runablesToRun);
};
/**

10
spec/core/integration/EnvSpec.js
View File

@@ -3670,16 +3670,6 @@ describe('Env integration', function() {
expect(failedExpectations).toEqual([]);
});
it('calls the optional done callback when finished', function(done) {
const reporter = jasmine.createSpyObj('reporter', ['jasmineDone']);
env.addReporter(reporter);
env.execute(null, function() {
expect(reporter.jasmineDone).toHaveBeenCalled();
done();
});
});
describe('#spyOnGlobalErrorsAsync', function() {
const leftInstalledMessage =
'Global error spy was not uninstalled. ' +

22
src/core/Env.js
View File

@@ -496,18 +496,12 @@ getJasmineRequireObj().Env = function(j$) {
/**
* Executes the specs.
*
* If called with no parameters or with a falsy value as the first parameter,
* If called with no parameter or with a falsy parameter,
* all specs will be executed except those that are excluded by a
* [spec filter]{@link Configuration#specFilter} or other mechanism. If the
* first parameter is a list of spec/suite IDs, only those specs/suites will
* parameter is a list of spec/suite IDs, only those specs/suites will
* be run.
*
* Both parameters are optional, but a completion callback is only valid as
* the second parameter. To specify a completion callback but not a list of
* specs/suites to run, pass null or undefined as the first parameter. The
* completion callback is supported for backward compatibility. In most
* cases it will be more convenient to use the returned promise instead.
*
* execute should not be called more than once unless the env has been
* configured with `{autoCleanClosures: false}`.
*
@@ -521,19 +515,11 @@ getJasmineRequireObj().Env = function(j$) {
* @since 2.0.0
* @function
* @param {(string[])=} runablesToRun IDs of suites and/or specs to run
* @param {Function=} onComplete Function that will be called after all specs have run
* @return {Promise<JasmineDoneInfo>}
*/
this.execute = function(runablesToRun, onComplete) {
this.execute = function(runablesToRun) {
installGlobalErrors();
return runner.execute(runablesToRun).then(function(jasmineDoneInfo) {
if (onComplete) {
onComplete();
}
return jasmineDoneInfo;
});
return runner.execute(runablesToRun);
};
/**