Ruth/release/v44.2.0 #666

ruthemmanuelle · 2018-10-09T20:15:57Z

What does this PR do?

Updates docs to reflect changes in v44 of Salesforce Extensions for VS Code.

What issues does this PR fix or reference?

@W-5444466, W-5220476@
#123

@W-5444466@

@W-5220476@

@W-5444466@

@W-5220476@

ruthemmanuelle · 2018-10-09T20:16:56Z

packages/salesforcedx-vscode-apex-replay-debugger/README.md

+- You can use this debugger only in your orgs. ISV customer debugging is unavailable in Apex Replay Debugger. To debug customers’ orgs, use [ISV Customer Debugger](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex-debugger).
+- You can replay only one debug log at a time. This limitation can make it difficult to debug asynchronous Apex, which produces multiple debug logs.
+- Be sure to start a session soon after uploading your checkpoints, because checkpoints expire after 30 minutes.
+- Be sure to debug your code soon after starting the session, because heap dumps expire about a day after you generate them.


Everything in this list below the line about heap dump expiration is unchanged. It shows as changed because I changed the asterisks to hyphens.

codecov · 2018-10-09T20:27:42Z

Codecov Report

Merging #666 into release/v44.2.0 will not change coverage.
The diff coverage is n/a.

@@               Coverage Diff                @@
##           release/v44.2.0     #666   +/-   ##
================================================
  Coverage            74.87%   74.87%           
================================================
  Files                  158      158           
  Lines                 6431     6431           
  Branches              1009     1009           
================================================
  Hits                  4815     4815           
  Misses                1358     1358           
  Partials               258      258

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 34d52a8...3f6a583. Read the comment docs.

ekapner · 2018-10-09T20:33:51Z

README.md

@@ -17,7 +17,7 @@ Currently, we have the following extensions:
 - [salesforcedx-vscode-apex](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex)  
   This extension uses the Apex Language Server to provide features such as syntax highlighting and code completion.
 - [salesforcedx-vscode-apex-debugger](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex-debugger)  
-   This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs.
+   This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs or to use ISV Customer Debugger.


You use "and" instead of "or" in example just below. Can they use both at once or either?

See my next comment.

packages/salesforcedx-vscode-apex-replay-debugger/README.md

ekapner · 2018-10-09T20:38:05Z

packages/salesforcedx-vscode-apex-replay-debugger/README.md

+
+        - Or, to convert an existing breakpoint into a checkpoint, right-click the breakpoint, and select **Edit Breakpoint** | **Expression**. Set the expression to `Checkpoint`.  
+
+    1. To upload your checkpoints to your org so that heap dump information can be collected, open the command palette, and run **SFDX: Update Checkpoints in Org**.


editing nit: "To upload your checkpoints to your org to collect heap dump info, open the..."

packages/salesforcedx-vscode-apex-replay-debugger/README.md

ekapner · 2018-10-09T20:42:35Z

packages/salesforcedx-vscode-apex/README.md

@@ -69,7 +69,7 @@ The Apex outline view shows the structure of the Apex class or trigger that’s
 ## Enable Code Smartness for SObjects
 To activate this extension’s code smartness features for standard and custom objects and their fields, including for custom fields on standard objects, press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows or Linux), and then select **SFDX: Refresh SObject Definitions** from the command palette. 

-When you refresh your sObject definitions, VS Code uses your default scratch org to generate faux Apex classes. These faux classes represent the standard and custom objects that the admin user of your default scratch org has access to. The classes are stored in a hidden directory on your local workstation. Don’t edit the faux classes! They are deleted and regenerated each time that you refresh your sObject definitions. To modify your sObjects, either modify the objects’ `.object-meta.xml` and `.field-meta.xml` files (and then run **SFDX: Push Source to Default Scratch Org**), or make changes declaratively in your scratch org (and then run **SFDX: Pull Source from Default Scratch Org**). The scratch org’s admin user doesn’t automatically gain access to new custom objects, so be sure to assign new permissions to the user as necessary. To assign permissions from the command line, run `sfdx force:user:permset:assign -n YourPermSetName`. 
+When you refresh your sObject definitions, VS Code uses your default org to generate faux Apex classes. These faux classes represent the standard and custom objects that the admin user of your default scratch org, or the logged-in user of your sandbox or DE org, has access to. The classes are stored in a hidden directory on your local workstation. Don’t edit the faux classes! They are deleted and regenerated each time that you refresh your sObject definitions. To modify your sObjects, either modify the objects’ `.object-meta.xml` and `.field-meta.xml` files (and then run **SFDX: Push Source to Default Scratch Org** or **SFDX: Deploy Source to Org**), or make changes declaratively in your org (and then run **SFDX: Pull Source from Default Scratch Org** or **SFDX: Retrieve Source from Org**). Your user doesn’t automatically gain access to new custom objects, so be sure to assign new permissions to the user as necessary. To assign permissions from the command line, run `sfdx force:user:permset:assign -n YourPermSetName`. 


