-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
manager.ts
294 lines (260 loc) · 7.46 KB
/
manager.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { IIterator, iter } from '@lumino/algorithm';
import { Poll } from '@lumino/polling';
import { ISignal, Signal } from '@lumino/signaling';
import { ServerConnection } from '..';
import * as Terminal from './terminal';
import { BaseManager } from '../basemanager';
import {
isAvailable,
startNew,
shutdownTerminal,
listRunning
} from './restapi';
import { TerminalConnection } from './default';
/**
* A terminal session manager.
*/
export class TerminalManager extends BaseManager implements Terminal.IManager {
/**
* Construct a new terminal manager.
*/
constructor(options: TerminalManager.IOptions = {}) {
super(options);
// Check if terminals are available
if (!this.isAvailable()) {
this._ready = Promise.reject('Terminals unavailable');
this._ready.catch(_ => undefined);
return;
}
// Start polling with exponential backoff.
this._pollModels = new Poll({
auto: false,
factory: () => this.requestRunning(),
frequency: {
interval: 10 * 1000,
backoff: true,
max: 300 * 1000
},
name: `@jupyterlab/services:TerminalManager#models`,
standby: options.standby ?? 'when-hidden'
});
// Initialize internal data.
this._ready = (async () => {
await this._pollModels.start();
await this._pollModels.tick;
this._isReady = true;
})();
}
/**
* The server settings of the manager.
*/
readonly serverSettings: ServerConnection.ISettings;
/**
* Test whether the manager is ready.
*/
get isReady(): boolean {
return this._isReady;
}
/**
* A promise that fulfills when the manager is ready.
*/
get ready(): Promise<void> {
return this._ready;
}
/**
* A signal emitted when the running terminals change.
*/
get runningChanged(): ISignal<this, Terminal.IModel[]> {
return this._runningChanged;
}
/**
* A signal emitted when there is a connection failure.
*/
get connectionFailure(): ISignal<this, Error> {
return this._connectionFailure;
}
/**
* Dispose of the resources used by the manager.
*/
dispose(): void {
if (this.isDisposed) {
return;
}
this._names.length = 0;
this._terminalConnections.forEach(x => x.dispose());
this._pollModels.dispose();
super.dispose();
}
/**
* Whether the terminal service is available.
*/
isAvailable(): boolean {
return isAvailable();
}
/*
* Connect to a running terminal.
*
* @param name - The name of the target terminal.
*
* @param options - The options used to connect to the terminal.
*
* @returns A promise that resolves to the new terminal connection instance.
*
* #### Notes
* The manager `serverSettings` will be used.
*/
connectTo(
options: Omit<Terminal.ITerminalConnection.IOptions, 'serverSettings'>
): Terminal.ITerminalConnection {
const terminalConnection = new TerminalConnection({
...options,
serverSettings: this.serverSettings
});
this._onStarted(terminalConnection);
if (!this._names.includes(options.model.name)) {
// We trust the user to connect to an existing session, but we verify
// asynchronously.
void this.refreshRunning().catch(() => {
/* no-op */
});
}
return terminalConnection;
}
/**
* Create an iterator over the most recent running terminals.
*
* @returns A new iterator over the running terminals.
*/
running(): IIterator<Terminal.IModel> {
return iter(this._models);
}
/**
* Force a refresh of the running terminals.
*
* @returns A promise that with the list of running terminals.
*
* #### Notes
* This is intended to be called only in response to a user action,
* since the manager maintains its internal state.
*/
async refreshRunning(): Promise<void> {
await this._pollModels.refresh();
await this._pollModels.tick;
}
/**
* Create a new terminal session.
*
* @returns A promise that resolves with the terminal instance.
*
* #### Notes
* The manager `serverSettings` will be used unless overridden in the
* options.
*/
async startNew(): Promise<Terminal.ITerminalConnection> {
const model = await startNew(this.serverSettings);
await this.refreshRunning();
return this.connectTo({ model });
}
/**
* Shut down a terminal session by name.
*/
async shutdown(name: string): Promise<void> {
await shutdownTerminal(name, this.serverSettings);
await this.refreshRunning();
}
/**
* Shut down all terminal sessions.
*
* @returns A promise that resolves when all of the sessions are shut down.
*/
async shutdownAll(): Promise<void> {
// Update the list of models to make sure our list is current.
await this.refreshRunning();
// Shut down all models.
await Promise.all(
this._names.map(name => shutdownTerminal(name, this.serverSettings))
);
// Update the list of models to clear out our state.
await this.refreshRunning();
}
/**
* Execute a request to the server to poll running terminals and update state.
*/
protected async requestRunning(): Promise<void> {
let models: Terminal.IModel[];
try {
models = await listRunning(this.serverSettings);
} catch (err) {
// Check for a network error, or a 503 error, which is returned
// by a JupyterHub when a server is shut down.
if (
err instanceof ServerConnection.NetworkError ||
err.response?.status === 503
) {
this._connectionFailure.emit(err);
}
throw err;
}
if (this.isDisposed) {
return;
}
const names = models.map(({ name }) => name).sort();
if (names === this._names) {
// Identical models list, so just return
return;
}
this._names = names;
this._terminalConnections.forEach(tc => {
if (!names.includes(tc.name)) {
tc.dispose();
}
});
this._runningChanged.emit(this._models);
}
/**
* Handle a session starting.
*/
private _onStarted(terminalConnection: Terminal.ITerminalConnection): void {
this._terminalConnections.add(terminalConnection);
terminalConnection.disposed.connect(this._onDisposed, this);
}
/**
* Handle a session terminating.
*/
private _onDisposed(terminalConnection: Terminal.ITerminalConnection): void {
this._terminalConnections.delete(terminalConnection);
// Update the running models to make sure we reflect the server state
void this.refreshRunning().catch(() => {
/* no-op */
});
}
private _isReady = false;
// As an optimization, we unwrap the models to just store the names.
private _names: string[] = [];
private get _models(): Terminal.IModel[] {
return this._names.map(name => {
return { name };
});
}
private _pollModels: Poll;
private _terminalConnections = new Set<Terminal.ITerminalConnection>();
private _ready: Promise<void>;
private _runningChanged = new Signal<this, Terminal.IModel[]>(this);
private _connectionFailure = new Signal<this, Error>(this);
}
/**
* The namespace for TerminalManager statics.
*/
export namespace TerminalManager {
/**
* The options used to initialize a terminal manager.
*/
export interface IOptions extends BaseManager.IOptions {
/**
* When the manager stops polling the API. Defaults to `when-hidden`.
*/
standby?: Poll.Standby | (() => boolean | Poll.Standby);
}
}