Skip to content
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.

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

Changed warning when using .mirrord config folder to info. closes #29 #87

Merged
merged 16 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@
"default": true,
"description": "Show a notification when mirrord uses active configuration."
},
"mirrord.promptUsingEnvVarConfig": {
"type": "boolean",
"default": true,
"description": "Show a notification when mirrord uses env var configuration."
},
"mirrord.promptUsingDefaultConfig": {
"type": "boolean",
"default": true,
Expand Down
56 changes: 32 additions & 24 deletions src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@ export function isTargetSet(verifiedConfig: VerifiedConfig): boolean {
}
}

/**
* Notifies the user we're running with a default config when `resolveMirrordConfig`
* returns `null`.
*/
export function notifyRunningWithDefaultConfig() {
new NotificationBuilder()
.withMessage(`Using default mirrord configuration.`)
.withDisableAction("promptUsingDefaultConfig")
.info();
}

export class MirrordConfigManager {
private static instance?: MirrordConfigManager = undefined;

Expand Down Expand Up @@ -296,43 +307,40 @@ export class MirrordConfigManager {
if (this.active) {
// User has selected a config (via active config button).
new NotificationBuilder()
.withMessage("using active mirrord configuration")
.withMessage("Using active mirrord configuration.")
.withOpenFileAction(this.active)
.withDisableAction("promptUsingActiveConfig")
.info();

return this.active;
} else if (config.env?.["MIRRORD_CONFIG_FILE"]) {
// Get the config path from the env var.
return vscode.Uri.parse(`file://${config.env?.["MIRRORD_CONFIG_FILE"]}`, true);
const configFromEnv = vscode.Uri.parse(`file://${config.env?.["MIRRORD_CONFIG_FILE"]}`, true);

new NotificationBuilder()
.withMessage(`Using mirrord configuration from env var "MIRRORD_CONFIG_FILE".`)
.withOpenFileAction(configFromEnv)
.withDisableAction("promptUsingEnvVarConfig")
.info();

return configFromEnv;

} else if (folder) {
let predefinedConfig = await MirrordConfigManager.getDefaultConfig(folder);
if (predefinedConfig) {
new NotificationBuilder()
.withMessage("using a default mirrord config")
.withOpenFileAction(predefinedConfig)
.withDisableAction("promptUsingDefaultConfig")
.warning();
return predefinedConfig;
} else {
return null;
}
} else {
folder = vscode.workspace.workspaceFolders?.[0];
if (!folder) {
throw new Error("mirrord requires an open folder in the workspace");
}
const configFromMirrordFolder = await MirrordConfigManager.getDefaultConfig(folder);

let predefinedConfig = await MirrordConfigManager.getDefaultConfig(folder);
if (predefinedConfig) {
if (configFromMirrordFolder) {
new NotificationBuilder()
.withMessage(`using a default mirrord config from folder ${folder.name} `)
.withOpenFileAction(predefinedConfig)
.withMessage(`Using mirrord configuration from ".mirrord" folder.`)
.withOpenFileAction(configFromMirrordFolder)
.withDisableAction("promptUsingDefaultConfig")
.warning();
return predefinedConfig;
.info();

return configFromMirrordFolder;
} else {
return null;
}
} else {
return null;
}
}
}
8 changes: 5 additions & 3 deletions src/debugger.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as vscode from 'vscode';
import { globalContext } from './extension';
import { isTargetSet, MirrordConfigManager } from './config';
import { isTargetSet, MirrordConfigManager, notifyRunningWithDefaultConfig } from './config';
import { LAST_TARGET_KEY, MirrordAPI, mirrordFailure, MirrordExecution } from './api';
import { updateTelemetries } from './versionCheck';
import { getMirrordBinary } from './binaryManager';
Expand Down Expand Up @@ -95,8 +95,8 @@ async function main(
let cliPath = await getMirrordBinary(false);

if (!cliPath) {
mirrordFailure(`Couldn't download mirrord binaries or find local one in path`);
return null;
mirrordFailure(`Couldn't download mirrord binaries or find local one in path`);
return null;
}

let mirrordApi = new MirrordAPI(cliPath);
Expand All @@ -105,6 +105,8 @@ async function main(
let target = null;

let configPath = await MirrordConfigManager.getInstance().resolveMirrordConfig(folder, config);
if (configPath === null) { notifyRunningWithDefaultConfig(); }

const verifiedConfig = await mirrordApi.verifyConfig(configPath, config.env);

// If target wasn't specified in the config file (or there's no config file), let user choose pod from dropdown
Expand Down