Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement 'Show Running Tasks...' #5353

Merged
merged 1 commit into from
Jun 5, 2019
Merged

Implement 'Show Running Tasks...' #5353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions packages/task/src/browser/quick-open-task.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import URI from '@theia/core/lib/common/uri';
import { TaskActionProvider } from './task-action-provider';
import { LabelProvider } from '@theia/core/lib/browser';
import { WorkspaceService } from '@theia/workspace/lib/browser';
import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-service';

@injectable()
export class QuickOpenTask implements QuickOpenModel, QuickOpenHandler {
Expand Down Expand Up @@ -387,3 +388,54 @@ export class TaskTerminateQuickOpen implements QuickOpenModel {
}

}

@injectable()
export class TaskRunningQuickOpen implements QuickOpenModel {

@inject(QuickOpenService)
protected readonly quickOpenService: QuickOpenService;

@inject(TaskService)
protected readonly taskService: TaskService;

@inject(TerminalService)
protected readonly terminalService: TerminalService;

async onType(_lookFor: string, acceptor: (items: QuickOpenItem[]) => void): Promise<void> {
const items: QuickOpenItem[] = [];
const runningTasks: TaskInfo[] = await this.taskService.getRunningTasks();
if (runningTasks.length <= 0) {
items.push(new QuickOpenItem({
label: 'No task is currently running',
run: (): boolean => false,
}));
} else {
runningTasks.forEach((task: TaskInfo) => {
items.push(new QuickOpenItem({
label: task.config.label,
run: (mode: QuickOpenMode): boolean => {
if (mode !== QuickOpenMode.OPEN) {
return false;
}
if (task.terminalId) {
const terminal = this.terminalService.getById('terminal-' + task.terminalId);
if (terminal) {
this.terminalService.open(terminal);
}
}
return true;
}
}));
});
}
acceptor(items);
}

async open(): Promise<void> {
this.quickOpenService.open(this, {
placeholder: 'Select the task to show its output',
fuzzyMatchLabel: true,
fuzzyMatchDescription: true,
});
}
}
64 changes: 59 additions & 5 deletions packages/task/src/browser/task-frontend-contribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/

import { inject, injectable, named } from 'inversify';
import { inject, injectable, named, postConstruct } from 'inversify';
import { ILogger, ContributionProvider } from '@theia/core/lib/common';
import { QuickOpenTask, TaskTerminateQuickOpen } from './quick-open-task';
import { QuickOpenTask, TaskTerminateQuickOpen, TaskRunningQuickOpen } from './quick-open-task';
import { CommandContribution, Command, CommandRegistry, MenuContribution, MenuModelRegistry } from '@theia/core/lib/common';
import {
FrontendApplication, FrontendApplicationContribution, QuickOpenContribution,
QuickOpenHandlerRegistry, KeybindingRegistry, KeybindingContribution, StorageService
QuickOpenHandlerRegistry, KeybindingRegistry, KeybindingContribution, StorageService, StatusBar, StatusBarAlignment
} from '@theia/core/lib/browser';
import { WidgetManager } from '@theia/core/lib/browser/widget-manager';
import { TaskContribution, TaskResolverRegistry, TaskProviderRegistry } from './task-contribution';
import { TaskService } from './task-service';
import { TerminalMenus } from '@theia/terminal/lib/browser/terminal-frontend-contribution';
import { TaskSchemaUpdater } from './task-schema-updater';
import { TaskConfiguration } from '../common';
import { TaskConfiguration, TaskWatcher } from '../common';

