-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move progress status bar item to core
Signed-off-by: Alex Tugarev <alex.tugarev@typefox.io>
- Loading branch information
1 parent
d6f82aa
commit 057ccae
Showing
3 changed files
with
138 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/******************************************************************************** | ||
* Copyright (C) 2019 TypeFox and others. | ||
* | ||
* This program and the accompanying materials are made available under the | ||
* terms of the Eclipse Public License v. 2.0 which is available at | ||
* http://www.eclipse.org/legal/epl-2.0. | ||
* | ||
* This Source Code may also be made available under the following Secondary | ||
* Licenses when the conditions for such availability set forth in the Eclipse | ||
* Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
* with the GNU Classpath Exception which is available at | ||
* https://www.gnu.org/software/classpath/license.html. | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
********************************************************************************/ | ||
|
||
import { injectable, inject } from 'inversify'; | ||
import { CancellationToken } from '../common/cancellation'; | ||
import { ProgressClient } from '../common/progress-service-protocol'; | ||
import { ProgressMessage, ProgressUpdate } from '../common/message-service-protocol'; | ||
import { ProgressStatusBarItem } from './progress-status-bar-item'; | ||
import { ProgressLocationService } from './progress-location-service'; | ||
|
||
@injectable() | ||
export class DispatchingProgressClient implements ProgressClient { | ||
|
||
@inject(ProgressStatusBarItem) | ||
protected statusBarItem: ProgressStatusBarItem; | ||
|
||
@inject(ProgressLocationService) | ||
protected locationService: ProgressLocationService; | ||
|
||
showProgress(progressId: string, message: ProgressMessage, cancellationToken: CancellationToken): Promise<string | undefined> { | ||
const locationId = this.getLocationId(message); | ||
if (locationId === 'window') { | ||
return this.statusBarItem.showProgress(progressId, message, cancellationToken); | ||
} | ||
return this.locationService.showProgress(progressId, message, cancellationToken); | ||
} | ||
|
||
reportProgress(progressId: string, update: ProgressUpdate, message: ProgressMessage, cancellationToken: CancellationToken): Promise<void> { | ||
const locationId = this.getLocationId(message); | ||
if (locationId === 'window') { | ||
return this.statusBarItem.reportProgress(progressId, update, message, cancellationToken); | ||
} | ||
return this.locationService.reportProgress(progressId, update, message, cancellationToken); | ||
} | ||
|
||
protected getLocationId(message: ProgressMessage): string { | ||
return message.options && message.options.location || 'unknownLocation'; | ||
} | ||
|
||
} |
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,80 @@ | ||
/******************************************************************************** | ||
* Copyright (C) 2019 TypeFox and others. | ||
* | ||
* This program and the accompanying materials are made available under the | ||
* terms of the Eclipse Public License v. 2.0 which is available at | ||
* http://www.eclipse.org/legal/epl-2.0. | ||
* | ||
* This Source Code may also be made available under the following Secondary | ||
* Licenses when the conditions for such availability set forth in the Eclipse | ||
* Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
* with the GNU Classpath Exception which is available at | ||
* https://www.gnu.org/software/classpath/license.html. | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 | ||
********************************************************************************/ | ||
|
||
import { injectable, inject } from 'inversify'; | ||
import { CancellationToken } from 'vscode-jsonrpc'; | ||
import { ProgressClient } from '../common'; | ||
import { ProgressMessage, ProgressUpdate } from '../common'; | ||
import { StatusBar, StatusBarAlignment } from './status-bar'; | ||
import { Deferred } from '../common/promise-util'; | ||
import throttle = require('lodash.throttle'); | ||
|
||
@injectable() | ||
export class ProgressStatusBarItem implements ProgressClient { | ||
|
||
protected readonly id = 'theia-progress-status-bar-item'; | ||
|
||
@inject(StatusBar) | ||
protected readonly statusBar: StatusBar; | ||
|
||
showProgress(progressId: string, message: ProgressMessage, cancellationToken: CancellationToken): Promise<string | undefined> { | ||
const result = new Deferred<string | undefined>(); | ||
cancellationToken.onCancellationRequested(() => { | ||
this.processEvent(progressId, 'done'); | ||
result.resolve(ProgressMessage.Cancel); | ||
}); | ||
this.processEvent(progressId, 'start', message.text); | ||
return result.promise; | ||
} | ||
protected messagesByProgress = new Map<string, string | undefined>(); | ||
protected incomingQueue = new Array<string>(); | ||
protected processEvent(progressId: string, event: 'start' | 'done', message?: string): void { | ||
if (event === 'start') { | ||
this.incomingQueue.push(progressId); | ||
this.messagesByProgress.set(progressId, message); | ||
} else { | ||
this.incomingQueue = this.incomingQueue.filter(id => id !== progressId); | ||
} | ||
this.triggerUpdate(); | ||
} | ||
protected readonly triggerUpdate = throttle(() => { | ||
const pick: string | undefined = this.incomingQueue.slice(-1)[0]; | ||
this.update(pick); | ||
}, 250, { leading: true, trailing: true }); | ||
|
||
async reportProgress(progressId: string, update: ProgressUpdate, _message: ProgressMessage, _cancellationToken: CancellationToken): Promise<void> { | ||
const { message } = update; | ||
if (message) { | ||
this.messagesByProgress.set(progressId, message); | ||
} | ||
this.triggerUpdate(); | ||
} | ||
|
||
protected update(progressId: string | undefined): void { | ||
const message = progressId && this.messagesByProgress.get(progressId); | ||
if (!progressId || !message) { | ||
this.statusBar.removeElement(this.id); | ||
return; | ||
} | ||
const text = `$(refresh~spin) ${message}`; | ||
this.statusBar.setElement(this.id, { | ||
text, | ||
alignment: StatusBarAlignment.LEFT, | ||
priority: 1 | ||
}); | ||
} | ||
|
||
} |