mirror of
https://github.com/balena-io/etcher.git
synced 2025-04-24 23:37:18 +00:00
49bb9677cd
When using the `--robot` option, we write to `stdout`/`stderr` using `WritableStream#write()`. This operation is asynchronous, however we're not waiting for the data to be flushed before calling `process.exit()` right after emitting the `done` event. This causes a rance condition where sometimes `done` is never written to the log file, and therefore the GUI remains waiting forever. Change-Type: patch Changelog-Entry: Fix application stuck at "Finishing". See: https://github.com/resin-io/etcher/issues/613 See: https://github.com/resin-io/etcher/issues/609 See: https://github.com/resin-io/etcher/issues/573 Signed-off-by: Juan Cruz Viotti <jviottidc@gmail.com>
107 lines
2.6 KiB
JavaScript
107 lines
2.6 KiB
JavaScript
/*
|
|
* Copyright 2016 Resin.io
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const Bluebird = require('bluebird');
|
|
const fs = require('fs');
|
|
const options = require('./cli');
|
|
const logStream = options.log ? fs.createWriteStream(options.log) : null;
|
|
const STDOUT_STREAM = logStream || process.stdout;
|
|
const STDERR_STREAM = logStream || process.stderr;
|
|
|
|
/**
|
|
* The purpose of this module is to workaround an Electron Windows issue
|
|
* where an Electron process with `ELECTRON_RUN_AS_NODE` enabled will
|
|
* not attach `stdout`/`stderr` to the process, therefore not allowing
|
|
* us to redirect output to a file from `child_process` or console pipes.
|
|
*
|
|
* A temporary solution is to implement logic that redirects output
|
|
* to a log file in the Etcher CLI.
|
|
*
|
|
* TODO: Delete this file, and the corresponding `--log` option once
|
|
* this issue is fixed in Electron.
|
|
* See: https://github.com/electron/electron/issues/5715
|
|
*/
|
|
|
|
/**
|
|
* @summary Write a line to stdout
|
|
* @function
|
|
* @public
|
|
*
|
|
* @description
|
|
* If the `--log` option was passed, this function writes the line
|
|
* to it, otherwise to `process.stdout`.
|
|
*
|
|
* @param {String} line - line
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* log.toStdout('Hello world!');
|
|
*/
|
|
exports.toStdout = (line) => {
|
|
return new Bluebird((resolve) => {
|
|
STDOUT_STREAM.write(line + '\n', () => {
|
|
return resolve();
|
|
});
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @summary Write a line to stderr
|
|
* @function
|
|
* @public
|
|
*
|
|
* @description
|
|
* If the `--log` option was passed, this function writes the line
|
|
* to it, otherwise to `process.stderr`.
|
|
*
|
|
* @param {String} line - line
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* log.toStderr('Hello world!');
|
|
*/
|
|
exports.toStderr = (line) => {
|
|
return new Bluebird((resolve) => {
|
|
STDERR_STREAM.write(line + '\n', () => {
|
|
return resolve();
|
|
});
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @summary Close any used streams, if needed
|
|
* @function
|
|
* @public
|
|
*
|
|
* @returns {Promise}
|
|
*
|
|
* @example
|
|
* log.close();
|
|
*/
|
|
exports.close = () => {
|
|
return new Bluebird((resolve) => {
|
|
if (!logStream) {
|
|
return resolve();
|
|
}
|
|
|
|
logStream.close(() => {
|
|
return resolve();
|
|
});
|
|
});
|
|
};
|