Merge branch 'dev' into pthummar/add_py311_tests

Author: vrdmr

azure-pipelines.yml

@@ -7,7 +7,7 @@ trigger:
 
 variables:
     patchBuildNumberForDev: $(Build.BuildNumber)
-    PROD_V4_WORKER_PY : 'python/prodV4/worker.py'
+    PROD_V4_WORKER_PY: 'python/prodV4/worker.py'
 
 jobs:
 - job: Build_WINDOWS_X64
@@ -98,7 +98,7 @@ jobs:
       artifactName: '$(pythonVersion)_LINUX_X64'
 - job: Build_OSX_X64
   pool:
-    vmImage: 'macOS-12'
+    vmImage: 'macOS-latest'
   strategy:
     matrix:
       Python37V4:
@@ -122,10 +122,30 @@ jobs:
       pythonVersion: '$(pythonVersion)'
       workerPath: '$(workerPath)'
       artifactName: '$(pythonVersion)_OSX_X64'
+- job: Build_OSX_ARM64
+  pool:
+    vmImage: 'macOS-latest'
+  strategy:
+    matrix:
+      Python39V4:
+        pythonVersion: '3.9'
+        workerPath: $(PROD_V4_WORKER_PY)
+      Python310V4:
+        pythonVersion: '3.10'
+        workerPath: $(PROD_V4_WORKER_PY)
+      Python311V4:
+        pythonVersion: '3.11'
+        workerPath: $(PROD_V4_WORKER_PY)
+  steps:
+  - template: pack/templates/macos_64_env_gen.yml
+    parameters:
+      pythonVersion: '$(pythonVersion)'
+      workerPath: '$(workerPath)'
+      artifactName: '$(pythonVersion)_OSX_ARM64'
 
 - job: PackageWorkers
-  dependsOn: ['Build_WINDOWS_X64', 'Build_WINDOWS_X86', 'Build_LINUX_X64', 'Build_OSX_X64']
-  condition: or(startsWith(variables['Build.SourceBranch'], 'refs/heads/release/'), eq(variables['Build.SourceBranch'], 'refs/heads/dev'))
+  dependsOn: ['Build_WINDOWS_X64', 'Build_WINDOWS_X86', 'Build_LINUX_X64', 'Build_OSX_X64', 'Build_OSX_ARM64']
+  condition: or(startsWith(variables['Build.SourceBranch'], 'refs/heads/release/'), eq(variables['Build.SourceBranch'], 'refs/heads/dev'), eq(variables['GeneratePackage'], True))
   pool:
       name: '1ES-Hosted-AzFunc'
       demands:

azure_functions_worker/bindings/retrycontext.py

@@ -1,31 +1,28 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
+from dataclasses import dataclass
+from enum import Enum
+
 from . import rpcexception
 
 
+class RetryPolicy(Enum):
+    """Retry policy for the function invocation"""
+
+    MAX_RETRY_COUNT = "max_retry_count"
+    STRATEGY = "strategy"
+    DELAY_INTERVAL = "delay_interval"
+    MINIMUM_INTERVAL = "minimum_interval"
+    MAXIMUM_INTERVAL = "maximum_interval"
+
+
+@dataclass
 class RetryContext:
-    """Check https://docs.microsoft.com/en-us/azure/azure-functions/
-       functions-bindings-error-pages?tabs=python#retry-policies-preview"""
-
-    def __init__(self,
-                 retry_count: int,
-                 max_retry_count: int,
-                 rpc_exception: rpcexception.RpcException) -> None:
-        self.__retry_count = retry_count
-        self.__max_retry_count = max_retry_count
-        self.__rpc_exception = rpc_exception
-
-    @property
-    def retry_count(self) -> int:
-        """Gets the current retry count from retry-context"""
-        return self.__retry_count
-
-    @property
-    def max_retry_count(self) -> int:
-        """Gets the max retry count from retry-context"""
-        return self.__max_retry_count
-
-    @property
-    def exception(self) -> rpcexception.RpcException:
-        return self.__rpc_exception
+    """Gets the current retry count from retry-context"""
+    retry_count: int
+
+    """Gets the max retry count from retry-context"""
+    max_retry_count: int
+
+    rpc_exception: rpcexception.RpcException

