Test a Function Locally

Test functions in your local environment before you deploy to a compute environment. Build and run your function with the Salesforce CLI and invoke it locally.

Previously, local Salesforce Functions development required using a container like Docker. Containers are no longer required to run a function locally. Learn more about Local Function Invocations.

Note

Build and Run the Function Locally

Navigate to the function directory and build and run your function:

1sf run function start

The function is ready to receive requests when you see Starting myfunction. The function continues to run and waits for requests until you use Ctrl-C to stop. Leave the terminal window running and open a new terminal window for the next step.

Invoke the Function

To test a running function, send it a JSON payload. Create a payload.json file in your function directory:

1{
2  "name": "MyAccount",
3  "accountNumber": "123456789",
4  "industry": "Technology",
5  "type": "Prospect",
6  "website": "www.salesforce.com"
7}

Navigate to your project root directory and invoke the function, which is now running on your localhost:

1sf run function -l http://localhost:8080 -p '@functions/myfunction/payload.json'

-l running function URL
-p the payload to send to the function

This command invokes the function running on localhost port 8080 (the default for locally running functions) with the payload JSON file. The output looks something like:

1Using defaultusername MyScratchOrgAlias login credential to initialize context
2POST http://localhost:8080... 200
3{
4  "done": true,
5  "totalSize": 1,
6  "records": [
7    {
8      "type": "Account",
9      "fields": {
10        "id": "00163000012fAD0AAM",
11        "isdeleted": false,
12        "masterrecordid": null,
13        "name": "MyAccount-1623718504016",
14
15        ...fields omitted...
16
17        "yearstarted": null,
18        "sicdesc": null,
19        "dandbcompanyid": null,
20        "operatinghoursid": null
21      }
22    }
23  ]
24}

The execution logs stream in the terminal running the function (where you ran sf run function start). The output looks something like this:

1{"level":30,"time":1623718504015,"pid":1,"hostname":"39f3353de3f7",
2"invocationId":"a9c869ab-2130-42e0-9615-b342c8b97bd1","msg":"Invoking
3 Myfunction with payload {\"name\":\"MyAccount\",
4 \"accountNumber\":\"123456789\",\"industry\":\"Technology\",
5 \"type\":\"Prospect\",\"website\":\"www.salesforce.com\"}"}

Stop the Function

To stop the function, enter Ctrl-C in the terminal window where you ran sf run function start.

Product Retirement Announcement

Salesforce Functions is no longer available for purchase or renewal. To preserve the capabilities that Salesforce Functions provided to your org, deploy an alternative solution before your existing order term ends. See Salesforce Functions Retirement for more information on migrating your functions. Contact your Salesforce Account Executive for more information on Heroku.