Log stdout and stderr from plugin installation and removal #1682
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ import upath from 'upath'; | |
| import fs from 'fs'; | ||
| import { tmpdir } from 'os'; | ||
| import toml from 'toml'; | ||
| import { execSync, spawn } from 'child_process'; | ||
| import { ipcMain } from 'electron'; | ||
|
|
||
| import { getLogger } from './logger'; | ||
|
|
@@ -11,59 +11,112 @@ import { settingsStore } from './settingsStore'; | |
|
|
||
| const logger = getLogger(__filename.split('/').slice(-1)[0]); | ||
|
|
||
| /** | ||
| * Spawn a child process and log its stdout, stderr, and any error in spawning. | ||
| * | ||
| * child_process.spawn is called with the provided cmd, args, and options, | ||
| * and the windowsHide option set to true. | ||
| * | ||
| * Required properties missing from the store are initialized with defaults. | ||
| * Invalid properties are reset to defaults. | ||
| * @param {string} cmd - command to pass to spawn | ||
| * @param {Array} args - command arguments to pass to spawn | ||
| * @param {object} options - options to pass to spawn. | ||
| * @returns {Promise} resolves when the command finishes with exit code 0. | ||
| * Rejects with error otherwise. | ||
| */ | ||
| function spawnWithLogging(cmd, args, options) { | ||
| logger.info(cmd, args); | ||
| const cmdProcess = spawn(cmd, args, { ...options, windowsHide: true }); | ||
| if (cmdProcess.stdout) { | ||
| cmdProcess.stderr.on('data', (data) => logger.info(data.toString())); | ||
| cmdProcess.stdout.on('data', (data) => logger.info(data.toString())); | ||
| } | ||
| return new Promise((resolve, reject) => { | ||
| cmdProcess.on('error', (err) => { | ||
| logger.error(err); | ||
| reject(err); | ||
| }); | ||
| cmdProcess.on('close', (code) => { | ||
| if (code === 0) { | ||
| resolve(code); | ||
| } else { | ||
| reject(code); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| export function setupAddPlugin() { | ||
| ipcMain.handle( | ||
| ipcMainChannels.ADD_PLUGIN, | ||
| async (e, pluginURL) => { | ||
| logger.info('adding plugin at', pluginURL); | ||
|
|
||
| const mamba = settingsStore.get('mamba'); | ||
| let envName; | ||
| let pluginID; | ||
| let pluginName; | ||
| let pluginPyName; | ||
|
|
||
| try { | ||
| // Create a temporary directory and check out the plugin's pyproject.toml | ||
| const tmpPluginDir = fs.mkdtempSync(upath.join(tmpdir(), 'natcap-invest-')); | ||
| await spawnWithLogging( | ||
| 'git', | ||
| ['clone', '--depth', '1', '--no-checkout', pluginURL, tmpPluginDir] | ||
| ).then(async () => { | ||
|
There was a problem hiding this comment. @emlys , forgive me for popping in here. I don't think we need the await spawnWithLoggin('git clone ...');
await spawnWithLogging('git checkout ...');
... |
||
| await spawnWithLogging( | ||
| 'git', | ||
| ['checkout', 'HEAD', 'pyproject.toml'], | ||
| { cwd: tmpPluginDir } | ||
| ); | ||
| }).then(async () => { | ||
| // Read in the plugin's pyproject.toml, then delete it | ||
| const pyprojectTOML = toml.parse(fs.readFileSync( | ||
| upath.join(tmpPluginDir, 'pyproject.toml') | ||
| ).toString()); | ||
| fs.rmSync(tmpPluginDir, { recursive: true, force: true }); | ||
|
|
||
| // Access plugin metadata from the pyproject.toml | ||
| pluginID = pyprojectTOML.tool.natcap.invest.model_id; | ||
| pluginName = pyprojectTOML.tool.natcap.invest.model_name; | ||
| pluginPyName = pyprojectTOML.tool.natcap.invest.pyname; | ||
|
|
||
| // Create a conda env containing the plugin and its dependencies | ||
| envName = `invest_plugin_${pluginID}`; | ||
| await spawnWithLogging( | ||
| mamba, | ||
| ['create', '--yes', '--name', envName, '-c', 'conda-forge', '"python<3.12"', '"gdal<3.6"'] | ||
| ); | ||
| logger.info('created mamba env for plugin'); | ||
| }).then(async () => { | ||
| await spawnWithLogging( | ||
| mamba, | ||
| ['run', '--verbose', '--no-capture-output', '--name', envName, 'pip', 'install', `git+${pluginURL}`] | ||
| ); | ||
| logger.info('installed plugin into its env'); | ||
| }) | ||
| .then(() => { | ||
| // Write plugin metadata to the workbench's config.json | ||
| const envInfo = execSync(`${mamba} info --envs`, { windowsHide: true }).toString(); | ||
| logger.info(`env info:\n${envInfo}`); | ||
| const regex = new RegExp(String.raw`^${envName} +(.+)$`, 'm'); | ||
| const envPath = envInfo.match(regex)[1]; | ||
| logger.info(`env path:\n${envPath}`); | ||
| logger.info('writing plugin info to settings store'); | ||
| settingsStore.set( | ||
| `plugins.${pluginID}`, | ||
| { | ||
| model_name: pluginName, | ||
| pyname: pluginPyName, | ||
| type: 'plugin', | ||
| source: pluginURL, | ||
| env: envPath, | ||
| } | ||
| ); | ||
| logger.info('successfully added plugin'); | ||
| }); | ||
| } catch (error) { | ||
| return error; | ||
| } | ||
|
|
@@ -74,16 +127,13 @@ export function setupAddPlugin() { | |
| export function setupRemovePlugin() { | ||
| ipcMain.handle( | ||
| ipcMainChannels.REMOVE_PLUGIN, | ||
| async (e, pluginID) => { | ||
| logger.info('removing plugin', pluginID); | ||
| try { | ||
| // Delete the plugin's conda env | ||
| const env = settingsStore.get(`plugins.${pluginID}.env`); | ||
| const mamba = settingsStore.get('mamba'); | ||
| await spawnWithLogging(mamba, ['remove', '--yes', '--prefix', `"${env}"`, '--all']); | ||
| // Delete the plugin's data from storage | ||
| settingsStore.delete(`plugins.${pluginID}`); | ||
| logger.info('successfully removed plugin'); | ||
|
|
||
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this function have a docstring above it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a docstring