azure_functions_worker/constants.py

@@ -51,3 +51,6 @@
 SCRIPT_FILE_NAME = "function_app.py"
 
 PYTHON_LANGUAGE_RUNTIME = "python"
+
+# Settings for V2 programming model
+RETRY_POLICY = "retry_policy"

azure_functions_worker/dispatcher.py

@@ -609,6 +609,10 @@ def index_functions(self, function_path: str):
                     len(indexed_functions))
 
         if indexed_functions:
+            fx_metadata_results = loader.process_indexed_function(
+                self._functions,
+                indexed_functions)
+
             indexed_function_logs: List[str] = []
             for func in indexed_functions:
                 function_log = "Function Name: {}, Function Binding: {}" \
@@ -621,10 +625,6 @@ def index_functions(self, function_path: str):
                 'Successfully processed FunctionMetadataRequest for '
                 'functions: %s', " ".join(indexed_function_logs))
 
-            fx_metadata_results = loader.process_indexed_function(
-                self._functions,
-                indexed_functions)
-
             return fx_metadata_results
 
     async def _handle__close_shared_memory_resources_request(self, request):

azure_functions_worker/loader.py

@@ -8,12 +8,17 @@
 import os.path
 import pathlib
 import sys
+import time
+from datetime import timedelta
 from os import PathLike, fspath
 from typing import Optional, Dict
 
+from google.protobuf.duration_pb2 import Duration
+
 from . import protos, functions
+from .bindings.retrycontext import RetryPolicy
 from .constants import MODULE_NOT_FOUND_TS_URL, SCRIPT_FILE_NAME, \
-    PYTHON_LANGUAGE_RUNTIME
+    PYTHON_LANGUAGE_RUNTIME, RETRY_POLICY
 from .utils.wrappers import attach_message_to_exception
 
 _AZURE_NAMESPACE = '__app__'
@@ -45,6 +50,12 @@ def install() -> None:
         sys.modules[_AZURE_NAMESPACE] = ns_pkg
 
 
+def convert_to_seconds(timestr: str):
+    x = time.strptime(timestr, '%H:%M:%S')
+    return int(timedelta(hours=x.tm_hour, minutes=x.tm_min,
+                         seconds=x.tm_sec).total_seconds())
+
+
 def uninstall() -> None:
     pass
 
@@ -60,6 +71,39 @@ def build_binding_protos(indexed_function) -> Dict:
     return binding_protos
 
 
+def build_retry_protos(indexed_function) -> Dict:
+    retry = indexed_function.get_settings_dict(RETRY_POLICY)
+    if not retry:
+        return None
+
+    strategy = retry.get(RetryPolicy.STRATEGY.value)
+    if strategy == "fixed_delay":
+        delay_interval = Duration(
+            seconds=convert_to_seconds(
+                retry.get(RetryPolicy.DELAY_INTERVAL.value)))
+        retry_protos = protos.RpcRetryOptions(
+            max_retry_count=int(retry.get(RetryPolicy.MAX_RETRY_COUNT.value)),
+            retry_strategy=retry.get(RetryPolicy.STRATEGY.value),
+            delay_interval=delay_interval,
+        )
+    else:
+        minimum_interval = Duration(
+            seconds=convert_to_seconds(
+                retry.get(RetryPolicy.MINIMUM_INTERVAL.value)))
+        maximum_interval = Duration(
+            seconds=convert_to_seconds(
+                retry.get(RetryPolicy.MAXIMUM_INTERVAL.value)))
+
+        retry_protos = protos.RpcRetryOptions(
+            max_retry_count=int(retry.get(RetryPolicy.MAX_RETRY_COUNT.value)),
+            retry_strategy=retry.get(RetryPolicy.STRATEGY.value),
+            minimum_interval=minimum_interval,
+            maximum_interval=maximum_interval
+        )
+
+    return retry_protos
+
+
 def process_indexed_function(functions_registry: functions.Registry,
                              indexed_functions):
     fx_metadata_results = []
