Add suborch sample, change requirements to latest version of SDK (#64)

davidmrdavid · web-flow · commit c53ede65b07c · 2023-06-15T16:21:17.000-07:00
diff --git a/samples/functionChaining/.funcignore b/samples/functionChaining/.funcignore
@@ -3,5 +3,4 @@
 __azurite_db*__.json
 __blobstorage__
 __queuestorage__
-local.settings.json
 test
diff --git a/samples/functionChaining/README.md b/samples/functionChaining/README.md
@@ -3,6 +3,7 @@
 ## Pre-requisites
 
 You'll need core tools version v4.0.5095+. Please run `func --version` to ensure your core tools version is compatible.
+If you need to install core tools, please see these [installation instructions](https://github.com/Azure/azure-functions-core-tools#installing).
 
 ## How to try it out
 
@@ -14,7 +15,7 @@ You may use this as the starting point for experimentation.
 This has been done for you in `requirements.psd1`, by including the following line:
 
 ```json
-'AzureFunctions.PowerShell.Durable.SDK' = '1.0.0-alpha'
+'AzureFunctions.PowerShell.Durable.SDK' = '1.*'
 ```
 
 ### 2. Import the SDK in your `profile.ps1`.
diff --git a/samples/functionChaining/local.settings.json b/samples/functionChaining/local.settings.json
@@ -0,0 +1,9 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+    "FUNCTIONS_WORKER_RUNTIME_VERSION": "7.2",
+    "FUNCTIONS_WORKER_RUNTIME": "powershell",
+    "ExternalDurablePowerShellSDK": "true"
+  }
+}
diff --git a/samples/functionChaining/profile.ps1 b/samples/functionChaining/profile.ps1
@@ -20,4 +20,6 @@ if ($env:MSI_SECRET) {
 # Enable-AzureRmAlias
 
 # You can also define functions or aliases that can be referenced in any of your PowerShell functions.
+
+# Import standalone Durable Functions SDK
 Import-Module AzureFunctions.PowerShell.Durable.SDK -ErrorAction Stop
diff --git a/samples/functionChaining/requirements.psd1 b/samples/functionChaining/requirements.psd1
@@ -5,5 +5,5 @@
     # For latest supported version, go to 'https://www.powershellgallery.com/packages/Az'.
     # To use the Az module in your function app, please uncomment the line below.
     # 'Az' = '9.*'
-    'AzureFunctions.PowerShell.Durable.SDK' = '1.0.0-alpha'
+    'AzureFunctions.PowerShell.Durable.SDK' = '1.*'
 }