Because of the addition of sandbox/DE, this sentence becomes less readable. So I suggest linking it back together:
These faux classes represent the standard and custom objects that the admin user has access to for your default scratch org, or the logged-in user of your sandbox or DE org.

ekapner · 2018-10-09T20:44:11Z

packages/salesforcedx-vscode-core/README.md

 * **[Visual Studio Code](https://code.visualstudio.com/download) v1.23 or later**  

+## Set Up a Default Scratch Org  
+To access the Visual Studio Code command palette, press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows or Linux). To create a scratch org and set it as your default org for development, run **SFDX: Authorize a Dev Hub** and then **SFDX: Create a Default Scratch Org**. Then, to push the source in our project to the scratch org, run **SFDX: Push Source to Default Scratch Org**. To open the org in your browser, run **SFDX: Open Default Org**. After you make changes in the Salesforce user interface, to pull those changes to your local project, run **SFDX: Pull Source from Default Scratch Org**.


I suspect you mean "your"
Then, to push the source in our project to the scratch org,...

lcampos · 2018-10-09T20:46:44Z

packages/salesforcedx-vscode-apex-replay-debugger/README.md

  1. To create a scratch org, you need a Dev Hub. To set up your production org as a Dev Hub, see [Enable Dev Hub in Your Org](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_enable_devhub.htm) in the _Salesforce DX Setup Guide_.  
  1. To authorize your Dev Hub, open VS Code’s command palette (Cmd+Shift+P on macOS, or Ctrl+Shift+P on Windows or Linux) and run **SFDX: Authorize a Dev Hub**.  
  1. To create a default scratch org, run **SFDX: Create a Default Scratch Org**. Then, run **SFDX: Push Source to Default Scratch Org**. For more information, see [Scratch Orgs](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs.htm) in the _Salesforce DX Developer Guide_.