@@ -68,6 +112,7 @@ def process_indexed_function(functions_registry: functions.Registry,
             function=indexed_function)
 
         binding_protos = build_binding_protos(indexed_function)
+        retry_protos = build_retry_protos(indexed_function)
 
         function_metadata = protos.RpcFunctionMetadata(
             name=function_info.name,
@@ -80,6 +125,7 @@ def process_indexed_function(functions_registry: functions.Registry,
             language=PYTHON_LANGUAGE_RUNTIME,
             bindings=binding_protos,
             raw_bindings=indexed_function.get_raw_bindings(),
+            retry_options=retry_protos,
             properties={"worker_indexed": "True"})
 
         fx_metadata_results.append(function_metadata)

azure_functions_worker/protos/__init__.py

@@ -32,7 +32,8 @@
     CloseSharedMemoryResourcesResponse,
     FunctionsMetadataRequest,
     FunctionMetadataResponse,
-    WorkerMetadata)
+    WorkerMetadata,
+    RpcRetryOptions)
 
 from .shared.NullableTypes_pb2 import (
     NullableString,

azure_functions_worker/protos/_src/src/proto/FunctionRpc.proto

@@ -86,6 +86,13 @@ message StreamingMessage {
 
     // Host gets the list of function load responses
     FunctionLoadResponseCollection function_load_response_collection = 32;
+    
+    // Host sends required metadata to worker to warmup the worker
+    WorkerWarmupRequest worker_warmup_request = 33;
+    
+    // Worker responds after warming up with the warmup result
+    WorkerWarmupResponse worker_warmup_response = 34;
+    
   }
 }
 
