-
Notifications
You must be signed in to change notification settings - Fork 291
/
background.ts
822 lines (695 loc) · 25.5 KB
/
background.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
import path from 'path';
import os from 'os';
import util from 'util';
import { URL } from 'url';
import Electron from 'electron';
import _ from 'lodash';
import mainEvents from '@/main/mainEvents';
import { getImageProcessor } from '@/k8s-engine/images/imageFactory';
import { ImageProcessor } from '@/k8s-engine/images/imageProcessor';
import { ImageEventHandler } from '@/main/imageEvents';
import * as settings from '@/config/settings';
import * as window from '@/window';
import { RecursivePartial } from '@/utils/typeUtils';
import { closeDashboard, openDashboard } from '@/window/dashboard';
import * as K8s from '@/k8s-engine/k8s';
import WSLBackend from '@/k8s-engine/wsl';
import Logging, { setLogLevel } from '@/utils/logging';
import * as childProcess from '@/utils/childProcess';
import Latch from '@/utils/latch';
import paths from '@/utils/paths';
import getCommandLineArgs from '@/utils/commandLine';
import { CommandWorkerInterface, HttpCommandServer } from '@/main/commandServer/httpCommandServer';
import setupNetworking from '@/main/networking';
import setupUpdate from '@/main/update';
import setupTray from '@/main/tray';
import buildApplicationMenu from '@/main/mainmenu';
import { Steve } from '@/k8s-engine/steve';
import SettingsValidator from '@/main/commandServer/settingsValidator';
import { getPathManagerFor, PathManagementStrategy, PathManager } from '@/integrations/pathManager';
import { IntegrationManager, getIntegrationManager } from '@/integrations/integrationManager';
import { removeLegacySymlinks, PermissionError } from '@/integrations/legacy';
Electron.app.setName('Rancher Desktop');
Electron.app.setPath('cache', paths.cache);
Electron.app.setAppLogsPath(paths.logs);
const console = Logging.background;
const k8smanager = newK8sManager();
let cfg: settings.Settings;
let gone = false; // when true indicates app is shutting down
let imageEventHandler: ImageEventHandler|null = null;
let currentContainerEngine = settings.ContainerEngine.NONE;
let currentImageProcessor: ImageProcessor | null = null;
let enabledK8s: boolean;
let pathManager: PathManager;
const integrationManager: IntegrationManager = getIntegrationManager();
let noModalDialogs = false;
/**
* pendingRestart is needed because with the CLI it's possible to change the state of the
* system without using the UI. This can push the system out of sync, for example setting
* kubernetes-enabled=true while it's disabled. Normally the code restart the system
* when processing the SET command, but if the backend is currently starting up or shutting down,
* we have to wait for it to finish. This module gets a `state-changed` event when that happens,
* and if this flag is true, a new restart can be triggered.
*/
let pendingRestart = false;
// Latch that is set when the app:// protocol handler has been registered.
// This is used to ensure that we don't attempt to open the window before we've
// done that, when the user attempts to open a second instance of the window.
const protocolRegistered = Latch();
let httpCommandServer: HttpCommandServer|null = null;
if (!Electron.app.requestSingleInstanceLock()) {
gone = true;
process.exit(201);
}
// Scheme must be registered before the app is ready
Electron.protocol.registerSchemesAsPrivileged([
{ scheme: 'app', privileges: { secure: true, standard: true } },
]);
process.on('unhandledRejection', (reason: any, promise: any) => {
if (reason.code === 'ECONNREFUSED' && reason.port === cfg.kubernetes.port) {
// Do nothing: a connection to the kubernetes server was broken
} else {
console.error('UnhandledRejectionWarning:', reason);
}
});
// takes care of any propagation of settings we want to do
// when settings change
mainEvents.on('settings-update', async(newSettings) => {
if (newSettings.debug) {
setLogLevel('debug');
} else {
setLogLevel('info');
}
k8smanager.debug = newSettings.debug;
if (pathManager.strategy !== newSettings.pathManagementStrategy) {
await pathManager.remove();
pathManager = getPathManagerFor(newSettings.pathManagementStrategy);
await pathManager.enforce();
}
});
Electron.app.whenReady().then(async() => {
try {
const commandLineArgs = getCommandLineArgs();
httpCommandServer = new HttpCommandServer(new BackgroundCommandWorker());
await httpCommandServer.init();
await setupNetworking();
cfg = settings.load();
if (commandLineArgs.length) {
try {
let transientConfig: settings.TransientSettings;
// Note that transientConfig and the returned cfg are aliases for
// the two global objects defined in `settings`.
[transientConfig, cfg] = settings.updateFromCommandLine(cfg, commandLineArgs);
k8smanager.noModalDialogs = noModalDialogs = transientConfig.noModalDialogs;
} catch (err) {
console.log(`Failed to update command from argument ${ commandLineArgs } `, err);
}
}
pathManager = getPathManagerFor(cfg.pathManagementStrategy);
mainEvents.emit('settings-update', cfg);
// Set up the updater; we may need to quit the app if an update is already
// queued.
if (await setupUpdate(cfg.updater, true)) {
gone = true;
// The update code will trigger a restart; don't do it here, as it may not
// be ready yet.
console.log('Will apply update; skipping startup.');
return;
}
installDevtools();
setupProtocolHandler();
await integrationManager.enforce();
await doFirstRun();
if (gone) {
console.log('User triggered quit during first-run');
return;
}
buildApplicationMenu();
Electron.app.setAboutPanelOptions({
copyright: 'Copyright © 2021 SUSE LLC', // TODO: Update this to 2021-... as dev progresses
applicationName: Electron.app.name,
applicationVersion: `Version ${ await getVersion() }`,
iconPath: path.join(paths.resources, 'icons', 'logo-square-512.png'),
});
setupTray();
window.openPreferences();
// Path management strategy will need to be selected after an upgrade
if (!os.platform().startsWith('win') && cfg.pathManagementStrategy === PathManagementStrategy.NotSet) {
if (!noModalDialogs) {
await window.openPathUpdate();
} else {
cfg.pathManagementStrategy = PathManagementStrategy.RcFiles;
}
}
if (os.platform() === 'linux' || os.platform() === 'darwin') {
try {
await removeLegacySymlinks(paths.oldIntegration);
} catch (error) {
if (error instanceof PermissionError) {
await window.openLegacyIntegrations();
} else {
throw error;
}
}
}
await startBackend(cfg);
} catch (ex) {
console.error('Error starting up:', ex);
gone = true;
Electron.app.quit();
}
});
function installDevtools() {
if (Electron.app.isPackaged) {
return;
}
const { default: installExtension, VUEJS_DEVTOOLS } = require('electron-devtools-installer');
// No need to wait for it to complete.
installExtension(VUEJS_DEVTOOLS);
}
async function doFirstRun() {
if (!settings.isFirstRun()) {
return;
}
await window.openFirstRun();
}
/**
* Check if there are any reasons that would mean it makes no sense to continue
* starting the app. Should be invoked before attempting to start the backend.
*/
async function checkBackendValid() {
const invalidReason = await k8smanager.getBackendInvalidReason();
if (invalidReason) {
await handleFailure(invalidReason);
gone = true;
Electron.app.quit();
}
}
/**
* Set up protocol handler for app://
* This is needed because in packaged builds we'll not be allowed to access
* file:// URLs for our resources.
*/
function setupProtocolHandler() {
Electron.protocol.registerFileProtocol('app', (request, callback) => {
let relPath = (new URL(request.url)).pathname;
relPath = decodeURI(relPath); // Needed in case URL contains spaces
// Default to the path for development mode, running out of the source tree.
const result: Electron.ProtocolResponse = { path: path.join(Electron.app.getAppPath(), 'dist', 'app', relPath) };
const mimeTypeMap: Record<string, string> = {
css: 'text/css',
html: 'text/html',
js: 'text/javascript',
json: 'application/json',
png: 'image/png',
svg: 'image/svg+xml',
};
const mimeType = mimeTypeMap[path.extname(relPath).toLowerCase().replace(/^\./, '')];
if (mimeType !== undefined) {
result.mimeType = mimeType;
}
callback(result);
});
protocolRegistered.resolve();
}
/**
* Start the Kubernetes backend.
*
* @precondition cfg.kubernetes.version is set.
*/
async function startBackend(cfg: settings.Settings) {
await checkBackendValid();
try {
await startK8sManager();
} catch (err) {
handleFailure(err);
}
}
async function startK8sManager() {
const changedContainerEngine = currentContainerEngine !== cfg.kubernetes.containerEngine;
currentContainerEngine = cfg.kubernetes.containerEngine;
enabledK8s = cfg.kubernetes.enabled;
if (changedContainerEngine) {
setupImageProcessor();
}
try {
await k8smanager.start(cfg.kubernetes);
} catch (err) {
handleFailure(err);
}
}
/**
* We need to deactivate the current imageProcessor, if there is one,
* so it stops processing events,
* and also tell the image event-handler about the new image processor.
*
* Some container engines support namespaces, so we need to specify the current namespace
* as well. It should be done here so that the consumers of the `current-engine-changed`
* event will operate in an environment where the image-processor knows the current namespace.
*/
function setupImageProcessor() {
const imageProcessor = getImageProcessor(cfg.kubernetes.containerEngine, k8smanager);
currentImageProcessor?.deactivate();
if (!imageEventHandler) {
imageEventHandler = new ImageEventHandler(imageProcessor);
}
imageEventHandler.imageProcessor = imageProcessor;
currentImageProcessor = imageProcessor;
currentImageProcessor.activate();
currentImageProcessor.namespace = cfg.images.namespace;
window.send('k8s-current-engine', cfg.kubernetes.containerEngine);
}
Electron.app.on('second-instance', async() => {
// Someone tried to run another instance of Rancher Desktop,
// reveal and focus this window instead.
await protocolRegistered;
window.openPreferences();
});
interface K8sError {
errCode: number | string
}
function isK8sError(object: any): object is K8sError {
return 'errCode' in object;
}
Electron.app.on('before-quit', async(event) => {
httpCommandServer?.closeServer();
if (gone) {
return;
}
event.preventDefault();
try {
await k8smanager?.stop();
console.log(`2: Child exited cleanly.`);
} catch (ex) {
if (isK8sError(ex)) {
console.log(`2: Child exited with code ${ ex.errCode }`);
}
handleFailure(ex);
} finally {
gone = true;
if (process.env['APPIMAGE']) {
await integrationManager.removeSymlinksOnly();
}
Electron.app.quit();
}
});
Electron.app.on('window-all-closed', () => {
// On macOS, hide the dock icon.
Electron.app.dock?.hide();
// On windows and macOS platforms, we only quit via the notification tray / menu bar.
// On Linux we close the application since not all distros support tray menu/icons
if (os.platform() === 'linux' && !settings.isFirstRun()) {
Electron.app.quit();
}
});
Electron.app.on('activate', async() => {
// On macOS it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
await protocolRegistered;
window.openPreferences();
});
Electron.ipcMain.on('settings-read', (event) => {
event.reply('settings-read', cfg);
});
// This is the synchronous version of the above; we still use
// ipcRenderer.sendSync in some places, so it's required for now.
Electron.ipcMain.on('settings-read', (event) => {
console.debug(`event settings-read in main: ${ event }`);
event.returnValue = cfg;
});
Electron.ipcMain.on('images-namespaces-read', (event) => {
if ([K8s.State.STARTED, K8s.State.DISABLED].includes(k8smanager.state)) {
currentImageProcessor?.relayNamespaces();
}
});
Electron.ipcMain.on('dashboard-open', () => {
openDashboard();
});
Electron.ipcMain.on('dashboard-close', () => {
closeDashboard();
});
function writeSettings(arg: RecursivePartial<settings.Settings>) {
_.merge(cfg, arg);
settings.save(cfg);
mainEvents.emit('settings-update', cfg);
Electron.ipcMain.emit('k8s-restart-required');
}
Electron.ipcMain.handle('settings-write', (event, arg) => {
console.debug(`event settings-write in main: ${ event }, ${ arg }`);
writeSettings(arg);
// dashboard requires kubernetes, so we want to close it if kubernetes is disabled
if (arg?.kubernetes?.enabled === false) {
closeDashboard();
}
event.sender.sendToFrame(event.frameId, 'settings-update', cfg);
});
mainEvents.on('settings-write', writeSettings);
Electron.ipcMain.on('k8s-state', (event) => {
event.returnValue = k8smanager.state;
});
Electron.ipcMain.on('k8s-current-engine', () => {
window.send('k8s-current-engine', currentContainerEngine);
});
Electron.ipcMain.on('k8s-current-port', () => {
window.send('k8s-current-port', k8smanager.desiredPort);
});
Electron.ipcMain.on('k8s-reset', async(_, arg) => {
await doK8sReset(arg);
});
function backendIsBusy() {
return [K8s.State.STARTING, K8s.State.STOPPING].includes(k8smanager.state);
}
async function doK8sReset(arg: 'fast' | 'wipe' | 'fullRestart'): Promise<void> {
// If not in a place to restart than skip it
if (backendIsBusy()) {
console.log(`Skipping reset, invalid state ${ k8smanager.state }`);
return;
}
try {
switch (arg) {
case 'fast':
await k8smanager.reset(cfg.kubernetes);
break;
case 'fullRestart':
await k8smanager.stop();
console.log(`Stopped Kubernetes backend cleanly.`);
await startK8sManager();
break;
case 'wipe':
await k8smanager.stop();
console.log(`Stopped Kubernetes backend cleanly.`);
console.log('Deleting VM to reset...');
await k8smanager.del();
console.log(`Deleted VM to reset exited cleanly.`);
await startK8sManager();
break;
}
} catch (ex) {
handleFailure(ex);
}
}
async function doK8sRestartRequired() {
const restartRequired = (await k8smanager?.requiresRestartReasons()) ?? {};
window.send('k8s-restart-required', restartRequired);
}
Electron.ipcMain.on('k8s-restart-required', async() => {
await doK8sRestartRequired();
});
Electron.ipcMain.on('k8s-restart', async() => {
if (cfg.kubernetes.port !== k8smanager.desiredPort) {
// On port change, we need to wipe the VM.
return doK8sReset('wipe');
} else if (cfg.kubernetes.containerEngine !== currentContainerEngine || cfg.kubernetes.enabled !== enabledK8s) {
return doK8sReset('fullRestart');
}
try {
switch (k8smanager.state) {
case K8s.State.STOPPED:
case K8s.State.STARTED:
case K8s.State.DISABLED:
// Calling start() will restart the backend, possible switching versions
// as a side-effect.
await startK8sManager();
break;
}
} catch (ex) {
handleFailure(ex);
}
});
Electron.ipcMain.on('k8s-versions', async() => {
window.send('k8s-versions', await k8smanager.availableVersions);
});
Electron.ipcMain.on('k8s-progress', () => {
window.send('k8s-progress', k8smanager.progress);
});
Electron.ipcMain.handle('service-fetch', (event, namespace) => {
return k8smanager.listServices(namespace);
});
Electron.ipcMain.handle('service-forward', async(event, service, state) => {
const forwarder = k8smanager?.portForwarder;
if (forwarder) {
if (state) {
await forwarder.forwardPort(service.namespace, service.name, service.port);
} else {
await forwarder.cancelForward(service.namespace, service.name, service.port);
}
}
});
Electron.ipcMain.on('k8s-integrations', async(event) => {
if (k8smanager instanceof WSLBackend) {
event.reply('k8s-integrations', await k8smanager?.listIntegrations());
}
});
Electron.ipcMain.on('k8s-integration-set', async(event, name, newState) => {
if (k8smanager instanceof WSLBackend) {
console.log(`Setting k8s integration for ${ name } to ${ newState }`);
writeSettings({ kubernetes: { WSLIntegrations: { [name]: newState } } });
const currentState = await k8smanager.listIntegrations();
if (!(name in currentState) || currentState[name] === newState) {
event.reply('k8s-integrations', currentState);
return;
}
if (typeof currentState[name] === 'string') {
// There is an error, and we cannot set the integration
event.reply('k8s-integrations', currentState);
return;
}
const error = await k8smanager.setIntegration(name, newState);
if (error) {
currentState[name] = error;
event.reply('k8s-integrations', currentState);
} else {
event.reply('k8s-integrations', await k8smanager.listIntegrations());
}
}
});
/**
* Do a factory reset of the application. This will stop the currently running
* cluster (if any), and delete all of its data. This will also remove any
* rancher-desktop data, and restart the application.
*/
Electron.ipcMain.on('factory-reset', async() => {
await k8smanager.factoryReset();
await pathManager.remove();
await integrationManager.remove();
switch (os.platform()) {
case 'darwin':
// Unlink binaries
for (const name of ['docker', 'helm', 'kubectl', 'nerdctl']) {
Electron.ipcMain.emit('install-set', { reply: () => { } }, name, false);
}
break;
case 'win32':
// On Windows, we need to use a helper process in order to ensure we
// delete files in use. Of course, we can't wait for that process to
// return - the whole point is for us to not be running.
childProcess.spawn(path.join(paths.resources, 'win32', 'wsl-helper.exe'),
['factory-reset', `--wait-pid=${ process.pid }`, `--launch=${ process.argv0 }`],
{ detached: true, windowsHide: true });
Electron.app.quit();
return;
}
// Remove app settings
await settings.clear();
Electron.app.quit();
});
Electron.ipcMain.on('troubleshooting/show-logs', async(event) => {
const error = await Electron.shell.openPath(paths.logs);
if (error) {
const browserWindow = Electron.BrowserWindow.fromWebContents(event.sender);
const options = {
message: error,
type: 'error',
title: `Error opening logs`,
detail: `Please manually open ${ paths.logs }`,
};
console.error(`Failed to open logs: ${ error }`);
if (browserWindow) {
await Electron.dialog.showMessageBox(browserWindow, options);
} else {
await Electron.dialog.showMessageBox(options);
}
}
});
Electron.ipcMain.on('get-app-version', async(event) => {
event.reply('get-app-version', await getVersion());
});
Electron.ipcMain.handle('show-message-box', (event, options: Electron.MessageBoxOptions): Promise<Electron.MessageBoxReturnValue> => {
return Electron.dialog.showMessageBox(options);
});
function getProductionVersion() {
try {
return Electron.app.getVersion();
} catch (err) {
console.log(`Can't get app version: ${ err }`);
return '?';
}
}
async function getDevVersion() {
try {
const { stdout } = await childProcess.spawnFile('git', ['describe', '--tags'], { stdio: ['ignore', 'pipe', 'inherit'] });
return stdout.trim();
} catch (err) {
console.log(`Can't get app version: ${ err }`);
return '?';
}
}
async function getVersion() {
return process.env.NODE_ENV === 'production' ? getProductionVersion() : await getDevVersion();
}
async function showErrorDialog(title: string, message: string, fatal?: boolean): Promise<void> {
await Electron.dialog.showErrorBox(title, message);
if (fatal) {
process.exit(0);
}
}
async function handleFailure(payload: any) {
let titlePart = 'Error Starting Kubernetes';
let message = 'There was an unknown error starting Kubernetes';
let secondaryMessage = '';
if (payload instanceof K8s.KubernetesError) {
({ name: titlePart, message } = payload);
} else if (payload instanceof Error) {
secondaryMessage = payload.toString();
} else if (typeof payload === 'number') {
message = `Kubernetes was unable to start with the following exit code: ${ payload }`;
} else if ('errorCode' in payload) {
message = payload.message || message;
titlePart = payload.context || titlePart;
}
console.log(`Kubernetes was unable to start:`, payload);
try {
// getFailureDetails is going to read from existing log files.
// Wait 1 second before reading them to allow recent writes to appear in them.
await util.promisify(setTimeout)(1_000);
const failureDetails: K8s.FailureDetails = await k8smanager.getFailureDetails(payload);
if (failureDetails) {
if (noModalDialogs) {
console.log(titlePart);
console.log(secondaryMessage || message);
console.log(failureDetails);
gone = true;
Electron.app.quit();
} else {
await window.openKubernetesErrorMessageWindow(titlePart, secondaryMessage || message, failureDetails);
}
return;
}
} catch (e) {
console.log(`Failed to get failure details: `, e);
}
if (noModalDialogs) {
console.log(titlePart);
console.log(message);
gone = true;
Electron.app.quit();
} else {
showErrorDialog(titlePart, message, payload instanceof K8s.KubernetesError && payload.fatal).catch();
}
}
mainEvents.on('handle-failure', showErrorDialog);
function doFullRestart() {
doK8sReset('fullRestart').catch((err: any) => {
console.log(`Error restarting: ${ err }`);
});
}
function newK8sManager() {
const arch = (Electron.app.runningUnderARM64Translation || os.arch() === 'arm64') ? 'aarch64' : 'x86_64';
const mgr = K8s.factory(arch);
mgr.on('state-changed', (state: K8s.State) => {
mainEvents.emit('k8s-check-state', mgr);
window.send('k8s-check-state', state);
if ([K8s.State.STARTED, K8s.State.DISABLED].includes(state)) {
if (!cfg.kubernetes.version) {
writeSettings({ kubernetes: { version: mgr.version } });
}
currentImageProcessor?.relayNamespaces();
if (enabledK8s) {
Steve.getInstance().start();
}
}
if (state === K8s.State.STOPPING) {
Steve.getInstance().stop();
}
if (pendingRestart && !backendIsBusy()) {
pendingRestart = false;
// If we restart immediately the QEMU process in the VM doesn't always respond to a shutdown messages
setTimeout(doFullRestart, 2_000);
}
});
mgr.on('current-port-changed', (port: number) => {
window.send('k8s-current-port', port);
});
mgr.on('kim-builder-uninstalled', () => {
writeSettings({ kubernetes: { checkForExistingKimBuilder: false } });
});
mgr.on('service-changed', (services: K8s.ServiceEntry[]) => {
window.send('service-changed', services);
});
mgr.on('progress', () => {
window.send('k8s-progress', mgr.progress);
});
mgr.on('versions-updated', async() => {
window.send('k8s-versions', await mgr.availableVersions);
});
mgr.on('show-notification', (notificationOptions: Electron.NotificationConstructorOptions) => {
(new Electron.Notification(notificationOptions)).show();
});
return mgr;
}
/**
* Implement the methods the HttpCommandServer needs to service its requests.
* These methods do two things:
* 1. Verify the semantics of the parameters (the server just checks syntax).
* 2. Provide a thin wrapper over existing functionality in this module.
* Getters, on success, return status 200 and a string that may be JSON or simple.
* Setters, on success, return status 202, possibly with a human-readable status note.
* The `requestShutdown` method is a special case that never returns.
*/
class BackgroundCommandWorker implements CommandWorkerInterface {
protected k8sVersions: string[] = [];
protected settingsValidator = new SettingsValidator();
getSettings() {
return JSON.stringify(cfg, undefined, 2);
}
/**
* Check semantics of SET commands:
* - verify that setting names are recognized, and validate provided values
* - returns an array of two strings:
* 1. a description of the status of the request, if it was valid
* 2. a list of any errors in the request body.
* @param newSettings: a subset of the Settings object, containing the desired values
* @returns [{string} description of final state if no error, {string} error message]
*/
async updateSettings(newSettings: Record<string, any>): Promise<[string, string]> {
if (this.k8sVersions.length === 0) {
this.k8sVersions = (await k8smanager.availableVersions).map(entry => entry.version.version);
this.settingsValidator.k8sVersions = this.k8sVersions;
}
const [needToUpdate, errors] = this.settingsValidator.validateSettings(cfg, newSettings);
if (errors.length > 0) {
return ['', `errors in attempt to update settings:\n${ errors.join('\n') }`];
}
if (needToUpdate) {
writeSettings(newSettings);
// cfg is a global, and at this point newConfig has been merged into it :(
window.send('settings-update', cfg);
} else {
// Obviously if there are no settings to update, there's no need to restart.
return ['no changes necessary', ''];
}
if (!backendIsBusy()) {
pendingRestart = false;
setImmediate(doFullRestart);
return ['triggering a restart to apply changes', ''];
} else {
// Call doFullRestart once the UI is finished starting or stopping
pendingRestart = true;
return ['UI is currently busy, but will eventually restart to apply changes', ''];
}
}
async requestShutdown() {
await k8smanager.stop();
Electron.app.quit();
}
}