Upgrade to PowerShell 7.4 (#900)

* Upgrade to PowerShell SDK 7.4.0-preview.1

* Upgrade to .NET SDK 7.0

* Update README.md to target net7.0 and PowerShell 7.4

* Upgrade TargetFramework to net7.0

* Update tests: Convertfrom-Json returns an ordered hashtable

* Reset build counter for PowerShell 7.4

* Update package id to Microsoft.Azure.Functions.PowerShellWorker.PS7.4

* Add PowerShell 7.4 to the list of supported versions

* Update E2E tests to target PowerShell 7.4

* Remove logic to create case-insensitive hashtable from the ConvertFromJson output

* Update tests

* Add support to update the PowerShell 7.2 and 7.4 language workers in the Core Tools

* Try to create a case insensitive Hashtable for the DurableClient when deserializing JSON

* Update ConvertFromJson logic for Durable client

* Add test case to validate TypedDataToCaseInsensitiveHashtable deserialization

* Update build.ps1 logging

Author: Francisco-Gamino

README.md

@@ -49,7 +49,7 @@ with any additional questions or comments.
 
 ### Prereqs
 
-* [.NET 6.0 SDK](https://www.microsoft.com/net/download/visual-studio-sdks)
+* [.NET 7.0 SDK](https://www.microsoft.com/net/download/visual-studio-sdks)
 
 ### Build
 
@@ -82,18 +82,18 @@ On macOS if you installed via `brew`
 /usr/local/Cellar/azure-functions-core-tools/<version>/workers/
 ```
 
-Under the `workers/powershell` folder, create a folder with the name `7.2` if it does not exist yet. Copy the result of the `publish` directory into the `workers/powershell/7.2` folder, and copy the `publish/worker.config.json` file into the `workers/powershell` folder:
+Under the `workers/powershell` folder, create a folder with the name `7.4` if it does not exist yet. Copy the result of the `publish` directory into the `workers/powershell/7.4` folder, and copy the `publish/worker.config.json` file into the `workers/powershell` folder:
 ```powershell
-Copy-Item -Recurse -Force ./src/bin/Debug/net6.0/publish/ "/usr/local/Cellar/azure-functions-core-tools/$(func --version)/workers/powershell/7.2"
-Copy-Item -Recurse -Force ./src/bin/Debug/net6.0/publish/worker.config.json "/usr/local/Cellar/azure-functions-core-tools/$(func --version)/workers/powershell"
+Copy-Item -Recurse -Force ./src/bin/Debug/net7.0/publish/ "/usr/local/Cellar/azure-functions-core-tools/$(func --version)/workers/powershell/7.4"
+Copy-Item -Recurse -Force ./src/bin/Debug/net7.0/publish/worker.config.json "/usr/local/Cellar/azure-functions-core-tools/$(func --version)/workers/powershell"
 ```
 
 > NOTE: if the powershell folder already exists, you should delete it or debugging won't work.
 
 Then `cd` into a Function App with PowerShell as the worker runtime 
 (NOTE: There's an example PowerShell Function App in the `examples` folder).
 
-Set the environment variable `FUNCTIONS_WORKER_RUNTIME_VERSION` to `7.2`, or add this as an app setting to the `local.settings.json` file.
+Set the environment variable `FUNCTIONS_WORKER_RUNTIME_VERSION` to `7.4`, or add this as an app setting to the `local.settings.json` file.
 
 Lastly, run:
 
@@ -119,15 +119,15 @@ set the environment variable `"AzureWebJobsScriptRoot"`
 to the root folder path (the folder which contains the `host.json`)
 of your test functions app.
 
-Under the `workers/powershell` folder, create a folder with the name `7.2` if it does not exist yet. Then copy the `publish` directory to `workers/powershell/7.2`, and the `publish/worker.config.json` to `workers/powershell`:
+Under the `workers/powershell` folder, create a folder with the name `7.4` if it does not exist yet. Then copy the `publish` directory to `workers/powershell/7.4`, and the `publish/worker.config.json` to `workers/powershell`:
 ```powershell
-Copy-Item -Recurse -Force ./src/bin/Debug/net6.0/publish/ "<Azure Functions Host Root>/src/WebJobs.Script.WebHost/bin/Debug/net6.0/workers/powershell/7.2"
-Copy-Item -Force ./src/bin/Debug/net6.0/publish/worker.config.json "<Azure Functions Host Root>/src/WebJobs.Script.WebHost/bin/Debug/net6.0/workers/powershell"
+Copy-Item -Recurse -Force ./src/bin/Debug/net7.0/publish/ "<Azure Functions Host Root>/src/WebJobs.Script.WebHost/bin/Debug/net7.0/workers/powershell/7.4"
+Copy-Item -Force ./src/bin/Debug/net7.0/publish/worker.config.json "<Azure Functions Host Root>/src/WebJobs.Script.WebHost/bin/Debug/net7.0/workers/powershell"
 ```
 
 Then you can start the host by running:
 ```sh
-dotnet ./src/WebJobs.Script.WebHost/bin/Debug/net6.0/Microsoft.Azure.WebJobs.Script.WebHost.dll
+dotnet ./src/WebJobs.Script.WebHost/bin/Debug/net7.0/Microsoft.Azure.WebJobs.Script.WebHost.dll
 ```
 
 > Note: Remember to remove `"AzureWebJobsScriptRoot"`
@@ -149,6 +149,6 @@ That will place a `Microsoft.Azure.Functions.PowerShellWorker.*.nupkg` in:
 
 It pulls the contents of the publish folder in:
 
-`azure-functions-powershell-worker/src/bin/Debug/net6.0/publish`
+`azure-functions-powershell-worker/src/bin/Debug/net7.0/publish`
 
 if you specify a different Configuration or TargetFramework that will be honored.

azure-pipelines.yml

@@ -21,7 +21,7 @@ pool:
 
 variables:
   Configuration: Release
-  buildNumber: $[ counter('build', 400) ] # Start higher than our AppVeyor versions. Every build (pr or branch) will increment.
+  buildNumber: $[ counter('build', 001) ] # Start higher than our AppVeyor versions. Every build (pr or branch) will increment.
 
 steps:
 - pwsh: |

build.ps1

@@ -34,13 +34,33 @@ param(
     $AddSBOM,
 
     [string]
-    $SBOMUtilSASUrl
+    $SBOMUtilSASUrl,
+
+    [string]
+    [ValidateSet("7.2", "7.4")]
+    $WorkerVersion
 )
 
-#Requires -Version 6.0
+#Requires -Version 7.0
+
+Import-Module "$PSScriptRoot/tools/helper.psm1" -Force
+
+$PowerShellVersion = $null
+$TargetFramework = $null
+$DefaultPSWorkerVersion = '7.4'
+
+if (-not $workerVersion)
+{
+    Write-Log "Worker version not specified. Setting workerVersion to '$DefaultPSWorkerVersion'"
+    $workerVersion = $DefaultPSWorkerVersion
+}
+
+$PowerShellVersion = $WorkerVersion
+Write-Log "Build worker version: $PowerShellVersion"
 
-$PowerShellVersion = '7.2'
-$TargetFramework = 'net6.0'
+# Set target framework for 7.2 to net6.0 and for 7.4 to net7.0
+$TargetFramework = ($PowerShellVersion -eq "7.2") ? 'net6.0' : 'net7.0'
+Write-Log "Target framework: $TargetFramework"
 
 function Get-FunctionsCoreToolsDir {
     if ($CoreToolsDir) {
@@ -76,7 +96,7 @@ function Install-SBOMUtil
     }
 
     $MANIFESTOOLNAME = "ManifestTool"
-    Write-Host "Installing $MANIFESTOOLNAME..."
+    Write-Log "Installing $MANIFESTOOLNAME..."
 
     $MANIFESTOOL_DIRECTORY = Join-Path $PSScriptRoot $MANIFESTOOLNAME
     Remove-Item -Recurse -Force $MANIFESTOOL_DIRECTORY -ErrorAction Ignore
@@ -92,7 +112,7 @@ function Install-SBOMUtil
         throw "$MANIFESTOOL_DIRECTORY does not contain '$dllName'"
     }
 
-    Write-Host 'Done.'
+    Write-Log 'Done.'
 
     return $manifestToolPath
 }
@@ -102,6 +122,12 @@ function Deploy-PowerShellWorker {
 
     $powerShellWorkerDir = "$(Get-FunctionsCoreToolsDir)/workers/powershell/$PowerShellVersion"
 
+    if (-not (Test-Path $powerShellWorkerDir))
+    {
+        Write-Log "Creating directory: '$powerShellWorkerDir'"
+        New-Item -Path $powerShellWorkerDir -ItemType Directory -Force | Out-Null
+    }
+
     Write-Log "Deploying worker to $powerShellWorkerDir..."
 
     if (-not $IsWindows) {
@@ -115,8 +141,6 @@ function Deploy-PowerShellWorker {
     Write-Log "Deployed worker to $powerShellWorkerDir"
 }
 
-Import-Module "$PSScriptRoot/tools/helper.psm1" -Force
-
 # Bootstrap step
 if ($Bootstrap.IsPresent) {
     Write-Log "Validate and install missing prerequisits for building ..."

package/Microsoft.Azure.Functions.PowerShellWorker.Package.csproj

@@ -5,7 +5,7 @@ Licensed under the MIT license. See LICENSE file in the project root for full li
 <Project Sdk="Microsoft.NET.Sdk">
   <Import Project="..\PowerShellWorker.Common.props" />
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <NoBuild>true</NoBuild>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>

package/Microsoft.Azure.Functions.PowerShellWorker.nuspec

@@ -5,7 +5,7 @@ Licensed under the MIT license. See LICENSE file in the project root for full li
 -->
 <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
   <metadata>
-    <id>Microsoft.Azure.Functions.PowerShellWorker.PS7.2</id>
+    <id>Microsoft.Azure.Functions.PowerShellWorker.PS7.4</id>
     <!-- Needed to specify the version here for the nuspec to be valid -->
     <version>$version$</version>
     <title>Azure Function PowerShell Language Worker (PowerShell 7.2)</title>
@@ -26,7 +26,7 @@ Licensed under the MIT license. See LICENSE file in the project root for full li
     </contentFiles>
   </metadata>
   <files>
-    <file src="..\src\bin\$configuration$\$targetFramework$\publish\**\*" target="contentFiles\any\any\workers\powershell\7.2" />
+    <file src="..\src\bin\$configuration$\$targetFramework$\publish\**\*" target="contentFiles\any\any\workers\powershell\7.4" />
     <file src="..\src\bin\$configuration$\$targetFramework$\publish\worker.config.json" target="contentFiles\any\any\workers\powershell" />
     <file src="..\images\Powershell_black_64.png" target="images\" />
   </files>

src/DurableWorker/DurableController.cs

@@ -95,7 +95,7 @@ public void InitializeBindings(IList<ParameterBinding> inputData, out bool hasEx
             {
                 var durableClient =
                     inputData.First(item => item.Name == _durableFunctionInfo.DurableClientBindingName)
-                        .Data.ToObject();
+                        .Data.ToObject(isDurableClient: true);
 
                 _powerShellServices.SetDurableClient(durableClient);
             }

src/Microsoft.Azure.Functions.PowerShellWorker.csproj

@@ -6,7 +6,7 @@ Licensed under the MIT license. See LICENSE file in the project root for full li
   <Import Project="..\PowerShellWorker.Common.props" />
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <TieredCompilation>true</TieredCompilation>
     <Product>Azure Function PowerShell Language Worker</Product>
     <AssemblyName>Microsoft.Azure.Functions.PowerShellWorker</AssemblyName>
@@ -21,7 +21,7 @@ Licensed under the MIT license. See LICENSE file in the project root for full li
 
   <ItemGroup>
     <PackageReference Include="Grpc.Net.Client" Version="2.49.0" />
-    <PackageReference Include="Microsoft.PowerShell.SDK" Version="7.2.8" />
+    <PackageReference Include="Microsoft.PowerShell.SDK" Version="7.4.0-preview.1" />
     <PackageReference Include="CommandLineParser" Version="2.9.1" />
     <PackageReference Include="Google.Protobuf" Version="3.21.9" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.3" />

src/Utility/TypeExtensions.cs

@@ -65,7 +65,7 @@ private static HttpRequestContext ToHttpRequestContext (this RpcHttp rpcHttp)
             return httpRequestContext;
         }
 
-        internal static object ToObject(this TypedData data, bool convertFromJsonIfValidJson = true)
+        internal static object ToObject(this TypedData data, bool convertFromJsonIfValidJson = true, bool isDurableClient = false)
         {
             if (data == null)
             {
@@ -75,7 +75,7 @@ internal static object ToObject(this TypedData data, bool convertFromJsonIfValid
             switch (data.DataCase)
             {
                 case TypedData.DataOneofCase.Json:
-                    return ConvertFromJson(data.Json);
+                    return ConvertFromJson(data.Json, returnCaseInsensitiveHashtable: isDurableClient);
                 case TypedData.DataOneofCase.Bytes:
                     return data.Bytes.ToByteArray();
                 case TypedData.DataOneofCase.Double:
@@ -89,7 +89,7 @@ internal static object ToObject(this TypedData data, bool convertFromJsonIfValid
                 case TypedData.DataOneofCase.String:
                     string str = data.String;
                     return convertFromJsonIfValidJson && IsValidJson(str)
-                                ? ConvertFromJson(str)
+                                ? ConvertFromJson(str, returnCaseInsensitiveHashtable: isDurableClient)
                                 : str;
                 case TypedData.DataOneofCase.None:
                     return null;
@@ -113,7 +113,7 @@ private static object GetRawBody(TypedData rpcHttpBody)
             }
         }
 
-        public static object ConvertFromJson(string json)
+        public static object ConvertFromJson(string json, bool returnCaseInsensitiveHashtable = false)
         {
             object retObj = JsonObject.ConvertFromJson(json, returnHashtable: true, error: out _);
 
@@ -122,12 +122,17 @@ public static object ConvertFromJson(string json)
                 retObj = psObj.BaseObject;
             }
 
-            if (retObj is Hashtable hashtable)
+            // By default, the PowerShell language worker no longer tries to create a case-insensitive Hashtable from the output of ConvertFromJson.
+            // This is a breaking change which is tracked by https://github.com/Azure/azure-functions-powershell-worker/issues/909.
+
+            if (returnCaseInsensitiveHashtable && (retObj is Hashtable hashtable))
             {
+                // In order to call into the DurableClient properties without having to worry about casing,
+                // we need to return a case-insensitive Hashtable for the DurableClient code path.
                 try
                 {
-                    // ConvertFromJson returns case-sensitive Hashtable by design -- JSON may contain keys that only differ in case.
-                    // We try casting the Hashtable to a case-insensitive one, but if that fails, we keep using the original one.
+                    // ConvertFromJson returns case-sensitive Ordered Hashtable by design -- JSON may contain keys that only differ in case.
+                    // We try to convert the Ordered Hashtable to a case-insensitive Hashtable, but if that fails, we keep using the original one.
                     retObj = new Hashtable(hashtable, StringComparer.OrdinalIgnoreCase);
                 }
                 catch

src/worker.config.json

@@ -4,7 +4,7 @@
         "extensions":[".ps1", ".psm1"],
         "defaultExecutablePath":"dotnet",
         "defaultWorkerPath":"%FUNCTIONS_WORKER_RUNTIME_VERSION%/Microsoft.Azure.Functions.PowerShellWorker.dll",
-        "supportedRuntimeVersions":["7", "7.2"],
+        "supportedRuntimeVersions":["7", "7.2", "7.4"],
         "defaultRuntimeVersion": "7.2",
         "sanitizeRuntimeVersionRegex":"\\d+\\.?\\d*"
     }

test/E2E/Azure.Functions.PowerShellWorker.E2E/Azure.Functions.PowerShellWorker.E2E/Azure.Functions.PowerShellWorker.E2E.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>