@@ -330,6 +337,9 @@ message RpcFunctionMetadata {
   // A flag indicating if managed dependency is enabled or not
   bool managed_dependency_enabled = 14;
 
+  // The optional function execution retry strategy to use on invocation failures.
+  RpcRetryOptions retry_options = 15;
+
   // Properties for function metadata
   // They're usually specific to a worker and largely passed along to the controller API for use
   // outside the host
@@ -423,6 +433,15 @@ message InvocationResponse {
   StatusResult result = 3;
 }
 
+message WorkerWarmupRequest {
+  // Full path of worker.config.json location
+  string worker_directory = 1;
+}
+
+message WorkerWarmupResponse {
+  StatusResult result = 1;
+}
+
 // Used to encapsulate data which could be a variety of types
 message TypedData {
   oneof data {
@@ -681,4 +700,31 @@ message ModelBindingData
 // Used to encapsulate collection model_binding_data
 message CollectionModelBindingData {
   repeated ModelBindingData model_binding_data = 1;
+}
+
+// Retry policy which the worker sends the host when the worker indexes
+// a function.
+message RpcRetryOptions
+{
+  // The retry strategy to use. Valid values are fixed delay or exponential backoff.
+  enum RetryStrategy
+  {
+      exponential_backoff = 0;
+      fixed_delay = 1;
+  }
+
+  // The maximum number of retries allowed per function execution.
+  //  -1 means to retry indefinitely.
+  int32 max_retry_count = 2;
+
+  // The delay that's used between retries when you're using a fixed delay strategy.
+  google.protobuf.Duration delay_interval = 3;
+
+  // The minimum retry delay when you're using an exponential backoff strategy
+  google.protobuf.Duration minimum_interval = 4;
+
+  // The maximum retry delay when you're using an exponential backoff strategy
+  google.protobuf.Duration maximum_interval = 5;
+
+  RetryStrategy retry_strategy = 6;
 }

azure_functions_worker/version.py

@@ -1,4 +1,4 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-VERSION = '4.14.0'
+VERSION = '4.15.0'

pack/Microsoft.Azure.Functions.V4.PythonWorker.nuspec

@@ -22,14 +22,17 @@
     <file src="..\3.9_WINDOWS_X86\**" target="tools\3.9\WINDOWS\X86" />
     <file src="..\3.9_LINUX_X64\**" target="tools\3.9\LINUX\X64" />
     <file src="..\3.9_OSX_X64\**" target="tools\3.9\OSX\X64" />
+    <file src="..\3.9_OSX_X64\**" target="tools\3.9\OSX\Arm64" />
     <file src="..\3.10_WINDOWS_X64\**" target="tools\3.10\WINDOWS\X64" />
     <file src="..\3.10_WINDOWS_X86\**" target="tools\3.10\WINDOWS\X86" />
     <file src="..\3.10_LINUX_X64\**" target="tools\3.10\LINUX\X64" />
     <file src="..\3.10_OSX_X64\**" target="tools\3.10\OSX\X64" />
+    <file src="..\3.10_OSX_X64\**" target="tools\3.10\OSX\Arm64" />
     <file src="..\3.11_WINDOWS_X64\**" target="tools\3.11\WINDOWS\X64" />
     <file src="..\3.11_WINDOWS_X86\**" target="tools\3.11\WINDOWS\X86" />
     <file src="..\3.11_LINUX_X64\**" target="tools\3.11\LINUX\X64" />
     <file src="..\3.11_OSX_X64\**" target="tools\3.11\OSX\X64" />
+    <file src="..\3.11_OSX_X64\**" target="tools\3.11\OSX\Arm64" />
     <file src="..\python\prodV4\worker.config.json" target="tools" />
     <file src="Microsoft.Azure.Functions.PythonWorker.targets" target="build" />
     <file src="..\_manifest\manifest.json" target="SBOM\manifest.json" />

pack/scripts/mac_arm64_deps.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+python -m venv .env
+source .env/bin/activate
+python -m pip install --upgrade pip==23.0
+
+python -m pip install .
+
+python -m pip install . --no-compile --target "$BUILD_SOURCESDIRECTORY/deps"

pack/templates/macos_64_env_gen.yml

@@ -0,0 +1,32 @@
+parameters:
+  pythonVersion: ''
+  artifactName: ''
+  workerPath: ''
+
+steps:
+- task: UsePythonVersion@0
+  inputs:
+    versionSpec: ${{ parameters.pythonVersion }}
+    addToPath: true
+- task: ShellScript@2
+  inputs:
+    disableAutoCwd: true
+    scriptPath: 'pack/scripts/mac_arm64_deps.sh'
+- task: CopyFiles@2
+  inputs:
+    contents: |
+      ${{ parameters.workerPath }}
+    targetFolder: '$(Build.ArtifactStagingDirectory)'
+    flattenFolders: true
+- task: CopyFiles@2
+  inputs:
+    sourceFolder: '$(Build.SourcesDirectory)/deps'
+    contents: |
+      **
+      !grpc_tools/**/*
+      !grpcio_tools*/*
+    targetFolder: '$(Build.ArtifactStagingDirectory)'
+- task: PublishBuildArtifacts@1
+  inputs:
+    pathtoPublish: '$(Build.ArtifactStagingDirectory)'
+    artifactName: ${{ parameters.artifactName }}

python/prodV4/worker.config.json

@@ -1,10 +1,10 @@
 {
     "description":{
         "language":"python",
-        "defaultRuntimeVersion":"3.9",
+        "defaultRuntimeVersion":"3.10",
         "supportedOperatingSystems":["LINUX", "OSX", "WINDOWS"],
         "supportedRuntimeVersions":["3.7", "3.8", "3.9", "3.10", "3.11"],
-        "supportedArchitectures":["X64", "X86"],
+        "supportedArchitectures":["X64", "X86", "Arm64"],
         "extensions":[".py"],
         "defaultExecutablePath":"python",
         "defaultWorkerPath":"%FUNCTIONS_WORKER_RUNTIME_VERSION%/{os}/{architecture}/worker.py",