-
Notifications
You must be signed in to change notification settings - Fork 274
/
background.ts
1660 lines (1377 loc) · 52.2 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
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { spawn } from 'child_process';
import fs from 'fs';
import os from 'os';
import path from 'path';
import util from 'util';
import Electron, { MessageBoxOptions } from 'electron';
import _ from 'lodash';
import semver from 'semver';
import { State } from '@pkg/backend/backend';
import BackendHelper from '@pkg/backend/backendHelper';
import K8sFactory from '@pkg/backend/factory';
import { getImageProcessor } from '@pkg/backend/images/imageFactory';
import { ImageProcessor } from '@pkg/backend/images/imageProcessor';
import * as K8s from '@pkg/backend/k8s';
import { Steve } from '@pkg/backend/steve';
import { FatalCommandLineOptionError, LockedFieldError, updateFromCommandLine } from '@pkg/config/commandLineOptions';
import { Help } from '@pkg/config/help';
import * as settings from '@pkg/config/settings';
import * as settingsImpl from '@pkg/config/settingsImpl';
import { TransientSettings } from '@pkg/config/transientSettings';
import { IntegrationManager, getIntegrationManager } from '@pkg/integrations/integrationManager';
import { PathManagementStrategy, PathManager } from '@pkg/integrations/pathManager';
import { getPathManagerFor } from '@pkg/integrations/pathManagerImpl';
import { BackendState, CommandWorkerInterface, HttpCommandServer } from '@pkg/main/commandServer/httpCommandServer';
import SettingsValidator from '@pkg/main/commandServer/settingsValidator';
import { HttpCredentialHelperServer } from '@pkg/main/credentialServer/httpCredentialHelperServer';
import { DashboardServer } from '@pkg/main/dashboardServer';
import { DeploymentProfileError, readDeploymentProfiles } from '@pkg/main/deploymentProfiles';
import { DiagnosticsManager, DiagnosticsResultCollection } from '@pkg/main/diagnostics/diagnostics';
import { ExtensionErrorCode, isExtensionError } from '@pkg/main/extensions';
import { ImageEventHandler } from '@pkg/main/imageEvents';
import { getIpcMainProxy } from '@pkg/main/ipcMain';
import mainEvents from '@pkg/main/mainEvents';
import buildApplicationMenu from '@pkg/main/mainmenu';
import setupNetworking from '@pkg/main/networking';
import { Snapshots } from '@pkg/main/snapshots/snapshots';
import { Snapshot, SnapshotDialog } from '@pkg/main/snapshots/types';
import { Tray } from '@pkg/main/tray';
import setupUpdate from '@pkg/main/update';
import { spawnFile } from '@pkg/utils/childProcess';
import getCommandLineArgs from '@pkg/utils/commandLine';
import DockerDirManager from '@pkg/utils/dockerDirManager';
import { isDevEnv } from '@pkg/utils/environment';
import Logging, { clearLoggingDirectory, setLogLevel } from '@pkg/utils/logging';
import { fetchMacOsVersion, getMacOsVersion } from '@pkg/utils/osVersion';
import paths from '@pkg/utils/paths';
import { protocolsRegistered, setupProtocolHandlers } from '@pkg/utils/protocols';
import { executable } from '@pkg/utils/resources';
import { jsonStringifyWithWhiteSpace } from '@pkg/utils/stringify';
import { RecursivePartial, RecursiveReadonly } from '@pkg/utils/typeUtils';
import { getVersion } from '@pkg/utils/version';
import getWSLVersion from '@pkg/utils/wslVersion';
import * as window from '@pkg/window';
import { closeDashboard, openDashboard } from '@pkg/window/dashboard';
import { openPreferences, preferencesSetDirtyFlag } from '@pkg/window/preferences';
Electron.app.setPath('cache', paths.cache);
Electron.app.setAppLogsPath(paths.logs);
const console = Logging.background;
// Do an early check for debugging enabled via the environment variable so that
// we can turn on extra logging to troubleshoot startup issues.
if (settingsImpl.runInDebugMode(false)) {
setLogLevel('debug');
}
if (!Electron.app.requestSingleInstanceLock()) {
process.exit(201);
}
clearLoggingDirectory();
const SNAPSHOT_OPERATION = 'Snapshot operation in progress';
const ipcMainProxy = getIpcMainProxy(console);
const dockerDirManager = new DockerDirManager(path.join(os.homedir(), '.docker'));
const k8smanager = newK8sManager();
const diagnostics: DiagnosticsManager = new DiagnosticsManager();
let cfg: settings.Settings;
let firstRunDialogComplete = false;
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;
// Indicates whether the UI should be locked, settings changes should be disallowed
// and possibly other things should be disallowed. As of the time of writing,
// set to true when a snapshot is being created or restored.
let deploymentProfiles: settings.DeploymentProfileType = { defaults: {}, locked: {} };
/**
* pendingRestartContext 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 restarts 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 pendingRestartContext: CommandWorkerInterface.CommandContext | undefined;
let httpCommandServer: HttpCommandServer|null = null;
const httpCredentialHelperServer = new HttpCredentialHelperServer();
// 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);
}
});
Electron.app.on('second-instance', async() => {
await protocolsRegistered;
console.warn('A second instance was started');
if (firstRunDialogComplete) {
window.openMain();
}
});
// takes care of any propagation of settings we want to do
// when settings change
mainEvents.on('settings-update', async(newSettings) => {
console.log(`mainEvents settings-update: ${ JSON.stringify(newSettings) }`);
const runInDebugMode = settingsImpl.runInDebugMode(newSettings.application.debug);
if (runInDebugMode) {
setLogLevel('debug');
} else {
setLogLevel('info');
}
k8smanager.debug = runInDebugMode;
if (gone) {
console.debug('Suppressing settings-update because app is quitting');
return;
}
await setPathManager(newSettings.application.pathManagementStrategy);
await pathManager.enforce();
if (newSettings.application.hideNotificationIcon) {
Tray.getInstance(cfg).hide();
} else {
if (firstRunDialogComplete) {
Tray.getInstance(cfg).show();
}
mainEvents.emit('k8s-check-state', k8smanager);
}
await runRdctlSetup(newSettings);
window.send('preferences/changed');
});
mainEvents.handle('settings-fetch', () => {
return Promise.resolve(cfg);
});
Electron.protocol.registerSchemesAsPrivileged([{ scheme: 'app' }, {
scheme: 'x-rd-extension',
privileges: {
standard: true,
supportFetchAPI: true,
},
}]);
Electron.app.whenReady().then(async() => {
try {
const commandLineArgs = getCommandLineArgs();
// Normally `noModalDialogs` is set when we call `updateFromCommandLine(.., commandLineArgs)`
// But if there's an error either in that function, or before, we'll need to know if we should
// display the error in a modal-dialog or not. So check the current command-line arguments for that.
//
// It's very unlikely that a string option is set to this exact string though.
// `rdctl start --images.namespace --no-modal-dialogs`
// is syntactically correct, but unlikely (because why would someone create a
// containerd namespace called "--no-modal-dialogs"?
noModalDialogs = commandLineArgs.includes('--no-modal-dialogs');
setupProtocolHandlers();
// make sure we have the macOS version cached before calling getMacOsVersion()
if (os.platform() === 'darwin') {
await fetchMacOsVersion(console);
}
// Needs to happen before any file is written, otherwise that file
// could be owned by root, which will lead to future problems.
if (['linux', 'darwin'].includes(os.platform())) {
await checkForRootPrivs();
}
// Check for required OS versions and features
await checkPrerequisites();
DashboardServer.getInstance().init();
await setupNetworking();
try {
deploymentProfiles = await readDeploymentProfiles();
} catch (ex: any) {
if (ex instanceof DeploymentProfileError) {
await handleFailure(ex);
} else {
console.log(`Got an unexpected deployment profile error ${ ex }`, ex);
}
throw ex;
}
try {
cfg = settingsImpl.load(deploymentProfiles);
settingsImpl.updateLockedFields(deploymentProfiles.locked);
} catch (err: any) {
const titlePart = err.name || 'Failed to load settings';
const message = err.message || err.toString();
showErrorDialog(titlePart, message, true);
// showErrorDialog doesn't exit immediately; avoid running the rest of the function
return;
}
try {
// The profile loader did rudimentary type-validation on profiles, but the validator checks for things
// like invalid strings for application.pathManagementStrategy.
validateEarlySettings(settings.defaultSettings, deploymentProfiles.defaults, {});
validateEarlySettings(settings.defaultSettings, deploymentProfiles.locked, {});
if (commandLineArgs.length) {
cfg = updateFromCommandLine(cfg, settingsImpl.getLockedSettings(), commandLineArgs);
k8smanager.noModalDialogs = noModalDialogs = TransientSettings.value.noModalDialogs;
}
} catch (err: any) {
noModalDialogs = TransientSettings.value.noModalDialogs;
if (err instanceof LockedFieldError || err instanceof DeploymentProfileError || err instanceof FatalCommandLineOptionError) {
handleFailure(err).catch((err2: any) => {
console.log('Internal error trying to show a failure dialog: ', err2);
process.exit(2);
});
// Avoid running the rest of the `whenReady` handler after calling this handleFailure -- shutdown is imminent
return;
} else if (!noModalDialogs) {
showErrorDialog('Invalid command-line arguments', err.message, false);
}
console.log(`Failed to update command from argument ${ commandLineArgs.join(', ') }`, err);
}
httpCommandServer = new HttpCommandServer(new BackgroundCommandWorker());
await httpCommandServer.init();
await httpCredentialHelperServer.init();
await initUI();
await checkForBackendLock();
await setPathManager(cfg.application.pathManagementStrategy);
await integrationManager.enforce();
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.application.updater.enabled, 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;
}
try {
await dockerDirManager.ensureCredHelperConfigured();
} catch (ex: any) {
const errorTitle = 'Error configuring credential helper';
console.error(`${ errorTitle }:`, ex);
const title = ex.title ?? errorTitle;
const message = ex.message ?? ex.toString();
showErrorDialog(title, message, true);
}
diagnostics.runChecks().catch(console.error);
await startBackend();
} catch (ex: any) {
console.error(`Error starting up: ${ ex }`, ex.stack);
gone = true;
Electron.app.quit();
}
});
async function setPathManager(newStrategy: PathManagementStrategy) {
if (pathManager) {
if (pathManager.strategy === newStrategy) {
return;
}
await pathManager.remove();
}
pathManager = getPathManagerFor(newStrategy);
}
/**
* Reads the 'backend.lock' file and returns its contents if it exists.
* Returns null if the file doesn't exist.
*/
async function readBackendLockFile(): Promise<{ action: string } | null> {
try {
const fileContents = await fs.promises.readFile(
path.join(paths.appHome, 'backend.lock'),
'utf-8',
);
return JSON.parse(fileContents);
} catch (ex: any) {
if (ex.code === 'ENOENT') {
return null;
} else {
throw ex;
}
}
}
/**
* Emits the 'backend-locked-update' event.
*/
function updateBackendLockState(backendIsLocked: string, action?: string): void {
mainEvents.emit('backend-locked-update', backendIsLocked, action);
}
/**
* Checks for the existence of the 'backend.lock' file and emits the
* 'backend-locked-update' event to notify listeners about the current lock
* status.
*/
async function doesBackendLockExist(): Promise<boolean> {
let backendIsLocked = '';
const lockFileContents = await readBackendLockFile();
if (lockFileContents !== null) {
backendIsLocked = SNAPSHOT_OPERATION;
updateBackendLockState(backendIsLocked, lockFileContents.action);
} else {
backendIsLocked = '';
updateBackendLockState(backendIsLocked);
}
return !!backendIsLocked;
}
/**
* Blocks execution until the 'backend.lock' file is no longer present.
*/
async function checkForBackendLock() {
// Perform an initial check for a lock file
if (!await doesBackendLockExist()) {
return;
}
const startTime = Date.now();
// Check every second if a lock file exists
while (await doesBackendLockExist()) {
// Notify when a lock file has existed for more than 5 minutes
if (Date.now() - startTime >= 300_000) {
mainEvents.emit(
'dialog-info',
{
dialog: 'SnapshotsDialog',
infoKey: 'snapshots.info.lock.info',
},
);
}
await util.promisify(setTimeout)(1_000);
}
}
async function initUI() {
await doFirstRunDialog();
if (gone) {
console.log('User triggered quit during first-run');
return;
}
buildApplicationMenu();
Electron.app.setAboutPanelOptions({
// TODO: Update this to 2021-... as dev progresses
// also needs to be updated in electron-builder.yml
copyright: 'Copyright © 2021-2023 SUSE LLC',
applicationName: `${ Electron.app.name } by SUSE`,
applicationVersion: `Version ${ await getVersion() }`,
iconPath: path.join(paths.resources, 'icons', 'logo-square-512.png'),
});
if (!cfg.application.hideNotificationIcon) {
Tray.getInstance(cfg).show();
}
if (!cfg.application.startInBackground) {
window.openMain();
} else if (Electron.app.dock) {
Electron.app.dock.hide();
}
}
async function doFirstRunDialog() {
if (!noModalDialogs && settingsImpl.firstRunDialogNeeded()) {
await window.openFirstRunDialog();
}
firstRunDialogComplete = true;
}
async function checkForRootPrivs() {
if (isRoot()) {
await window.openDenyRootDialog();
gone = true;
Electron.app.quit();
}
}
async function checkPrerequisites() {
const osPlatform = os.platform();
let messageId: window.reqMessageId = 'ok';
let args: any[] = [];
switch (osPlatform) {
case 'win32': {
// Required: Windows 10-1909(build 18363) or newer
const winRel = os.release().split('.');
if (Number(winRel[0]) < 10 || (Number(winRel[0]) === 10 && Number(winRel[2]) < 18363)) {
messageId = 'win32-release';
} else {
try {
const version = await getWSLVersion();
if (version.outdated_kernel) {
messageId = 'win32-kernel';
args = [version];
}
} catch (ex) {
console.error(`Failed to check WSL version, ignoring:`, ex);
}
}
break;
}
case 'linux': {
// Required: Nested virtualization enabled
const nestedFiles = [
'/sys/module/kvm_amd/parameters/nested',
'/sys/module/kvm_intel/parameters/nested'];
messageId = 'linux-nested';
for (const nestedFile of nestedFiles) {
try {
const data = await fs.promises.readFile(nestedFile, { encoding: 'utf8' });
if (data && (data.toLowerCase()[0] === 'y' || data[0] === '1')) {
messageId = 'ok';
break;
}
} catch {}
}
break;
}
case 'darwin': {
// Required: macOS-10.15(Darwin-19) or newer
if (semver.gt('10.15.0', getMacOsVersion())) {
messageId = 'macOS-release';
}
break;
}
}
if (messageId !== 'ok') {
await window.openUnmetPrerequisitesDialog(messageId, ...args);
gone = true;
Electron.app.quit();
}
}
/**
* 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();
}
}
/**
* Start the Kubernetes backend.
*
* @precondition cfg.kubernetes.version is set.
*/
async function startBackend() {
await checkBackendValid();
// A string describing why we're ignoring the request.
const ignoreReason = {
[K8s.State.STOPPED]: undefined, // Normal start is accepted.
[K8s.State.STARTING]: 'Ignoring duplicate attempt to start backend while starting backend.',
[K8s.State.STARTED]: 'Ignoring attempt to start already-started backend.',
[K8s.State.STOPPING]: 'Ignoring attempt to start backend while stopping.',
[K8s.State.ERROR]: undefined, // Attempting start from error state is fine.
[K8s.State.DISABLED]: 'Ignoring attempt to start already-started backend (Kubernetes disabled).',
}[k8smanager.state];
if (ignoreReason) {
console.debug(ignoreReason);
return;
}
try {
await startK8sManager();
} catch (err) {
handleFailure(err);
} finally {
window.send('extensions/changed');
}
}
/**
* Start the backend.
*
* @note Callers are responsible for handling errors thrown from here.
*/
async function startK8sManager() {
const changedContainerEngine = currentContainerEngine !== cfg.containerEngine.name;
currentContainerEngine = cfg.containerEngine.name;
enabledK8s = cfg.kubernetes.enabled;
if (changedContainerEngine) {
setupImageProcessor();
}
await k8smanager.start(cfg);
const { initializeExtensionManager } = await import('@pkg/main/extensions/manager');
await initializeExtensionManager(k8smanager.containerEngineClient, cfg);
window.send('extensions/changed');
}
/**
* 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.containerEngine.name, k8smanager.executor);
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.containerEngine.name);
}
interface K8sError {
errCode: number | string
}
function isK8sError(object: any): object is K8sError {
return 'errCode' in object;
}
Electron.app.on('before-quit', async(event) => {
if (gone) {
mainEvents.emit('quit');
return;
}
event.preventDefault();
httpCommandServer?.closeServer();
httpCredentialHelperServer.closeServer();
try {
await k8smanager?.stop();
try {
await mainEvents.invoke('shutdown-integrations');
} catch (ex) {
if (!`${ ex }`.includes('No handlers registered')) {
throw ex;
}
}
console.log(`2: Child exited cleanly.`);
} catch (ex: any) {
console.log(`2: Child exited with code ${ isK8sError(ex) ? ex.errCode : (ex.errCode ?? '<unknown>') }`);
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();
});
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.
if (!firstRunDialogComplete) {
console.log('Still processing the first-run dialog: not opening main window');
return;
}
await protocolsRegistered;
window.openMain();
});
mainEvents.on('backend-locked-update', (backendIsLocked, action) => {
if (backendIsLocked) {
window.send('backend-locked', action);
} else {
window.send('backend-unlocked');
}
});
mainEvents.on('backend-locked-check', async() => {
await doesBackendLockExist();
});
ipcMainProxy.on('backend-state-check', async() => {
await doesBackendLockExist();
});
ipcMainProxy.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.
ipcMainProxy.on('settings-read', (event) => {
console.debug(`event settings-read in main: ${ JSON.stringify(cfg) }`);
event.returnValue = cfg;
});
ipcMainProxy.on('images-namespaces-read', (event) => {
if ([K8s.State.STARTED, K8s.State.DISABLED].includes(k8smanager.state)) {
currentImageProcessor?.relayNamespaces();
}
});
ipcMainProxy.on('dashboard-open', () => {
openDashboard();
});
ipcMainProxy.on('dashboard-close', () => {
closeDashboard();
});
ipcMainProxy.on('preferences-open', () => {
openPreferences();
});
ipcMainProxy.on('preferences-close', () => {
window.getWindow('preferences')?.close();
});
ipcMainProxy.on('preferences-set-dirty', (_event, dirtyFlag) => {
preferencesSetDirtyFlag(dirtyFlag);
});
ipcMainProxy.on('get-debugging-statuses', () => {
window.send('is-debugging', settingsImpl.runInDebugMode(cfg.application.debug));
window.send('always-debugging', settingsImpl.runInDebugMode(false));
});
function writeSettings(arg: RecursivePartial<RecursiveReadonly<settings.Settings>>) {
settingsImpl.save(settingsImpl.merge(cfg, arg));
mainEvents.emit('settings-update', cfg);
}
ipcMainProxy.handle('settings-write', (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);
mainEvents.on('extensions/ui/uninstall', (id) => {
window.send('ok:extensions/uninstall', id);
});
mainEvents.on('dialog-info', (args) => {
window.getWindow(args.dialog)?.webContents.send('dialog/info', args);
});
ipcMainProxy.on('extensions/open', (_event, id, path) => {
window.openExtension(id, path);
});
ipcMainProxy.on('extensions/close', () => {
window.closeExtension();
});
ipcMainProxy.handle('transient-settings-fetch', () => {
return Promise.resolve(TransientSettings.value);
});
ipcMainProxy.handle('transient-settings-update', (event, arg) => {
TransientSettings.update(arg);
});
ipcMainProxy.on('k8s-state', (event) => {
event.returnValue = k8smanager.state;
});
ipcMainProxy.on('k8s-current-engine', () => {
window.send('k8s-current-engine', currentContainerEngine);
});
ipcMainProxy.on('k8s-current-port', () => {
window.send('k8s-current-port', k8smanager.kubeBackend.desiredPort);
});
ipcMainProxy.on('k8s-reset', async(_, arg) => {
await doK8sReset(arg, { interactive: true });
});
ipcMainProxy.handle('api-get-credentials', () => mainEvents.invoke('api-get-credentials'));
ipcMainProxy.handle('get-locked-fields', () => settingsImpl.getLockedSettings());
function backendIsBusy() {
return [K8s.State.STARTING, K8s.State.STOPPING].includes(k8smanager.state);
}
async function doK8sReset(arg: 'fast' | 'wipe' | 'fullRestart', context: CommandWorkerInterface.CommandContext): 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);
break;
case 'fullRestart':
await k8smanager.stop();
console.log(`Stopped Kubernetes backend cleanly.`);
await startK8sManager();
break;
case 'wipe':
console.log('Deleting VM to reset...');
await k8smanager.del();
console.log(`Deleted VM to reset exited cleanly.`);
await startK8sManager();
break;
}
} catch (ex) {
if (context.interactive) {
handleFailure(ex);
} else {
console.error(ex);
}
}
}
ipcMainProxy.on('k8s-restart', async() => {
if (cfg.kubernetes.port !== k8smanager.kubeBackend.desiredPort) {
// On port change, we need to wipe the VM.
return doK8sReset('wipe', { interactive: true });
} else if (cfg.containerEngine.name !== currentContainerEngine || cfg.kubernetes.enabled !== enabledK8s) {
return doK8sReset('fullRestart', { interactive: true });
}
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);
}
});
ipcMainProxy.on('k8s-versions', async() => {
try {
const versions = await k8smanager.kubeBackend.availableVersions;
const cachedOnly = await k8smanager.kubeBackend.cachedVersionsOnly();
window.send('k8s-versions', versions.map(v => v.versionEntry), cachedOnly);
} catch (ex) {
console.error(`Error handling k8s-versions: ${ ex }`);
window.send('k8s-versions', [], true);
}
});
ipcMainProxy.on('k8s-progress', () => {
window.send('k8s-progress', k8smanager.progress);
});
ipcMainProxy.handle('k8s-progress', () => {
return k8smanager.progress;
});
ipcMainProxy.handle('service-fetch', (_, namespace) => {
return k8smanager.kubeBackend.listServices(namespace);
});
ipcMainProxy.handle('service-forward', async(_, service, state) => {
const namespace = service.namespace ?? 'default';
if (state) {
const hostPort = service.listenPort ?? 0;
await doForwardPort(namespace, service.name, service.port, hostPort);
} else {
await doCancelForward(namespace, service.name, service.port);
}
});
async function doForwardPort(namespace: string, service: string, k8sPort: string | number, hostPort: number) {
return await k8smanager.kubeBackend.forwardPort(namespace, service, k8sPort, hostPort);
}
async function doCancelForward(namespace: string, service: string, k8sPort: string | number) {
return await k8smanager.kubeBackend.cancelForward(namespace, service, k8sPort);
}
ipcMainProxy.on('k8s-integrations', async() => {
mainEvents.emit('integration-update', await integrationManager.listIntegrations() ?? {});
});
ipcMainProxy.on('k8s-integration-set', (event, name, newState) => {
writeSettings({ WSL: { integrations: { [name]: newState } } });
});
mainEvents.on('integration-update', (state) => {
window.send('k8s-integrations', state);
});
/**
* 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.
*
* We need to write out rdctl output to a temporary directory because the logs directory
* will get removed by the factory-reset. This code writes out (to background.log) where this file
* exists, but if the user isn't tailing that file they won't see the message.
*/
async function doFactoryReset(keepSystemImages: boolean) {
// Don't wait for this process to return -- the whole point is for us to not be running.
const tmpdir = os.tmpdir();
const outfile = await fs.promises.open(path.join(tmpdir, 'rdctl-stdout.txt'), 'w');
const args = ['factory-reset', `--remove-kubernetes-cache=${ (!keepSystemImages) ? 'true' : 'false' }`];
if (cfg.application.debug) {
args.push('--verbose=true');
}
const rdctl = spawn(path.join(paths.resources, os.platform(), 'bin', 'rdctl'), args,
{
detached: true, windowsHide: true, stdio: ['ignore', outfile.fd, outfile.fd],
});
rdctl.unref();
console.debug(`If factory-reset fails, the rdctl factory-reset output files are in ${ tmpdir }`);
}
ipcMainProxy.on('factory-reset', (event, keepSystemImages) => {
doFactoryReset(keepSystemImages);
});
ipcMainProxy.on('show-logs', async(event) => {
const error = await Electron.shell.openPath(paths.logs);
if (error) {
const browserWindow = Electron.BrowserWindow.fromWebContents(event.sender);
const options: MessageBoxOptions = {
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);
}
}
});
ipcMainProxy.on('diagnostics/run', () => {
diagnostics.runChecks();
});
ipcMainProxy.on('get-app-version', async(event) => {
event.reply('get-app-version', await getVersion());
});
ipcMainProxy.on('snapshot', (event, args) => {
event.reply('snapshot', args);
});
ipcMainProxy.on('snapshot/cancel', () => {
window.send('snapshot/cancel');
});
ipcMainProxy.on('dialog/error', (event, args) => {
window.getWindow(args.dialog)?.webContents.send('dialog/error', args);
});
ipcMainProxy.on('dialog/close', (_event, args) => {
window.getWindow(args.dialog)?.webContents.send('dialog/close', args);
});
ipcMainProxy.handle('versions/macOs', () => {
return getMacOsVersion();
});
ipcMainProxy.handle('host/isArm', () => {
return process.arch === 'arm64';
});
ipcMainProxy.on('help/preferences/open-url', async() => {
Help.preferences.openUrl(await getVersion());
});
ipcMainProxy.handle('show-message-box', (_event, options: Electron.MessageBoxOptions): Promise<Electron.MessageBoxReturnValue> => {
return window.showMessageBox(options, false);
});
ipcMainProxy.handle('show-message-box-rd', async(_event, options: Electron.MessageBoxOptions, modal = false) => {
const mainWindow = modal ? window.getWindow('main') : null;
const dialog = window.openDialog(
'Dialog',
{
modal,
parent: mainWindow || undefined,
frame: true,
title: options.title,
height: 225,
});
let response: any;
dialog.webContents.on('ipc-message', (_event, channel, args) => {
if (channel === 'dialog/mounted') {
dialog.webContents.send('dialog/options', options);
}
if (channel === 'dialog/close') {
response = args || { response: options.cancelId };
dialog.close();
}