-* **[Visual Studio Code](https://code.visualstudio.com/download) v1.23 or later** 
+* **[Visual Studio Code](https://code.visualstudio.com/download) v1.23 or later**  


We should change this to be 1.26 or later

lcampos · 2018-10-09T20:47:16Z

packages/salesforcedx-vscode-core/README.md

  Open your Salesforce DX project in a directory that contains an `sfdx-project.json` file. Otherwise, some features don’t work.  
+  If you don't already have a Salesforce DX project, create one with the **SFDX: Create Project** command (for development against scratch orgs) or the **SFDX: Create Project with Manifest** command (for development against sandboxes or DE orgs). Or, see [create a Salesforce DX project](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_workspace_setup.htm) for information about setting up a project using Salesforce CLI.  
 * **[Visual Studio Code](https://code.visualstudio.com/download) v1.23 or later**  


Same as above, change to 1.26 or later

ekapner · 2018-10-09T20:48:53Z

packages/salesforcedx-vscode-apex-debugger/README.md

@@ -1,5 +1,5 @@
 # Apex Debugger for Visual Studio Code
-This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs.
+This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs and to use ISV Customer Debugger.


After reading completely thru, sounds like you may want to add "...Apex Debugger with your scratch orgs, or to use ISV Customer Debugger for sandboxes or DE orgs." Something like that.

ekapner · 2018-10-09T20:50:01Z

packages/salesforcedx-vscode/README.md

@@ -21,7 +23,7 @@ To use Salesforce Extensions for VS Code, install all the extensions in this ext
 * [salesforcedx-vscode-apex](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex)  
   This extension uses the Apex Language Server to provide features such as syntax highlighting and code completion.
 * [salesforcedx-vscode-apex-debugger](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode-apex-debugger)  
-   This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs.
+   This extension enables VS Code to use the real-time Apex Debugger with your scratch orgs or to use ISV Customer Debugger.


Same comment as above - but now I'm going to ask if ISV cust debugger can be used with any org?

Just would say if you want to say here ...for ISV Customer Debugger for your subscribers' orgs. But I will defer to your discretion.

ekapner

Some feedback and questions to help clarify a couple things.

packages/salesforcedx-vscode-apex-replay-debugger/README.md

lcampos · 2018-10-09T21:04:06Z

We also need to update the wiki (https://github.com/forcedotcom/salesforcedx-vscode/wiki/Develop-Against-Any-Org-in-Visual-Studio-Code) as part of v44. @ruthemmanuelle is this something that should be done as part of a different review ?

@W-5444466, W-5220476@

ruthemmanuelle · 2018-10-09T21:27:18Z

@ntotten - See @lcampos 's comment about the wiki article. Are you going to update that (or delete it)? (We can't update it as part of this PR because you can't do PRs for wiki articles.)

@W-5444466, W-5220476@

JimSuplizio

I'm good with the updates. I know you're still making changes for other feedback but I'm happy with the checkpoints additions but I'm going to approve my piece. Thank you Ruth!

packages/salesforcedx-vscode-core/README.md

lcampos · 2018-10-09T22:09:47Z

@ntotten - See @lcampos 's comment about the wiki article. Are you going to update that (or delete it)? (We can't update it as part of this PR because you can't do PRs for wiki articles.)

BTW, @ntotten is out until next week so I'll take care of updating the wiki article as part of the release.

ruthemmanuelle added 4 commits October 9, 2018 13:50

Update docs for Replay Debugger GA

e1270a7

@W-5444466@

Update docs for Org Development updates

4793104

@W-5220476@

Fix formatting

feb5686

@W-5444466@

Clarify language

b9dd796

@W-5220476@

ruthemmanuelle commented Oct 9, 2018

View reviewed changes

ruthemmanuelle requested review from ekapner, lcampos and JimSuplizio October 9, 2018 20:17

ekapner reviewed Oct 9, 2018

View reviewed changes

JimSuplizio reviewed Oct 9, 2018

View reviewed changes

packages/salesforcedx-vscode-apex-replay-debugger/README.md Outdated Show resolved Hide resolved

ekapner reviewed Oct 9, 2018

View reviewed changes

JimSuplizio reviewed Oct 9, 2018

View reviewed changes

packages/salesforcedx-vscode-apex-replay-debugger/README.md Outdated Show resolved Hide resolved

ekapner reviewed Oct 9, 2018

View reviewed changes

lcampos reviewed Oct 9, 2018

View reviewed changes

ekapner reviewed Oct 9, 2018

View reviewed changes

JimSuplizio reviewed Oct 9, 2018

View reviewed changes

packages/salesforcedx-vscode-apex-replay-debugger/README.md Show resolved Hide resolved

JimSuplizio reviewed Oct 9, 2018

View reviewed changes

packages/salesforcedx-vscode-apex-replay-debugger/README.md Outdated Show resolved Hide resolved

ruthemmanuelle added 2 commits October 9, 2018 16:19

Incorporate review feedback

4063586

@W-5444466, W-5220476@

Incorporate review feedback

f60e776

@W-5444466, W-5220476@

Incorporate review feedback

3f6a583

@W-5444466, W-5220476@

JimSuplizio approved these changes Oct 9, 2018

View reviewed changes

ekapner approved these changes Oct 9, 2018

View reviewed changes

lcampos reviewed Oct 9, 2018

View reviewed changes

packages/salesforcedx-vscode-core/README.md Show resolved Hide resolved

lcampos approved these changes Oct 9, 2018

View reviewed changes

ruthemmanuelle merged commit 7c5a768 into release/v44.2.0 Oct 9, 2018

ruthemmanuelle deleted the ruth/release/v44.2.0 branch October 9, 2018 22:24

snyk-bot mentioned this pull request Jan 26, 2022

[Snyk] Security upgrade vsce from 1.62.0 to 2.6.4 Sarrac3873/salesforcedx-vscode#32

Open

Sarrac3873 mentioned this pull request Oct 6, 2022

[Snyk] Fix for 25 vulnerabilities Sarrac3873/salesforcedx-vscode#133

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ruth/release/v44.2.0 #666

Ruth/release/v44.2.0 #666

ruthemmanuelle commented Oct 9, 2018

ruthemmanuelle Oct 9, 2018

codecov bot commented Oct 9, 2018 •

edited

Loading

ekapner Oct 9, 2018

ekapner Oct 9, 2018

ekapner Oct 9, 2018

ekapner Oct 9, 2018

ekapner Oct 9, 2018 •

edited

Loading

lcampos Oct 9, 2018

lcampos Oct 9, 2018

ekapner Oct 9, 2018

ekapner Oct 9, 2018

ekapner Oct 9, 2018

ekapner left a comment

lcampos commented Oct 9, 2018

ruthemmanuelle commented Oct 9, 2018 •

edited

Loading

JimSuplizio left a comment

lcampos commented Oct 9, 2018


		- Or, to convert an existing breakpoint into a checkpoint, right-click the breakpoint, and select Edit Breakpoint \| Expression. Set the expression to `Checkpoint`.

		1. To upload your checkpoints to your org so that heap dump information can be collected, open the command palette, and run SFDX: Update Checkpoints in Org.

Ruth/release/v44.2.0 #666

Ruth/release/v44.2.0 #666

Conversation

ruthemmanuelle commented Oct 9, 2018

What does this PR do?

What issues does this PR fix or reference?

Choose a reason for hiding this comment

codecov bot commented Oct 9, 2018 • edited Loading

Codecov Report

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

ekapner Oct 9, 2018 • edited Loading

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

ekapner left a comment

Choose a reason for hiding this comment

lcampos commented Oct 9, 2018

ruthemmanuelle commented Oct 9, 2018 • edited Loading

JimSuplizio left a comment

Choose a reason for hiding this comment

lcampos commented Oct 9, 2018

codecov bot commented Oct 9, 2018 •

edited

Loading

ekapner Oct 9, 2018 •

edited

Loading

ruthemmanuelle commented Oct 9, 2018 •

edited

Loading