Skip to content

fix(proxy): show friendly error when proxy config is not supported COMPASS-8345 #6321

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

Merged
merged 3 commits into from
Oct 4, 2024
Merged

fix(proxy): show friendly error when proxy config is not supported COMPASS-8345 #6321

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a43836
chore: show friendly error when proxy config is not supported
kmruiz Oct 3, 2024
67781f8
chore: fix log
kmruiz Oct 3, 2024
f308369
chore: fix eslint checks
kmruiz Oct 3, 2024
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
37 changes: 36 additions & 1 deletion packages/compass/src/main/application.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import './disable-node-deprecations'; // Separate module so it runs first
import path from 'path';
import { EventEmitter } from 'events';
import type { BrowserWindow, Event, ProxyConfig } from 'electron';
import { dialog } from 'electron';
import { app, safeStorage, session } from 'electron';
import { ipcMain } from 'hadron-ipc';
import type { AutoUpdateManagerState } from './auto-update-manager';
Expand Down Expand Up @@ -301,7 +302,41 @@ class CompassApplication {
try {
const proxyOptions = proxyPreferenceToProxyOptions(value);
await app.whenReady();
await target.setProxy(translateToElectronProxyConfig(proxyOptions));

try {
const electronProxyConfig =
translateToElectronProxyConfig(proxyOptions);
await target.setProxy(electronProxyConfig);
} catch (err) {
const headline = String(
err && typeof err === 'object' && 'message' in err
? err.message
: err ||
'Currently Compass does not support authenticated or ssh proxies.'
);

log.warn(
mongoLogId(1_001_000_332),
logContext,
'Unable to set proxy configuration',
{
error: headline,
}
);

const sep = path.sep;
const configPath = `${app.getPath(
'userData'
)}${sep}AppPreferences${sep}General.json`;

dialog.showErrorBox(
'Unsupported proxy configuration',
`${headline}\n\n
To reset the proxy configuration, remove the "proxy" key in ${configPath} and restart Compass.`
);

app.quit();
}

const agent = createAgent(proxyOptions);
const fetch = createFetch(agent || {});
Expand Down