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.

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

Jump to bottom

fix: push error handling #5392

Merged
merged 4 commits into from
Feb 3, 2024
Merged

fix: push error handling #5392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ca6caa
fix: push error handling
CristiCanizales Feb 2, 2024
a76e693
chore: response.name upon conflicts
CristiCanizales Feb 2, 2024
9681f3c
chore: ahora si
CristiCanizales Feb 2, 2024
a422d52
Merge branch 'develop' into cristi/fix-push-diagnostics
daphne-sfdc Feb 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
2 changes: 1 addition & 1 deletion packages/salesforcedx-test-utils-vscode/src/orgUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export const pushSource = async (
).execute();
const cmdOutput = new CommandOutput();
const result = await cmdOutput.getCmdResult(execution);
const source = JSON.parse(result).result.files;
const source = JSON.parse(result).files;
return Promise.resolve(source);
};

Expand Down
12 changes: 8 additions & 4 deletions packages/salesforcedx-utils-vscode/src/cli/parsers/projectDeployStartResultParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import { extractJsonObject } from '../../helpers';

export const CONFLICT_ERROR_NAME = 'sourceConflictDetected';
export const CONFLICT_ERROR_NAME = 'SourceConflictError';

export interface ProjectDeployStartResult {
columnNumber?: string;
Expand All @@ -22,9 +22,8 @@ export interface ProjectDeployStartResult {
export interface ProjectDeployStartErrorResponse {
message: string;
name: string;
data: ProjectDeployStartResult[];
stack: string;
status: number;
files: ProjectDeployStartResult[];
warnings: any[];
}

Expand All @@ -50,7 +49,12 @@ export class ProjectDeployStartResultParser {

public getErrors(): ProjectDeployStartErrorResponse | undefined {
if (this.response.status === 1) {
return this.response as ProjectDeployStartErrorResponse;
return {
message: this.response.message ?? 'Push failed. ',
name: this.response.name ?? 'DeployFailed',
status: this.response.status,
files: this.response.data ?? this.response.result.files
} as ProjectDeployStartErrorResponse;
}
}

Expand Down
17 changes: 9 additions & 8 deletions packages/salesforcedx-vscode-core/src/commands/projectDeployStart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import {
import * as vscode from 'vscode';
import { channelService } from '../channels';
import { PersistentStorageService } from '../conflict';
import { FORCE_SOURCE_PUSH_LOG_NAME } from '../constants';
import { handleDiagnosticErrors } from '../diagnostics';
import { PROJECT_DEPLOY_START_LOG_NAME } from '../constants';
import { handlePushDiagnosticErrors } from '../diagnostics';
import { nls } from '../messages';
import { telemetryService } from '../telemetry';
import { DeployRetrieveExecutor } from './baseDeployRetrieve';
Expand Down Expand Up @@ -124,7 +124,7 @@ export class ProjectDeployStartExecutor extends SfdxCommandletExecutor<{}> {
cancellationTokenSource: vscode.CancellationTokenSource
/* eslint-enable @typescript-eslint/no-unused-vars */
): Promise<void> {
if (execution.command.logName === FORCE_SOURCE_PUSH_LOG_NAME) {
if (execution.command.logName === PROJECT_DEPLOY_START_LOG_NAME) {
const pushResult = this.parseOutput(stdOut);
if (exitCode === 0) {
this.updateCache(pushResult);
Expand All @@ -140,7 +140,7 @@ export class ProjectDeployStartExecutor extends SfdxCommandletExecutor<{}> {
const errors = pushParser.getErrors();
if (errors && !pushParser.hasConflicts()) {
channelService.showChannelOutput();
handleDiagnosticErrors(
handlePushDiagnosticErrors(
errors,
workspacePath,
execFilePathOrPaths,
Expand Down Expand Up @@ -191,7 +191,7 @@ export class ProjectDeployStartExecutor extends SfdxCommandletExecutor<{}> {
const errors = parser.getErrors();
const pushedSource = successes ? successes.result.files : undefined;
if (pushedSource || parser.hasConflicts()) {
const rows = pushedSource || (errors && errors.data);
const rows = pushedSource || (errors && errors.files);
const title = !parser.hasConflicts()
? nls.localize(`table_title_${titleType}ed_source`)
: undefined;
Expand All @@ -207,9 +207,10 @@ export class ProjectDeployStartExecutor extends SfdxCommandletExecutor<{}> {
}

if (errors && !parser.hasConflicts()) {
const { name, message, data } = errors;
if (data) {
const outputTable = this.getErrorTable(table, data, titleType);
const { name, message } = errors;
const files = errors.files;
if (files) {
const outputTable = this.getErrorTable(table, files, titleType);
channelService.appendLine(outputTable);
} else if (name && message) {
channelService.appendLine(`${name}: ${message}\n`);
Expand Down
4 changes: 2 additions & 2 deletions packages/salesforcedx-vscode-core/src/commands/util/sfdxCommandletExecutor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import * as vscode from 'vscode';
import { channelService } from '../../channels';
import {
FORCE_SOURCE_PULL_LOG_NAME,
FORCE_SOURCE_PUSH_LOG_NAME
PROJECT_DEPLOY_START_LOG_NAME
} from '../../constants';
import { nls } from '../../messages';
import { notificationService, ProgressNotification } from '../../notifications';
Expand Down Expand Up @@ -51,7 +51,7 @@ export abstract class SfdxCommandletExecutor<T>
if (
!(
commandLogName === FORCE_SOURCE_PULL_LOG_NAME ||
commandLogName === FORCE_SOURCE_PUSH_LOG_NAME
commandLogName === PROJECT_DEPLOY_START_LOG_NAME
)
) {
channelService.streamCommandOutput(execution);
Expand Down
2 changes: 1 addition & 1 deletion packages/salesforcedx-vscode-core/src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,5 @@ export const FUNCTIONS_PATH = '/functions/';
export const ORG_OPEN_COMMAND = 'sfdx.org.open';
export const FORCE_SOURCE_PULL_LOG_NAME =
'force_source_pull_default_scratch_org';
export const FORCE_SOURCE_PUSH_LOG_NAME =
export const PROJECT_DEPLOY_START_LOG_NAME =
'project_deploy_start_default_scratch_org';
36 changes: 18 additions & 18 deletions packages/salesforcedx-vscode-core/src/diagnostics/diagnostics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,34 @@ import { SfdxCommandletExecutor } from '../commands/util';

const notApplicable = 'N/A';

export function getFileUri(
export const getFileUri = (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arrow functions! Thank you!

workspacePath: string,
filePath: string,
defaultErrorPath: string
): string {
): string => {
const resolvedFilePath = filePath.includes(workspacePath)
? filePath
: path.join(workspacePath, filePath);
// source:deploy sometimes returns N/A as filePath
return filePath === notApplicable ? defaultErrorPath : resolvedFilePath;
}
};

export function getRange(
export const getRange = (
lineNumber: string,
columnNumber: string
): vscode.Range {
): vscode.Range => {
const ln = Number(lineNumber);
const col = Number(columnNumber);
const pos = new vscode.Position(ln > 0 ? ln - 1 : 0, col > 0 ? col - 1 : 0);
return new vscode.Range(pos, pos);
}
};

export function handleDiagnosticErrors(
export const handlePushDiagnosticErrors = (
errors: ProjectDeployStartErrorResponse,
workspacePath: string,
sourcePathOrPaths: string,
errorCollection: vscode.DiagnosticCollection
): vscode.DiagnosticCollection {
): vscode.DiagnosticCollection => {
errorCollection.clear();

// In the case that we have deployed multiple source paths,
Expand All @@ -54,8 +54,8 @@ export function handleDiagnosticErrors(
: sourcePathOrPaths;

const diagnosticMap: Map<string, vscode.Diagnostic[]> = new Map();
if (Reflect.has(errors, 'data')) {
errors.data.forEach(error => {
if (Reflect.has(errors, 'files')) {
errors.files.forEach(error => {
const fileUri = getFileUri(
workspacePath,
error.filePath,
Expand Down Expand Up @@ -84,7 +84,7 @@ export function handleDiagnosticErrors(
const fileUri = vscode.Uri.file(file);
errorCollection.set(fileUri, diagMap);
});
} else if (Reflect.has(errors, 'message')) {
} else if (Reflect.has(errors, 'status')) {
const fileUri = vscode.Uri.file(defaultErrorPath);
const range = getRange('1', '1');
const diagnostic = {
Expand All @@ -98,12 +98,12 @@ export function handleDiagnosticErrors(
}

return errorCollection;
}
};

export function handleDeployDiagnostics(
export const handleDeployDiagnostics = (
deployResult: DeployResult,
errorCollection: vscode.DiagnosticCollection
): vscode.DiagnosticCollection {
): vscode.DiagnosticCollection => {
errorCollection.clear();
SfdxCommandletExecutor.errorCollection.clear();

Expand Down Expand Up @@ -144,18 +144,18 @@ export function handleDeployDiagnostics(
);

return errorCollection;
}
};

// TODO: move to some type of file service or utility
export function getAbsoluteFilePath(
export const getAbsoluteFilePath = (
filePath: string | undefined,
workspacePath: string = getRootWorkspacePath()
): string {
): string => {
let absoluteFilePath = filePath ?? workspacePath;
if (!absoluteFilePath.includes(workspacePath)) {
// Build the absolute filePath so that errors in the Problems
// tab correctly link to the problem location in the file
absoluteFilePath = [workspacePath, filePath].join('/');
}
return absoluteFilePath;
}
};
2 changes: 1 addition & 1 deletion packages/salesforcedx-vscode-core/src/diagnostics/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ export {
getAbsoluteFilePath,
getFileUri,
getRange,
handleDiagnosticErrors,
handlePushDiagnosticErrors,
handleDeployDiagnostics
} from './diagnostics';
7 changes: 3 additions & 4 deletions ...rcedx-vscode-core/test/vscode-integration/commands/projectDeployStartResultParser.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,8 @@ describe('Correctly output deploy results', () => {
status: 1,
name: 'Deploy Failed',
message: 'There was a failure',
stack: 'A stack',
warnings: ['A warning'],
data: [
files: [
{
filePath: 'src/classes/MyClass2.cls',
error: 'Some Error'
Expand Down Expand Up @@ -133,7 +132,7 @@ describe('Correctly output deploy results', () => {
'hasConflicts'
).returns(true);
deployError.name = CONFLICT_ERROR_NAME;
deployError.data = [
deployError.files = [
{
state: 'Conflict',
fullName: 'SomeClass',
Expand All @@ -143,7 +142,7 @@ describe('Correctly output deploy results', () => {
];
errorsStub.returns(deployError);
const conflictsTable = table.createTable(
deployError.data as unknown as Row[],
deployError.files as unknown as Row[],
[
{ key: 'state', label: nls.localize('table_header_state') },
{ key: 'fullName', label: nls.localize('table_header_full_name') },
Expand Down
26 changes: 12 additions & 14 deletions packages/salesforcedx-vscode-core/test/vscode-integration/diagnostics/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
getAbsoluteFilePath,
getFileUri,
getRange,
handleDiagnosticErrors
handlePushDiagnosticErrors
} from '../../../src/diagnostics';

describe('Diagnostics', () => {
Expand All @@ -27,10 +27,9 @@ describe('Diagnostics', () => {
pushErrorResult = {
message: 'Push failed.',
name: 'PushFailed',
stack: '123',
status: 1,
warnings: [],
data: []
files: []
};
});

Expand Down Expand Up @@ -64,9 +63,9 @@ describe('Diagnostics', () => {
fullName: 'Testing'
};

pushErrorResult.data.push(resultItem);
pushErrorResult.files.push(resultItem);

handleDiagnosticErrors(
handlePushDiagnosticErrors(
pushErrorResult,
workspacePath,
sourcePath,
Expand Down Expand Up @@ -107,10 +106,10 @@ describe('Diagnostics', () => {
fullName: 'SomeController'
};

pushErrorResult.data.push(resultItem1);
pushErrorResult.data.push(resultItem2);
pushErrorResult.files.push(resultItem1);
pushErrorResult.files.push(resultItem2);

handleDiagnosticErrors(
handlePushDiagnosticErrors(
pushErrorResult,
workspacePath,
sourcePath,
Expand Down Expand Up @@ -159,8 +158,8 @@ describe('Diagnostics', () => {
type: 'ApexClass'
};

pushErrorResult.data.push(resultItem);
handleDiagnosticErrors(
pushErrorResult.files.push(resultItem);
handlePushDiagnosticErrors(
pushErrorResult,
workspacePath,
sourcePath,
Expand Down Expand Up @@ -194,17 +193,16 @@ describe('Diagnostics', () => {
filePath: 'N/A'
};

pushErrorResult.data.push(resultItem1);
pushErrorResult.data.push(resultItem2);
handleDiagnosticErrors(
pushErrorResult.files.push(resultItem1);
pushErrorResult.files.push(resultItem2);
handlePushDiagnosticErrors(
pushErrorResult,
workspacePath,
sourcePath,
errorCollection
);

const testDiagnostics = languages.getDiagnostics(Uri.file(sourcePath));

expect(testDiagnostics).to.be.an('array').to.have.lengthOf(2);
expect(testDiagnostics[0].message).to.be.equals(resultItem1.error);
expect(testDiagnostics[0].severity).to.be.equals(0); // vscode.DiagnosticSeverity.Error === 0
Expand Down
Loading