Debugging Salesforce Tests with VS Code

Debugging in Salesforce is relatively new and it immature compared to debugging in Visual Studio or Eclipse.  Even Microsoft Access has a better debugger than Salesforce.  Essentially logs files are created when running tests and then the log files are used to step through the code.  It is after the fact debugging, you cannot change the path that the code has gone.

If you haven't already, set up VS Code for Salesforce

1. Click the Debug icon
2. In the drop down list at the top under Debug, Add Configuration.  Select Apex Replay Debugger
3. Make sure that you have pulled all your code and tests down from source control or from your org.
4. Using Ctrl-Shift-P on Windows or Command-Shift-P on a Mac, select SFDX: Turn On Apex Debug Log for Replay Debugger
5. Set a break point in your test
6. Run your test by clicking Run Test above the test method name in VS Code 
7. Using Ctrl-Shift-P on Windows or Command-Shift-P on a Mac, select SFDX: Turn Off Apex Debug Log for Replay Debugger
8. Using Ctrl-Shift-P on Windows or Command-Shift-P on a Mac, select SFDX: Get Apex Debug Logs
9. Click the Debug icon
10. Click the Launch Apex Replay Debugger
11. You can see local variables on the left and you can step into code

Setting Up VS Code with Salesforce

These are step by step instructions to get VS Code working with Salesforce.

1. Go to your Sandbox, under Setup search for Dev Hub.  Enable Dev Hub and GA.  This will allow you to create scratch orgs.
2. Install the Salesforce CLI which will allow you to push and pull code and run tests:   https://developer.salesforce.com/tools/sfdxcli
3. Install VS Code which is now the standard for editing code for Salesforce:  https://code.visualstudio.com/download
4. Install Java if you do not have it installed yet.  The Salesforce Extension Pack requires it.  https://www.java.com/en/download/
5. Install the Salesforce Extension Pack.  In VS Code, click the extensions icon and search for Salesforce Extension Pack.
6. Install Lightning Web Components extension in VS Code

If your Salesforce code is in your org and not in source control then you are in Classic Development and not Salesforce DX.  

Classic Development Mode (directly interact with an Org)

See these instructions: 
https://forcedotcom.github.io/salesforcedx-vscode/articles/user-guide/org-development-model

* After creating the project, create these folders under the default folder before doing a Retrieve Source From Org:  

• classes
• objects

Salesforce DX Mode (your source is in GitHub or Bitbucket)

Example of cloning a repository, creating a scratch org and pushing the code

git clone https://github.com/dreamhouseapp/dreamhouse-sfdx

cd dreamhouse-sfdx

sfdx force:config:set defaultdevhubusername=your@username.com

sfdx force:org:create -a dreamhouse -s -f config\project-scratch-def.json -d 7

sfdx force:source:push

sfdx force:user:permset:assign -n dreamhouse

sfdx force:org:open -p /lightning/page/home

Using Caching in the .NET Framework

Caching is easy to use in the .NET Framework

According to Microsoft:

"In the .NET Framework 3.5 and earlier versions, ASP.NET provided an in-memory cache implementation in the System.Web.Caching namespace. In previous versions of the .NET Framework, caching was available only in the System.Web namespace and therefore required a dependency on ASP.NET classes. In the .NET Framework 4, the System.Runtime.Caching namespace contains APIs that are designed for both Web and non-Web applications."

Here are a couple methods to Load and Save from the Memory Cache.  If the value is not found, it will be null.  

public static class Cache

{

        public static TResult Load<TResult>(string cacheKeyName)

        {

            ObjectCache cacheInstance = MemoryCache.Default;

            return (TResult)cacheInstance[cacheKeyName];

        }

        public static T Save<T> (string cacheKeyName, DateTimeOffset expirationDate, T value)

        {

            CacheItemPolicy cacheItemPolicy = new CacheItemPolicy();

            cacheItemPolicy.AbsoluteExpiration = expirationDate;

            ObjectCache cacheInstance = MemoryCache.Default;

            cacheInstance.Set(cacheKeyName, value, cacheItemPolicy);

            return value;

        }

}

Example Call to Load and Save

Here is an example of using the load and save with a stopwatch so that the time saved can be shown:

        [Test]

        public void SimpleLoadAndSaveTest()

        {

            Stopwatch watch = Stopwatch.StartNew();

            string json = Cache.Load<string>("JsonValue");

            if (json == null)

            {

                json = GetJsonFromWebService("cf4174ce-96d2-495c-b58a-427d35f64a20");

                Cache.Save("JsonValue", DateTimeOffset.Now.AddMinutes(20), json);

            }

            watch.Stop();

            Console.WriteLine(watch.ElapsedMilliseconds);

            watch.Restart();

            json = Cache.Load<string>("JsonValue");

            watch.Stop();

            Console.WriteLine(watch.ElapsedMilliseconds);

        }

        public string GetJsonFromWebService(string value)

        {

            Thread.Sleep(1000);

            return "{ \"Value\" : \"" + value + "\" }";

        }

