Exception breakpoints #218

DatGuyJonathan · 2017-11-17T01:21:10Z

What does this PR do?

This change allows a debugging user to add/remove exception breakpoints for System and user-defined exception types. The list of exception types are acquired from Apex language server. Configuring an exception breakpoint is done through the command palette.

Typical UX Flow

Open SFDX project in VS Code with Salesforce extensions installed
Start Apex Debugger session
Open command palette
Select Apex Debug: Configure Exceptions
Select an exception type
Select whether to always break (add breakpoint) or never break (remove breakpoint)
Wait until a log line in Debug Console verifies the breakpoint has been configured
Trigger the Apex exception

Notes

Exception types in the command palette are listed alphabetically.
Enabled exception breakpoints will be shown at the top of the list of exception types in the command palette. They will have a description that says "Always break" with a built-in VS Code icon from https://octicons.github.com/icon/stop/.
Apex Debug: Configure Exceptions command is also available without an active debugger session. If the user tries to add an exception breakpoint without an active session, we automatically mark it as enabled and save it to be added when we detect a new debugger session.
packages/salesforcedx-vscode-apex/out/apex-jorje-lsp.jar is signed.

What issues does this PR fix or reference?

@W-4179085@

…s at the top

…ssion

DatGuyJonathan · 2017-11-17T01:22:24Z

packages/salesforcedx-apex-debugger/src/adapter/apexDebug.ts

@@ -977,10 +987,56 @@ export class ApexDebug extends LoggingDebugSession {
        this.myRequestService.connectionTimeoutMs =
          workspaceSettings.connectionTimeoutMs;
        break;
+      case EXCEPTION_BREAKPOINT_REQUEST:


This is a request from the extension to the adapter for configuring an exception breakpoint.

DatGuyJonathan · 2017-11-17T01:22:50Z

packages/salesforcedx-apex-debugger/src/adapter/apexDebug.ts

+          }
+        }
+        break;
+      case LIST_EXCEPTION_BREAKPOINTS_REQUEST:


This is a request from the extension to the adapter for a list of enabled exception breakpoints.

DatGuyJonathan · 2017-11-17T01:23:33Z

packages/salesforcedx-apex-debugger/src/core/breakpointService.ts

+        .withArg('--json')
+        .build(),
+      { cwd: projectPath, env: RequestService.getEnvVars() }
+    ).execute();


CLI command to create an ApexDebuggerBreakpoint object with for an exception type.

DatGuyJonathan · 2017-11-17T01:24:59Z

packages/salesforcedx-apex-debugger/src/core/breakpointService.ts

