che-task-runner.ts

/*********************************************************************
 * Copyright (c) 2019 Red Hat, Inc.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 **********************************************************************/

import { injectable, inject, postConstruct } from 'inversify';
import * as che from '@eclipse-che/plugin';
import { CHE_TASK_TYPE, Target } from './task-protocol';
import { MachineExecClient } from '../machine/machine-exec-client';
import { ProjectPathVariableResolver } from '../variable/project-path-variable-resolver';
import { MachineExecWatcher } from '../machine/machine-exec-watcher';
import * as startPoint from '../task-plugin-backend';
import * as theia from '@theia/plugin';

// CHE task gets ID at creating in che task service
// https://github.com/eclipse/che-theia/blob/c515f75044f9099820c3b18afb8de83f263d671a/extensions/eclipse-che-theia-plugin-ext/src/node/che-task-service.ts#L89
const STUB_TASK_ID: number = -1;

@injectable()
export class CheTaskRunner {

    @inject(MachineExecClient)
    protected readonly machineExecClient: MachineExecClient;

    @inject(ProjectPathVariableResolver)
    protected readonly projectPathVariableResolver: ProjectPathVariableResolver;

    @inject(MachineExecWatcher)
    protected readonly machineExecWatcher: MachineExecWatcher;

    @postConstruct()
    protected init(): void {
        const disposable = this.machineExecWatcher.onExit(event => {
            che.task.fireTaskExited({ execId: event.id, code: event.code, processId: event.id });
        });
        startPoint.getSubscriptions().push(disposable);
    }

    /**
     * Runs a task from the given task configuration which must have a target property specified.
     */
    async run(taskConfig: che.TaskConfiguration, ctx?: string): Promise<che.TaskInfo> {
        const { type, label, ...definition } = taskConfig;
        if (type !== CHE_TASK_TYPE) {
            throw new Error(`Unsupported task type: ${type}`);
        }

        const target: Target = definition.target;
        if (!target) {
            throw new Error("Che task config must have 'target' property specified");
        }

        const containerName = target.containerName;
        if (!containerName) {
            throw new Error("Che task config must have 'target.containerName' property specified");
        }

        try {
            const terminalOptions: theia.TerminalOptions = {
                cwd: target.workingDir,
                name: taskConfig.label,
                shellPath: 'sh',
                shellArgs: ['-c', `${taskConfig.command}`],

                attributes: {
                    CHE_MACHINE_NAME: containerName,
                    closeWidgetExitOrError: 'false',
                    interruptProcessOnClose: 'true'
                }
            };
            const terminal = theia.window.createTerminal(terminalOptions);
            terminal.show();
            const execId = await terminal.processId;

            return {
                taskId: STUB_TASK_ID,
                ctx: ctx,
                config: taskConfig,
                execId: execId
            };
        } catch (error) {
            console.error('Failed to execute Che command:', error);
            throw new Error(`Failed to execute Che command: ${error.message}`);
        }
    }

    /** Terminates a task based on the given info. */
    async kill(taskInfo: che.TaskInfo): Promise<void> {
        for (const terminal of theia.window.terminals) {
            try {
                const processId = await terminal.processId;
                if (processId === taskInfo.execId) {
                    terminal.sendText('\x03');
                    return;
                }
            } catch (e) {
                // allow to get process id for other terminals
            }
        }
        throw new Error(`Failed to terminate Che command: ${taskInfo.config.label}: the corresponding terminal is not found`);
    }
}