Cache Class

I have created a larger caching class where methods can be passed into shorten the code:

    public static class Cache

    {

        public static TResult Load<TResult>(string cacheKeyName)

        {

            ObjectCache cacheInstance = MemoryCache.Default;

            return (TResult)cacheInstance[cacheKeyName];

        }

        public static T Save<T> (string cacheKeyName, DateTimeOffset expirationDate, T value)

        {

            CacheItemPolicy cacheItemPolicy = new CacheItemPolicy();

            cacheItemPolicy.AbsoluteExpiration = expirationDate;

            ObjectCache cacheInstance = MemoryCache.Default;

            cacheInstance.Set(cacheKeyName, value, cacheItemPolicy);

            return value;

        }

        public static TResult Load<TResult>(string cacheKeyName, int expirationMinutes, Func<TResult> serviceFunction)

        {

            return Load<TResult>(cacheKeyName, DateTimeOffset.Now.AddMinutes(expirationMinutes), serviceFunction);

        }

        public static TResult Load<TResult>(string cacheKeyName, int expirationMinutes, Func<string, TResult> serviceFunction, string stringArg)

        {

            return Load<TResult>(cacheKeyName, DateTimeOffset.Now.AddMinutes(expirationMinutes), serviceFunction, stringArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, int expirationMinutes, Func<long, TResult> serviceFunction, long longArg)

        {

            return Load<TResult>(cacheKeyName, DateTimeOffset.Now.AddMinutes(expirationMinutes), serviceFunction, longArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, int expirationMinutes, Func<int, TResult> serviceFunction, int intArg)

        {

            return Load<TResult>(cacheKeyName, DateTimeOffset.Now.AddMinutes(expirationMinutes), serviceFunction, intArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTime expirationDate, Func<TResult> serviceFunction)

        {

            return Load<TResult>(cacheKeyName, new DateTimeOffset(expirationDate), serviceFunction);

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTime expirationDate, Func<string, TResult> serviceFunction, string stringArg)

        {

            return Load<TResult>(cacheKeyName, new DateTimeOffset(expirationDate), serviceFunction, stringArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTime expirationDate, Func<long, TResult> serviceFunction, long longArg)

        {

            return Load<TResult>(cacheKeyName, new DateTimeOffset(expirationDate), serviceFunction, longArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTime expirationDate, Func<int, TResult> serviceFunction, int intArg)

        {

            return Load<TResult>(cacheKeyName, new DateTimeOffset(expirationDate), serviceFunction, intArg);

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTimeOffset expirationDateOffset, Func<TResult> serviceFunction) 

        {

            TResult cachedObject = Load<TResult>(cacheKeyName);

            if (cachedObject == null)

            {                

                cachedObject = Save(cacheKeyName, expirationDateOffset, serviceFunction());

            }

            return cachedObject;

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTimeOffset expirationDateOffset, Func<string, TResult> serviceFunction, string stringArg)

        {

            TResult cachedObject = Load<TResult>(cacheKeyName);

            if (cachedObject == null)

            {

                cachedObject = Save(cacheKeyName, expirationDateOffset, serviceFunction(stringArg));

            }

            return cachedObject;

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTimeOffset expirationDateOffset, Func<long, TResult> serviceFunction, long longArg)

        {

            TResult cachedObject = Load<TResult>(cacheKeyName);

            if (cachedObject == null)

            {

                cachedObject = Save(cacheKeyName, expirationDateOffset, serviceFunction(longArg));

            }

            return cachedObject;

        }

        public static TResult Load<TResult>(string cacheKeyName, DateTimeOffset expirationDateOffset, Func<int, TResult> serviceFunction, int intArg)

        {

            TResult cachedObject = Load<TResult>(cacheKeyName);

            if (cachedObject == null)

            {

                cachedObject = Save(cacheKeyName, expirationDateOffset, serviceFunction(intArg));

            }

            return cachedObject;

        }

    }

Example using Func with Caching

The function can be passed in that will fill the data if it does not exist in the cache.

        [Test]

        public void CacheTestUsingFunc()

        {

            Stopwatch watch = Stopwatch.StartNew();

            string json = Cache.Load<string>("JsonValue", 20, GetJsonFromWebService, "cf4174ce-96d2-495c-b58a-427d35f64a20");

            watch.Stop();

            Console.WriteLine(watch.ElapsedMilliseconds);

            watch.Restart();

            json = Cache.Load<string>("JsonValue", 20, GetJsonFromWebService, "cf4174ce-96d2-495c-b58a-427d35f64a20");

            watch.Stop();

            Console.WriteLine(watch.ElapsedMilliseconds);

        }

        public string GetJsonFromWebService(string value)

        {

            Thread.Sleep(1000);

            return "{ \"Value\" : \"" + value + "\" }";

        }

RhinoMocks Resources

Main Site

https://www.hibernatingrhinos.com/oss/rhino-mocks

https://www.nuget.org/packages/RhinoMocks/3.6.1

Videos

Rhino Mocks Fundamentals
https://www.pluralsight.com/courses/rhinomock-fundamentals

Tutorials

Unit testing with Mock objects (Rhino Mocks)
https://www.codeproject.com/Articles/686935/Unit-testing-with-Mock-objects-Rhino-Mocks

GETTING STARTED WITH RHINO MOCKS (AAA)
https://adamprescott.net/2011/04/07/getting-started-with-rhino-mocks-aaa/

Using Rhino.Mocks - quick guide to generating mocks and stubs
https://www.wrightfully.com/using-rhino-mocks-quick-guide-to-generating-mocks-and-stubs/

TDD : Introduction to Rhino Mocks
http://stephenwalther.com/archive/2008/03/23/tdd-introduction-to-rhino-mocks

Cheat Sheets

https://www.cheatography.com/gregfinzer/cheat-sheets/rhinomocks/

https://ayende.com/wiki/GetFile.aspx?File=Rhino+Mocks+3.3+Quick+Reference.pdf&AspxAutoDetectCookieSupport=1

https://lukewickstead.wordpress.com/2013/03/10/rhino-mocks-cheat-sheet/

http://www.rulecity.com/browse/rhino.html

SASS Resources

SASS transpiles into CSS.  Here are some resources:

MAIN SITE

http://sass-lang.com/

TUTORIALS

http://sass-lang.com/guide

https://scotch.io/tutorials/getting-started-with-sass

https://www.tutorialspoint.com/sass/

https://tutorialzine.com/2016/01/learn-sass-in-15-minutes

VIDEOS

Derek Banas: Learn SASS in One Video
https://www.youtube.com/watch?v=wz3kElLbEHE

Rush through SASS for CSS in 7 Minutes
https://www.youtube.com/watch?v=pw1DeLy2Xsw

The NET Ninja:  Ninja SASS Course
https://www.youtube.com/watch?v=St5B7hnMLjg&list=PL4cUxeGkcC9iEwigam3gTjU_7IA3W2WZA

Cheat Sheets

https://www.cheatography.com/hamidyfine/cheat-sheets/sass-functions/

https://www.cheatography.com/mist-graphx/cheat-sheets/sass-script/

HTML Resources

Good reference site

https://www.w3schools.com/html/

Tuitorials

https://www.quackit.com/html/

https://www.tutorialspoint.com/html/index.htm

Videos

HTML5 & CSS3 for Absolute Beginners

https://mva.microsoft.com/en-US/training-courses/14207

HTML Quick References

https://www.cheatography.com/davechild/cheat-sheets/html4/

https://www.cheatography.com/cheatography/cheat-sheets/html-5/

Debugging Jasmine Tests with Karma and Visual Studio Code

1. The Visual Studio Code Debugger only works with specific combinations of the Debugger for Chrome, Visual Studio Code, Angular CLI and Angular.  Make sure you are using the latest version of all libraries, extensions and tools or you will get the dreaded Breakpoint ignored because generated code not found.  For example, Angular 4.0 with the 1.0 version of Angular CLI does not work but Angular 4.1.3 with Angular CLI 1.0.6 works fine.
2. Install the Visual Studio Code Extension, Chrome Debugger by clicking on the extensions icon on the left in Visual Code, searching for Chrome and clicking Install.
3. On the Debug menu, click Open Configurations.

4. Modify your .vscode\launch.json to be this:

{

"version": "0.2.0",

"configurations": [

{

"type": "chrome",

"request": "launch",

"name": "Launch Chrome against localhost",

"url": "http://localhost:4200",

"webRoot": "${workspaceRoot}"

},

{

"type":"chrome",

"request": "launch",

"name": "Launch Chrome against Karma",

"url": "http://localhost:9876/?id=9792346",

"webRoot": "${workspaceRoot}"

}

]

}

5.  CLOSE ALL Chrome Browsers

6.  Run npm start at the command line in the directory for your application.

7. Run karma start at another command window in the directory for your application
8. Click the Debug icon on the left
9. Set a breakpoint

10. Choose Launch Chrome against Karma.  After the browser comes up, refresh it.