Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

130 lines (93 loc) · 6.29 KB
Raw

Contributor Onboarding

General

  • Helps start contributions to Durable Functions in JavaScript
  • Helps setup development environment across platforms for Durable Functions in JavaScript

Pre-reqs

Change flow

The general flow for making a change to the script host is:

  1. 🍴 Fork the repo (add the fork via git remote add me <clone url here>
  2. 🌳 Create a branch for your change (generally branch from dev) (git checkout -b my-change)
  3. 🛠 Make your change
  4. ✔️ Test your changes
  5. ⬆️ Push your changes to your fork (git push me my-change)
  6. 💌 Open a PR to the dev branch
  7. 📢 Address feedback and make sure tests pass (yes even if it's an "unrelated" test failure)
  8. 📦 Rebase your changes into a meaningful commits (git rebase -i HEAD~N where N is commits you want to squash)
  9. :shipit: Rebase and merge (This will be done for you if you don't have contributor access)
  10. ✂️ Delete your branch (optional)

End to End Development Setup: JavaScript library + Durable Extension (MacOS)

Setting up Azurite V2

Note: Azurite V3 does not have support for Table Storage yet. So falling back to Azurite V2 setup.

Create a folder say AzureWebJobsStorage

npm install [email protected] -g

azurite -l ./AzureWebJobsStorage

 _______                   _
(_______)                 (_)  _
 _______ _____ _   _  ____ _ _| |_ _____
|  ___  (___  ) | | |/ ___) (_   _) ___ |
| |   | |/ __/| |_| | |   | | | |_| ____|
|_|   |_(_____)____/|_|   |_| \__)_____)

Azurite, Version 2.7.1
A lightweight server clone of Azure Storage

Azure Table Storage Emulator listening on port 10002
Azure Queue Storage Emulator listening on port 10001
Azure Blob Storage Emulator listening on port 10000

Visual Studio Code Extensions

The following extensions should be installed if using Visual Studio Code for debugging:

  • C# for Visual Studio Code (powered by OmniSharp)
  • Azure Functions Extensions for Visual Studio Code v0.19.1 and above.

Setting up Durable JavaScript using sample code

  • Create a Durable Functions Orchestrator for FunctionChaining pattern using starter templates Note: In this starter template, ignore the line that says: "On a Mac or Linux computer, you must set the AzureWebJobsStorage property to the connection string of an existing Azure storage account". We will be setting up the AzureWebJobsStorage property to UseDevelopmentStorage=true

  • Then, in your sample code, instead of requiring the npm-hosted version of the code, directly refer to your local changes. There are many ways of going about this, but a simple solution is changing a reference to require("durable-functions") to require("<your-local-path-to-my-this-repo>").

  • Finally, start your VSCode editor, click Debug -> Start Debugging. This will internally start func host start through core tools and provides the orchestrator client URL. After doing this, you should be able to add breakpoints to test your changes for Durable JavaScript!

Debugging end-to-end with the Durable Extension

In some advanced scenarios, you may want to inspect how your repo interacts with the underlying Durable Extension. In these settings, we recommend using Visual Studio.

Two changes are necessary in your JavaScript sample code to make this work.

  • In host.json, remove the extensionsBundle portion to enable specific version debugging. Provide a hub name (else remove the entire extensions portion to default to DurableFunctionsHub) Here's how the host.json should look like:
{
  "version": "2.0",
  "extensions": {
    "durableTask": {
      "hubName": "{hubName}"
    }
  }
}
  • Create an extensions.csproj file containing the version of the DurableTask extension that you wish to use. We recommend using the latest version on nuget.org. To do this, take the sample extensions.csproj shown below, update the version of the Microsoft.Azure.WebJobs.Extensions.DurableTask dependency, and save it at the root of your sample.
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  <WarningsAsErrors></WarningsAsErrors>
  <DefaultItemExcludes>**</DefaultItemExcludes>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.DurableTask" Version="2.3.9" />
  </ItemGroup>
</Project>
  • Finally, open a terminal and run func extensions install. This will install the dependencies listed in your extensions.csproj file.

Now you are ready to start debugging Durable Functions end-to-end. Follow the instructions below:

  1. Open the Azure Storage Explorer and connect to the local storage emulator or the storage account you are using.
  2. In the VSCode editor for durable-js click Debug -> Start Debugging. This will internally start func host start through core tools and provides the orchestrator client URL
  3. In the Visual Studio editor for DurableTask, click Debug -> .NET Core Attach Process and search for func host start process and attach to it.
  4. Add a breakpoint in both editors and continue debugging.

Testing with emulated local storage (Windows)

When debugging your changes, you may want to use your local storage instead of an Azure account. To do this, follow all the steps above, use the Azure Storage Emulator for windows to simulate the storage account, and optionally use Visual Studio to debug the .NET Durable Extension.

Getting help

  • Leave comments on your PR and @username for attention