diff --git a/samples/simpleSubOrchestrator/.funcignore b/samples/simpleSubOrchestrator/.funcignore
@@ -0,0 +1,6 @@
+.git*
+.vscode
+__azurite_db*__.json
+__blobstorage__
+__queuestorage__
+test
diff --git a/samples/simpleSubOrchestrator/DurableFunctionsHttpStart/function.json b/samples/simpleSubOrchestrator/DurableFunctionsHttpStart/function.json
@@ -0,0 +1,25 @@
+{
+  "bindings": [
+    {
+      "authLevel": "anonymous",
+      "name": "Request",
+      "type": "httpTrigger",
+      "direction": "in",
+      "route": "orchestrators/{FunctionName}",
+      "methods": [
+        "post",
+        "get"
+      ]
+    },
+    {
+      "type": "http",
+      "direction": "out",
+      "name": "Response"
+    },
+    {
+      "name": "starter",
+      "type": "durableClient",
+      "direction": "in"
+    }
+  ]
+}
diff --git a/samples/simpleSubOrchestrator/DurableFunctionsHttpStart/run.ps1 b/samples/simpleSubOrchestrator/DurableFunctionsHttpStart/run.ps1
@@ -0,0 +1,10 @@
+using namespace System.Net
+
+param($Request, $TriggerMetadata)
+
+$FunctionName = $Request.Params.FunctionName
+$InstanceId = Start-DurableOrchestration -FunctionName $FunctionName
+Write-Host "Started orchestration with ID = '$InstanceId'"
+
+$Response = New-DurableOrchestrationCheckStatusResponse -Request $Request -InstanceId $InstanceId
+Push-OutputBinding -Name Response -Value $Response
diff --git a/samples/simpleSubOrchestrator/DurableFunctionsOrchestrator/function.json b/samples/simpleSubOrchestrator/DurableFunctionsOrchestrator/function.json
@@ -0,0 +1,9 @@
+{
+  "bindings": [
+    {
+      "name": "Context",
+      "type": "orchestrationTrigger",
+      "direction": "in"
+    }
+  ]
+}
diff --git a/samples/simpleSubOrchestrator/DurableFunctionsOrchestrator/run.ps1 b/samples/simpleSubOrchestrator/DurableFunctionsOrchestrator/run.ps1
@@ -0,0 +1,21 @@
+param($Context)
+
+$output = @()
+
+# inputs to process
+$inputs = @('Tokyo', 'Seattle', 'London', 'Lima', 'Cairo', 'New York', 'Sydney', 'Berlin', 'Paris')
+
+# batch inputs into sub-lists of 3 items
+$subOrchestrators = @()
+for ($i = 0; $i -lt $inputs.Length; $i += 3) {
+    # create a sub-orchestration task for each batch
+    # each sub-orchestration will then fan-out over its own batch of inputs
+    $batchedInput = $inputs[$i..($i+2)]
+    $subOrchestrators += Invoke-DurableSubOrchestrator -FunctionName 'SubOrchestrator' -Input $batchedInput -NoWait
+}
+
+# fan-out over all sub-orchestrator tasks and aggregate results
+$output = Wait-DurableTask -Task $subOrchestrators
+
+# final expression is the return statement
+$output
diff --git a/samples/simpleSubOrchestrator/Hello/function.json b/samples/simpleSubOrchestrator/Hello/function.json
@@ -0,0 +1,9 @@
+{
+  "bindings": [
+    {
+      "name": "name",
+      "type": "activityTrigger",
+      "direction": "in"
+    }
+  ]
+}
diff --git a/samples/simpleSubOrchestrator/Hello/run.ps1 b/samples/simpleSubOrchestrator/Hello/run.ps1
@@ -0,0 +1,3 @@
+param($name)
+
+"Hello $name!"
diff --git a/samples/simpleSubOrchestrator/README.md b/samples/simpleSubOrchestrator/README.md
@@ -0,0 +1,47 @@
+# Sub Orchestrator sample
+
+## Pre-requisites
+
+You'll need core tools version v4.0.5095+. Please run `func --version` to ensure your core tools version is compatible.
+If you need to install core tools, please see these [installation instructions](https://github.com/Azure/azure-functions-core-tools#installing).
+
+## How to try it out
+
+This repo already contains the basic project structure for a function-chaining Durable Functions PowerShell app.
+You may use this as the starting point for experimentation.
+
+### 1. Install the SDK from the PowerShell Gallery
+
+This has been done for you in `requirements.psd1`, by including the following line:
+
+```json
+'AzureFunctions.PowerShell.Durable.SDK' = '1.*'
+```
+
+### 2. Import the SDK in your `profile.ps1`.
+
+This has been done for you in this starter project.
+Please verify that the `profile.ps1` file contains the following line:
+
+```powershell
+Import-Module AzureFunctions.PowerShell.Durable.SDK -ErrorAction Stop
+```
+
+### 3. Set the env variable `ExternalDurablePowerShellSDK` to `"true"`.
+
+This has been done for you in this repo's starter project.
+Please verify that this setting is set in your `local.settings.json`.
+
+### 4. Try it!
+
+Run `func host start` and run the orchestrator with a GET request to `http://localhost:7071/api/orchestrators/DurableFunctionsOrchestrator`.
+
+### 6. Confirm you're using the new SDK
+
+Since the new SDK is backwards compatible with the old one, it's worth doing a sanity check that you are actually using the new experience.
+
+To do this, run `func host start --verbose`, start the orchestrator by performing a GET request to `http://localhost:7071/api/orchestrators/DurableFunctionsOrchestrator`, and finally CTRL+F for the following log: `Utilizing external Durable Functions SDK: 'True'`. If you can find it, you're using the new experience.
+
+## If you deploy to Azure
+
+You will need to set the `ExternalDurablePowerShellSDK` application setting to `"true"`.
diff --git a/samples/simpleSubOrchestrator/SubOrchestrator/function.json b/samples/simpleSubOrchestrator/SubOrchestrator/function.json
@@ -0,0 +1,9 @@
+{
+  "bindings": [
+    {
+      "name": "Context",
+      "type": "orchestrationTrigger",
+      "direction": "in"
+    }
+  ]
+}
diff --git a/samples/simpleSubOrchestrator/SubOrchestrator/run.ps1 b/samples/simpleSubOrchestrator/SubOrchestrator/run.ps1
@@ -0,0 +1,13 @@
+param($Context)
+
+# iterate over inputs, create a "Hello" activity task per input
+$tasks = @()
+foreach ($input in $Context.Input)
+{
+    $tasks += Invoke-DurableActivity -FunctionName "Hello" -Input $input -NoWait
+}
+
+# fan-out over all activity tasks and aggregate results
+$output = Wait-DurableTask -Task $tasks
+
+$output
diff --git a/samples/simpleSubOrchestrator/host.json b/samples/simpleSubOrchestrator/host.json
@@ -0,0 +1,18 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "managedDependency": {
+    "enabled": true
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[3.*, 4.0.0)"
+  },
+}
diff --git a/samples/simpleSubOrchestrator/local.settings.json b/samples/simpleSubOrchestrator/local.settings.json
@@ -0,0 +1,9 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
+    "FUNCTIONS_WORKER_RUNTIME_VERSION": "7.2",
+    "FUNCTIONS_WORKER_RUNTIME": "powershell",
+    "ExternalDurablePowerShellSDK": "true"
+  }
+}
diff --git a/samples/simpleSubOrchestrator/profile.ps1 b/samples/simpleSubOrchestrator/profile.ps1
@@ -0,0 +1,25 @@
+# Azure Functions profile.ps1
+#
+# This profile.ps1 will get executed every "cold start" of your Function App.
+# "cold start" occurs when:
+#
+# * A Function App starts up for the very first time
+# * A Function App starts up after being de-allocated due to inactivity
+#
+# You can define helper functions, run commands, or specify environment variables
+# NOTE: any variables defined that are not environment variables will get reset after the first execution
+
+# Authenticate with Azure PowerShell using MSI.
+# Remove this if you are not planning on using MSI or Azure PowerShell.
+if ($env:MSI_SECRET) {
+    Disable-AzContextAutosave -Scope Process | Out-Null
+    Connect-AzAccount -Identity
+}
+
+# Uncomment the next line to enable legacy AzureRm alias in Azure PowerShell.
+# Enable-AzureRmAlias
+
+# You can also define functions or aliases that can be referenced in any of your PowerShell functions.
+
+# Import standalone Durable Functions SDK
+Import-Module AzureFunctions.PowerShell.Durable.SDK -ErrorAction Stop
diff --git a/samples/simpleSubOrchestrator/requirements.psd1 b/samples/simpleSubOrchestrator/requirements.psd1
@@ -0,0 +1,9 @@
+# This file enables modules to be automatically managed by the Functions service.
+# See https://aka.ms/functionsmanageddependency for additional information.
+#
+@{
+    # For latest supported version, go to 'https://www.powershellgallery.com/packages/Az'.
+    # To use the Az module in your function app, please uncomment the line below.
+    # 'Az' = '9.*'
+    'AzureFunctions.PowerShell.Durable.SDK' = '1.*'
+}

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,5 @@`
`5`	`5`	`# For latest supported version, go to 'https://www.powershellgallery.com/packages/Az'.`
`6`	`6`	`# To use the Az module in your function app, please uncomment the line below.`
`7`	`7`	`# 'Az' = '9.*'`
`8`		`- 'AzureFunctions.PowerShell.Durable.SDK' = '1.0.0-alpha'`
	`8`	`+ 'AzureFunctions.PowerShell.Durable.SDK' = '1.*'`
`9`	`9`	`}`