export namespace TaskCommands {
const TASK_CATEGORY = 'Task';
Expand Down Expand Up @@ -67,6 +67,12 @@ export namespace TaskCommands {
label: 'Clear History'
};

export const TASK_SHOW_RUNNING: Command = {
id: 'task:show-running',
category: TASK_CATEGORY,
label: 'Show Running Tasks'
};

export const TASK_TERMINATE: Command = {
id: 'task:terminate',
category: TASK_CATEGORY,
Expand Down Expand Up @@ -108,9 +114,24 @@ export class TaskFrontendContribution implements CommandContribution, MenuContri
@inject(StorageService)
protected readonly storageService: StorageService;

@inject(TaskRunningQuickOpen)
protected readonly taskRunningQuickOpen: TaskRunningQuickOpen;

@inject(TaskTerminateQuickOpen)
protected readonly taskTerminateQuickOpen: TaskTerminateQuickOpen;

@inject(TaskWatcher)
protected readonly taskWatcher: TaskWatcher;

@inject(StatusBar)
protected readonly statusBar: StatusBar;

@postConstruct()
protected async init(): Promise<void> {
this.taskWatcher.onTaskCreated(() => this.updateRunningTasksItem());
this.taskWatcher.onTaskExit(() => this.updateRunningTasksItem());
}

onStart(): void {
this.contributionProvider.getContributions().forEach(contrib => {
if (contrib.registerResolvers) {
Expand All @@ -131,6 +152,26 @@ export class TaskFrontendContribution implements CommandContribution, MenuContri
this.storageService.setData<{ recent: TaskConfiguration[] }>(TASKS_STORAGE_KEY, { recent });
}

/**
* Contribute a status-bar item to trigger
* the `Show Running Tasks` command.
*/
protected async updateRunningTasksItem(): Promise<void> {
const id = 'show-running-tasks';
const items = await this.taskService.getRunningTasks();
if (!!items.length) {
this.statusBar.setElement(id, {
text: `$(wrench) ${items.length}`,
tooltip: 'Show Running Tasks',
alignment: StatusBarAlignment.LEFT,
priority: 2,
command: TaskCommands.TASK_SHOW_RUNNING.id,
});
} else {
this.statusBar.removeElement(id);
}
}

registerCommands(registry: CommandRegistry): void {
registry.registerCommand(
TaskCommands.TASK_RUN,
Expand Down Expand Up @@ -182,6 +223,13 @@ export class TaskFrontendContribution implements CommandContribution, MenuContri
}
);

registry.registerCommand(
TaskCommands.TASK_SHOW_RUNNING,
{
execute: () => this.taskRunningQuickOpen.open()
}
);

registry.registerCommand(
TaskCommands.TASK_TERMINATE,
{
Expand Down Expand Up @@ -211,10 +259,16 @@ export class TaskFrontendContribution implements CommandContribution, MenuContri
order: '3'
});

menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
commandId: TaskCommands.TASK_SHOW_RUNNING.id,
label: 'Show Running Tasks...',
order: '0'
});

menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_INFO, {
commandId: TaskCommands.TASK_TERMINATE.id,
label: 'Terminate Task...',
order: '0'
order: '1'
});

menus.registerMenuAction(TerminalMenus.TERMINAL_TASKS_CONFIG, {
Expand Down
3 changes: 2 additions & 1 deletion packages/task/src/browser/task-frontend-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { ContainerModule } from 'inversify';
import { FrontendApplicationContribution, QuickOpenContribution, KeybindingContribution } from '@theia/core/lib/browser';
import { CommandContribution, MenuContribution, bindContributionProvider } from '@theia/core/lib/common';
import { WebSocketConnectionProvider } from '@theia/core/lib/browser/messaging';
import { QuickOpenTask, TaskTerminateQuickOpen } from './quick-open-task';
import { QuickOpenTask, TaskTerminateQuickOpen, TaskRunningQuickOpen } from './quick-open-task';
import { TaskContribution, TaskProviderRegistry, TaskResolverRegistry } from './task-contribution';
import { TaskService } from './task-service';
import { TaskConfigurations } from './task-configurations';
Expand All @@ -43,6 +43,7 @@ export default new ContainerModule(bind => {
}

bind(QuickOpenTask).toSelf().inSingletonScope();
bind(TaskRunningQuickOpen).toSelf().inSingletonScope();
bind(TaskTerminateQuickOpen).toSelf().inSingletonScope();
bind(TaskConfigurations).toSelf().inSingletonScope();
bind(ProvidedTaskConfigurations).toSelf().inSingletonScope();
Expand Down
2 changes: 1 addition & 1 deletion packages/task/src/browser/task-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ export class TaskService implements TaskConfigurationClient {
TERMINAL_WIDGET_FACTORY_ID,
<TerminalWidgetFactoryOptions>{
created: new Date().toString(),
id: 'task-' + taskId,
id: 'terminal-' + terminalId,
caption: `Task #${taskId}`,
label: `Task #${taskId}`,
destroyTermOnClose: true
Expand Down