Skip to content

fix gh bug 154 "Set credential" command should allow user provided va… #162

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 1 commit into from
Oct 17, 2022
Merged

fix gh bug 154 "Set credential" command should allow user provided va… #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 83 additions & 18 deletions src/commands/LifecycleCommands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1052,7 +1052,7 @@ export class LifecycleCommands implements IDisposable {
});

const connectorQueryFiles: vscode.Uri[] = await vscode.workspace.findFiles(
"**/*.query.pq",
"**/*.{query,test}.pq",
"**/{bin,obj}/**",
1e2,
);
Expand All @@ -1075,6 +1075,10 @@ export class LifecycleCommands implements IDisposable {
label: one,
}));

items.push({
label: extensionI18n["PQSdk.lifecycle.command.choose.customizedDataSourceKind.label"],
});

const picked: vscode.QuickPickItem = await input.showQuickPick({
title,
step: 1,
Expand All @@ -1085,9 +1089,17 @@ export class LifecycleCommands implements IDisposable {
});

state.DataSourceKind = picked.label;
} else {
// we did not get a list of data source candidates,
// thus have to allow users inputting freely
}

if (
!state.DataSourceKind ||
state.DataSourceKind ===
extensionI18n["PQSdk.lifecycle.command.choose.customizedDataSourceKind.label"]
) {
// we did not have the DataSourceKind populated,
// or it was set to customized dataSourceKind label
// then we should allow users to input arbitrarily
// eslint-disable-next-line require-atomic-updates
state.DataSourceKind = await input.showInputBox({
title,
step: 1,
Expand All @@ -1114,22 +1126,75 @@ export class LifecycleCommands implements IDisposable {
input: MultiStepInput,
state: Partial<CreateAuthState>,
): Promise<InputStep | void> {
const items: vscode.QuickPickItem[] = connectorQueryFiles.map((one: vscode.Uri) => ({
label: vscode.workspace.asRelativePath(one),
detail: one.fsPath,
}));
if (connectorQueryFiles.length) {
const items: vscode.QuickPickItem[] = connectorQueryFiles.map((one: vscode.Uri) => ({
label: vscode.workspace.asRelativePath(one),
detail: one.fsPath,
}));

const picked: vscode.QuickPickItem = await input.showQuickPick({
title,
step: 2,
totalSteps: 3,
placeholder: extensionI18n["PQSdk.lifecycle.command.choose.connectorFile"],
activeItem: items[0],
items,
});
items.push({
label: extensionI18n["PQSdk.lifecycle.command.choose.customizedQueryFilePath.label"],
detail: extensionI18n["PQSdk.lifecycle.command.choose.customizedQueryFilePath.detail"],
});

// eslint-disable-next-line require-atomic-updates
state.PathToQueryFile = picked.detail;
const picked: vscode.QuickPickItem = await input.showQuickPick({
title,
step: 2,
totalSteps: 3,
placeholder: extensionI18n["PQSdk.lifecycle.command.choose.queryFile"],
activeItem: items[0],
items,
});

// eslint-disable-next-line require-atomic-updates
state.PathToQueryFile = picked.detail;
}

if (
!state.PathToQueryFile ||
state.PathToQueryFile ===
extensionI18n["PQSdk.lifecycle.command.choose.customizedQueryFilePath.detail"]
) {
// we did not have the PathToQueryFile populated,
// or it was set to customized PathToQueryFile detail
// then we should allow users to input arbitrarily
// eslint-disable-next-line require-atomic-updates
state.PathToQueryFile = await input.showInputBox({
title,
step: 2,
totalSteps: 3,
value: "",
prompt: extensionI18n["PQSdk.lifecycle.command.choose.queryFilePath.label"],
ignoreFocusOut: true,
validate: (key: string) =>
Promise.resolve(
key.length
? undefined
: extensionI18n["PQSdk.lifecycle.error.empty.PathToQueryFilePath"],
),
});

// we also need to populate the state.PathToConnectorFile
// since the PathToQueryFilePath might be another query file
state.PathToConnectorFile = path.dirname(state.PathToQueryFile);

// need to populate the PathToConnectorFile to re-verify
// eslint-disable-next-line require-atomic-updates
state.PathToConnectorFile = await input.showInputBox({
title,
step: 2,
totalSteps: 3,
value: state.PathToConnectorFile,
prompt: extensionI18n["PQSdk.lifecycle.command.choose.extensionFilePath.label"],
ignoreFocusOut: true,
validate: (key: string) =>
Promise.resolve(
key.length
? undefined
: extensionI18n["PQSdk.lifecycle.error.empty.PathToConnectorFile"],
),
});
}

progress.report({ increment: 10 });

Expand Down
1 change: 1 addition & 0 deletions src/common/PQTestService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ export interface ExtensionInfo {
export interface CreateAuthState {
DataSourceKind: string;
AuthenticationKind: string;
PathToConnectorFile?: string;
PathToQueryFile: string;
// for the key template
$$KEY$$?: string;
Expand Down
9 changes: 8 additions & 1 deletion src/i18n/extension.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,13 @@
"PQSdk.lifecycle.command.generate.credentials.title": "Generating credential",
"PQSdk.lifecycle.command.generate.credentials.result": "GenerateCredentialTemplate {result} ",
"PQSdk.lifecycle.command.choose.dataSourceKind.label": "Data source kind",
"PQSdk.lifecycle.command.choose.customizedDataSourceKind.label": "Input a data source kind",
"PQSdk.lifecycle.command.choose.dataSourceKind": "Choose the data source kind",
"PQSdk.lifecycle.command.choose.connectorFile": "Choose a connector file",
"PQSdk.lifecycle.command.choose.queryFile": "Choose a query/test file",
"PQSdk.lifecycle.command.choose.extensionFilePath.label": "Extension file path",
"PQSdk.lifecycle.command.choose.queryFilePath.label": "Query/test file path",
"PQSdk.lifecycle.command.choose.customizedQueryFilePath.label": "Input a query/test file path",
"PQSdk.lifecycle.command.choose.customizedQueryFilePath.detail": "Arbitrary query/test file path using the credential",
"PQSdk.lifecycle.command.choose.auth": "Choose an authentication method",
"PQSdk.lifecycle.command.choose.authKind.prompt": "Authentication key value",
"PQSdk.lifecycle.command.set.credentials.result": "SetCredential {result} ",
Expand Down Expand Up @@ -61,6 +66,8 @@
"PQSdk.lifecycle.warning.pqtest.set.failed": "SDK Tools location has not been configured",
"PQSdk.lifecycle.warning.pqtest.required": "SDK Tools location must be provided before continuing",
"PQSdk.lifecycle.error.empty.dataSourceKind": "Data source kind cannot be empty",
"PQSdk.lifecycle.error.empty.PathToConnectorFile": "Extension file path cannot be empty",
"PQSdk.lifecycle.error.empty.PathToQueryFilePath": "Query/test file path cannot be empty",
"PQSdk.lifecycle.error.empty.project.name": "A project name value must be set before continuing",
"PQSdk.lifecycle.error.invalid.project.name": "Only alphanumeric are allowed.",
"PQSdk.lifecycle.error.invalid.empty.value": "Value {valueName} cannot be empty.",
Expand Down
2 changes: 1 addition & 1 deletion src/pqTestConnector/PqServiceHostClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,7 +776,7 @@ export class PqServiceHostClient implements IPQTestService, IDisposable {
params: [
{
SessionId: this.sessionId,
PathToConnector: getFirstWorkspaceFolder()?.uri.fsPath,
PathToConnector: createAuthState.PathToConnectorFile || getFirstWorkspaceFolder()?.uri.fsPath,
PathToQueryFile: resolveSubstitutedValues(createAuthState.PathToQueryFile),
// DataSourceKind: createAuthState.DataSourceKind,
AuthenticationKind: createAuthState.AuthenticationKind,
Expand Down
4 changes: 3 additions & 1 deletion src/pqTestConnector/PqTestExecutableTaskQueue.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,9 @@ export class PqTestExecutableTaskQueue implements IPQTestService, IDisposable {
return this.doEnqueueOneTask<GenericResult>({
operation: "set-credential",
additionalArgs,
pathToConnector: resolveSubstitutedValues(ExtensionConfigurations.DefaultExtensionLocation),
pathToConnector:
createAuthState.PathToConnectorFile ||
resolveSubstitutedValues(ExtensionConfigurations.DefaultExtensionLocation),
pathToQueryFile: resolveSubstitutedValues(createAuthState.PathToQueryFile),
stdinStr: payloadStr,
});
Expand Down