+    info: ExceptionBreakpointInfo
+  ): Promise<void> {
+    const knownBreakpointId = this.exceptionBreakpointCache.get(info.typeref);
+    if (knownBreakpointId && info.breakMode === 'never') {


Breakpoint service will delete a breakpoint if it exists in the cache and the user choses Never break for the exception type.

DatGuyJonathan · 2017-11-17T01:25:23Z

packages/salesforcedx-apex-debugger/src/core/breakpointService.ts

+    if (knownBreakpointId && info.breakMode === 'never') {
+      await this.deleteBreakpoint(projectPath, knownBreakpointId);
+      this.exceptionBreakpointCache.delete(info.typeref);
+    } else if (!knownBreakpointId && info.breakMode === 'always') {


Breakpoint service will add a breakpoint if it doesn't exist in the cache and the user choses Always break for the exception type.

Is this logic a result of limitations with the CLI and updating the IsEnabled attribute of an exception breakpoint? It seems that VS Code is becoming the system or record then. On the other hand, we are dealing with "short" lived debugging sessions anyway. Thus, a sync issue may just be worked around by killing and starting a new debug session.

DatGuyJonathan · 2017-11-17T01:25:54Z

packages/salesforcedx-apex-debugger/src/messages/i18n.ts

-    "You can't modify Apex classes or triggers during an Apex Debugger session. Save your changes after you're done debugging."
+    "You can't modify Apex classes or triggers during an Apex Debugger session. Save your changes after you're done debugging.",
+  created_exception_breakpoint_text: 'Created exception breakpoint for %s.',
+  removed_exception_breakpoint_text: 'Removed exception breakpoint for %s.'


These messages appear in the Debug Console when there's an active debugger session and an exception breakpoint is added/removed.

DatGuyJonathan · 2017-11-17T01:26:31Z

packages/salesforcedx-vscode-apex-debugger/package.nls.json

@@ -14,5 +14,6 @@
    "Produce diagnostic output. Instead of setting this to true you can list one or more selectors separated with commas. The 'all' selector enables very detailed output. Other selectors are 'protocol', 'variables', 'launch'",
  "configuration_title": "Salesforce Apex Debugger Configuration",
  "connection_timeout_ms_description":
-    "Connection timeout for Apex Debugger API requests (in milliseconds)."
+    "Connection timeout for Apex Debugger API requests (in milliseconds).",
+  "exception_breakpoint_command_text": "Apex Debug: Configure Exceptions"


Label for the command.

DatGuyJonathan · 2017-11-17T01:27:14Z

packages/salesforcedx-vscode-apex-debugger/src/index.ts

+    'salesforce.salesforcedx-vscode-apex'
+  );
+  if (sfdxApex && sfdxApex.exports) {
+    const exceptionBreakpointInfos: ExceptionBreakpointItem[] = await sfdxApex.exports.getExceptionBreakpointInfo();


The extension gets a list of System and user-defined exception types from Apex language server.

DatGuyJonathan · 2017-11-17T01:28:21Z

packages/salesforcedx-vscode-apex-debugger/src/index.ts

+      const args: SetExceptionBreakpointsArguments = {
+        exceptionInfo: breakpoint
+      };
+      session.customRequest(EXCEPTION_BREAKPOINT_REQUEST, args);


When a debugger session starts, add all exception breakpoints that were selected while without a debugger session.

DatGuyJonathan · 2017-11-17T01:29:09Z

packages/salesforcedx-vscode-apex-debugger/src/index.ts

+        cachedExceptionBreakpoints.keys()
+      );
+    }
+    const processedBreakpointInfos = mergeExceptionBreakpointInfos(


Create the quick pick list of exception types. Enabled breakpoints are listed first.

DatGuyJonathan · 2017-11-17T01:30:38Z

packages/salesforcedx-vscode-apex-debugger/src/index.ts

+    for (let i = breakpointInfos.length - 1; i >= 0; i--) {
+      if (enabledBreakpointTyperefs.indexOf(breakpointInfos[i].typeref) >= 0) {
+        breakpointInfos[i].breakMode = EXCEPTION_BREAKPOINT_BREAK_MODE_ALWAYS;
+        breakpointInfos[i].description = `$(stop) ${nls.localize(


The description will show an icon from https://octicons.github.com/icon/stop/ and Always break if it's an enabled breakpoint.

DatGuyJonathan · 2017-11-17T01:31:35Z

packages/salesforcedx-vscode-apex/src/index.ts

@@ -31,5 +35,13 @@ async function getLineBreakpointInfo(): Promise<{}> {
  return Promise.resolve(response);
 }

+async function getExceptionBreakpointInfo(): Promise<{}> {


Exposed API in salesforcedx-vscode-apex to retrieve a list of System and user-defined exception types.

DatGuyJonathan · 2017-11-17T01:37:05Z

@guw , this is a huge changelist. Take your time reviewing it. There's no scheduled release next week, so the latest we want to get this merged in is November 27th EOD. The release will be November 30th.

@ruthemmanuelle , there's some UX text you can review in files named i18n.ts. Also a heads up to set aside some time to update https://github.com/forcedotcom/salesforcedx-vscode/tree/develop/packages/salesforcedx-vscode-apex-debugger.

DatGuyJonathan · 2017-11-17T01:38:16Z

packages/salesforcedx-vscode-apex-debugger/src/messages/i18n.ts

+ *
+ * If ommitted, we will assume _message.
+ */
+export const messages = {


These are labels shown in the command palette when selecting an exception. See .gif for an example.

codecov · 2017-11-17T02:21:04Z

Codecov Report

Merging #218 into develop will increase coverage by 0.61%.
The diff coverage is 44.3%.

@@             Coverage Diff             @@
##           develop     #218      +/-   ##
===========================================
+ Coverage    80.31%   80.93%   +0.61%     
===========================================
  Files          111      113       +2     
  Lines         4527     4637     +110     
  Branches       745      770      +25     
===========================================
+ Hits          3636     3753     +117     
+ Misses         735      725      -10     
- Partials       156      159       +3

Impacted Files	Coverage Δ
...pex-debugger/test/unit/adapter/apexDebugForTest.ts	`100% <ø> (ø)`	⬆️
...es/salesforcedx-apex-debugger/src/messages/i18n.ts	`100% <ø> (ø)`	⬆️
packages/salesforcedx-apex-debugger/src/index.ts	`100% <ø> (ø)`	⬆️
...ges/salesforcedx-vscode-apex-debugger/src/index.ts	`21.38% <10.71%> (-2.26%)`	⬇️
...sforcedx-vscode-apex-debugger/src/messages/i18n.ts	`100% <100%> (ø)`
packages/salesforcedx-vscode-apex/src/constants.ts	`100% <100%> (ø)`	⬆️
...ckages/salesforcedx-apex-debugger/src/constants.ts	`100% <100%> (ø)`	⬆️
packages/salesforcedx-vscode-apex/src/index.ts	`47.36% <16.66%> (-16.92%)`	⬇️
...forcedx-vscode-apex-debugger/src/messages/index.ts	`86.66% <86.66%> (ø)`
...orcedx-apex-debugger/src/core/breakpointService.ts	`91.2% <86.66%> (-1.75%)`	⬇️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4cb35f0...fd51774. Read the comment docs.

guw

LGTM

ruthemmanuelle

The messages look fine. I didn't review anything else.

Jonathan Widjaja added 7 commits November 16, 2017 14:22

Add command to quickly test exception breakpoint info

12a5512

Quickpick exception types

a045aa4

Add/remove exception breakpoint

4063760

Show enabled exception breakpoints at the top of the list

3eda1e4

Add tests for debug adapter and breakpoint service

fe2ad41

Add tests to verify exception type quick list shows enabled exception…

e0926a1

…s at the top

Allow configuring exception breakpoints without an active debugger se…

fd51774

…ssion

DatGuyJonathan requested a review from guw November 17, 2017 01:21

DatGuyJonathan commented Nov 17, 2017

View reviewed changes

DatGuyJonathan requested a review from ruthemmanuelle November 17, 2017 01:43

guw approved these changes Nov 17, 2017

View reviewed changes

ruthemmanuelle approved these changes Nov 17, 2017

View reviewed changes

DatGuyJonathan merged commit 54b1279 into develop Nov 17, 2017

DatGuyJonathan deleted the jwidjaja/exceptionBreakpoints branch November 17, 2017 22:57

ruthemmanuelle mentioned this pull request Nov 29, 2017

Add doc for exception breakpoints #226

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exception breakpoints #218

Exception breakpoints #218

DatGuyJonathan commented Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

guw Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan Nov 17, 2017

DatGuyJonathan commented Nov 17, 2017 •

edited

Loading

DatGuyJonathan Nov 17, 2017

codecov bot commented Nov 17, 2017 •

edited

Loading

guw left a comment

ruthemmanuelle left a comment

Exception breakpoints #218

Exception breakpoints #218

Conversation

DatGuyJonathan commented Nov 17, 2017

What does this PR do?

What issues does this PR fix or reference?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DatGuyJonathan commented Nov 17, 2017 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Nov 17, 2017 • edited Loading

Codecov Report

guw left a comment

Choose a reason for hiding this comment

ruthemmanuelle left a comment

Choose a reason for hiding this comment

DatGuyJonathan commented Nov 17, 2017 •

edited

Loading

codecov bot commented Nov 17, 2017 •

edited

Loading