ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-03-10 22:44:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Gracefully handle multiple reboot/shutdown requests

Browse Source 
Since HTTP's server.close() is async, there is a slim chance
for two instances of /v1/reboot or /v1/shutdown to be processed.
If the server is already closed when server.close() is called,
the call throws ERR_SERVER_NOT_RUNNING
which doesn't need to be surfaced to the user. This change
only allows one server.close() attempt to occur at a time.

Change-type: patch
Signed-off-by: Christina Ying Wang <christina@balena.io>
This commit is contained in:
Christina Ying Wang 2024-04-23 11:55:27 -07:00
parent 9592912f4c
commit 14bdc522c1
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/device-api/index.ts
View File

@ -12,10 +12,6 @@ interface SupervisorAPIConstructOpts {
healthchecks: Array<() => Promise<boolean>>;
}
interface SupervisorAPIStopOpts {
errored: boolean;
}
// API key methods
// For better black boxing, device-api should serve as the interface
// to the rest of the Supervisor code for accessing API key related methods.
@ -92,22 +88,25 @@ export class SupervisorAPI {
});
}
public async stop(options?: SupervisorAPIStopOpts): Promise<void> {
public async stop(): Promise<void> {
if (this.server != null) {
const server = this.server;
this.server = null;
return new Promise((resolve, reject) => {
this.server?.close((err: Error) => {
server.close((err: Error) => {
if (err) {
log.error('Failed to stop Supervisor API');
// In case the HTTP server fails to shut down,
// make this.server available again for future attempts.
this.server = server;
return reject(err);
}
if (options?.errored) {
log.error('Stopped Supervisor API');
} else {
log.info('Stopped Supervisor API');
return resolve();
}
return resolve();
});
});
} else {
log.warn('Supervisor API already stopped, ignoring further requests');
}
}
}