Skip to content
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

Explicitly exit the process to not wait for hanging promises #907

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions __tests__/canary-installer.test.ts
Original file line number Diff line number Diff line change
@@ -46,6 +46,7 @@ describe('setup-node', () => {
let isCacheActionAvailable: jest.SpyInstance;
let getExecOutputSpy: jest.SpyInstance;
let getJsonSpy: jest.SpyInstance;
let processExitSpy: jest.SpyInstance;

beforeEach(() => {
// @actions/core
@@ -63,6 +64,9 @@ describe('setup-node', () => {
archSpy = jest.spyOn(osm, 'arch');
archSpy.mockImplementation(() => os['arch']);
execSpy = jest.spyOn(cp, 'execSync');
processExitSpy = jest
.spyOn(process, 'exit')
.mockImplementation((() => {}) as () => never);

// @actions/tool-cache
findSpy = jest.spyOn(tc, 'find');
12 changes: 12 additions & 0 deletions __tests__/main.test.ts
Original file line number Diff line number Diff line change
@@ -35,6 +35,8 @@ describe('main tests', () => {

let setupNodeJsSpy: jest.SpyInstance;

let processExitSpy: jest.SpyInstance;

beforeEach(() => {
inputs = {};

@@ -72,6 +74,10 @@ describe('main tests', () => {

setupNodeJsSpy = jest.spyOn(OfficialBuilds.prototype, 'setupNodeJs');
setupNodeJsSpy.mockImplementation(() => {});

processExitSpy = jest
.spyOn(process, 'exit')
.mockImplementation((() => {}) as () => never);
});

afterEach(() => {
@@ -257,6 +263,12 @@ describe('main tests', () => {
`::error::The specified node version file at: ${versionFilePath} does not exist${osm.EOL}`
);
});

it('should call process.exit() explicitly after running', async () => {
await main.run();

expect(processExitSpy).toHaveBeenCalled();
});
});

describe('cache on GHES', () => {
4 changes: 4 additions & 0 deletions __tests__/nightly-installer.test.ts
Original file line number Diff line number Diff line change
@@ -46,6 +46,7 @@ describe('setup-node', () => {
let isCacheActionAvailable: jest.SpyInstance;
let getExecOutputSpy: jest.SpyInstance;
let getJsonSpy: jest.SpyInstance;
let processExitSpy: jest.SpyInstance;

beforeEach(() => {
// @actions/core
@@ -64,6 +65,9 @@ describe('setup-node', () => {
archSpy = jest.spyOn(osm, 'arch');
archSpy.mockImplementation(() => os['arch']);
execSpy = jest.spyOn(cp, 'execSync');
processExitSpy = jest
.spyOn(process, 'exit')
.mockImplementation((() => {}) as () => never);

// @actions/tool-cache
findSpy = jest.spyOn(tc, 'find');
4 changes: 4 additions & 0 deletions __tests__/official-installer.test.ts
Original file line number Diff line number Diff line change
@@ -46,6 +46,7 @@ describe('setup-node', () => {
let isCacheActionAvailable: jest.SpyInstance;
let getExecOutputSpy: jest.SpyInstance;
let getJsonSpy: jest.SpyInstance;
let processExitSpy: jest.SpyInstance;

beforeEach(() => {
// @actions/core
@@ -63,6 +64,9 @@ describe('setup-node', () => {
archSpy = jest.spyOn(osm, 'arch');
archSpy.mockImplementation(() => os['arch']);
execSpy = jest.spyOn(cp, 'execSync');
processExitSpy = jest
.spyOn(process, 'exit')
.mockImplementation((() => {}) as () => never);

// @actions/tool-cache
findSpy = jest.spyOn(tc, 'find');
4 changes: 4 additions & 0 deletions __tests__/rc-installer.test.ts
Original file line number Diff line number Diff line change
@@ -41,6 +41,7 @@ describe('setup-node', () => {
let isCacheActionAvailable: jest.SpyInstance;
let getExecOutputSpy: jest.SpyInstance;
let getJsonSpy: jest.SpyInstance;
let processExitSpy: jest.SpyInstance;

beforeEach(() => {
// @actions/core
@@ -58,6 +59,9 @@ describe('setup-node', () => {
archSpy = jest.spyOn(osm, 'arch');
archSpy.mockImplementation(() => os['arch']);
execSpy = jest.spyOn(cp, 'execSync');
processExitSpy = jest
.spyOn(process, 'exit')
.mockImplementation((() => {}) as () => never);

// @actions/tool-cache
findSpy = jest.spyOn(tc, 'find');
3 changes: 3 additions & 0 deletions dist/setup/index.js
Original file line number Diff line number Diff line change
@@ -93711,6 +93711,9 @@ function run() {
catch (err) {
core.setFailed(err.message);
}
// Explicit process.exit() to not wait for hanging promises,
// see https://github.com/actions/setup-node/issues/878
process.exit();
});
}
exports.run = run;
4 changes: 4 additions & 0 deletions src/main.ts
Original file line number Diff line number Diff line change
@@ -77,6 +77,10 @@ export async function run() {
} catch (err) {
core.setFailed((err as Error).message);
}

// Explicit process.exit() to not wait for hanging promises,
// see https://github.com/actions/setup-node/issues/878
process.exit();
}

function resolveVersionInput(): string {