-
Notifications
You must be signed in to change notification settings - Fork 212
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: refactor command execution using PersistentShell
- Update command `_executeAndLogCommand` to use `PersistentShell` for executing scripts efficiently. - Add a new file `persistent_shell.dart` for defining the `PersistentShell` class. - Import `PersistentShell` in `runner.dart` for using it in the commands. - Introduce the `PersistentShell` class with methods for starting, sending commands, and stopping the shell. - Refactor the log handling in `MelosLogger` to complete based on specific markers. - Modify string manipulation in `utils.dart`, adding a method to prepend a step prefix emoji. - Update tests for `melos run` commands in `run_test.dart` to reflect the changes in the command execution flow.
- Loading branch information
1 parent
24fbcec
commit 494cad3
Showing
6 changed files
with
226 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
import 'dart:async'; | ||
import 'dart:convert'; | ||
import 'dart:io'; | ||
|
||
import '../logging.dart'; | ||
import 'platform.dart'; | ||
import 'utils.dart'; | ||
|
||
class PersistentShell { | ||
PersistentShell({ | ||
required this.logger, | ||
this.workingDirectory, | ||
}); | ||
|
||
final _isWindows = currentPlatform.isWindows; | ||
final MelosLogger logger; | ||
final String? workingDirectory; | ||
late final Process _process; | ||
Completer<void>? _commandCompleter; | ||
final String _successEndMarker = '__SUCCESS_COMMAND_END__'; | ||
final String _failureEndMarker = '__FAILURE_COMMAND_END__'; | ||
|
||
Future<void> startShell() async { | ||
final executable = _isWindows ? 'cmd.exe' : '/bin/sh'; | ||
|
||
_process = await Process.start( | ||
executable, | ||
[], | ||
workingDirectory: workingDirectory, | ||
); | ||
|
||
_listenToProcessStream(_process.stdout); | ||
_listenToProcessStream(_process.stderr, isError: true); | ||
} | ||
|
||
Future<bool> sendCommand(String command) async { | ||
assert(_commandCompleter == null, 'A command is already in progress.'); | ||
_commandCompleter = Completer<void>(); | ||
|
||
final fullCommand = _buildFullCommand(command); | ||
_process.stdin.writeln(fullCommand); | ||
|
||
return _awaitCommandCompletion(); | ||
} | ||
|
||
Future<void> stopShell() async { | ||
await _process.stdin.close(); | ||
final exitCode = await _process.exitCode; | ||
if (exitCode == 0) { | ||
logger.log(successLabel); | ||
return; | ||
} | ||
logger.log(failedLabel); | ||
} | ||
|
||
Future<bool> _awaitCommandCompletion() async { | ||
try { | ||
await _commandCompleter!.future; | ||
return true; | ||
} catch (e) { | ||
return false; | ||
} finally { | ||
_commandCompleter = null; | ||
} | ||
} | ||
|
||
void _listenToProcessStream( | ||
Stream<List<int>> stream, { | ||
bool isError = false, | ||
}) { | ||
stream.listen((event) { | ||
final output = utf8.decode(event, allowMalformed: true); | ||
logger.logAndCompleteBasedOnMarkers( | ||
output, | ||
_successEndMarker, | ||
_failureEndMarker, | ||
_commandCompleter, | ||
isError: isError, | ||
); | ||
}); | ||
} | ||
|
||
String _buildFullCommand(String command) { | ||
final formattedScriptStep = | ||
targetStyle(command.addStepPrefixEmoji().withoutTrailing('\n')); | ||
final echoCommand = 'echo "$formattedScriptStep"'; | ||
final echoSuccess = 'echo $_successEndMarker'; | ||
final echoFailure = 'echo $_failureEndMarker'; | ||
|
||
if (_isWindows) { | ||
return ''' | ||
$echoCommand && $command || VER>NUL && if %ERRORLEVEL% NEQ 0 ($echoFailure) else ($echoSuccess) | ||
'''; | ||
} | ||
|
||
return ''' | ||
$echoCommand && $command || true && if [ \$? -ne 0 ]; | ||
then $echoFailure; else $echoSuccess; fi | ||
'''; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.