add remoteBuild for flex consumption apps

Author: weikanglim

.vscode/cspell.misc.yaml

@@ -35,3 +35,4 @@ overrides:
           - myimage
           - azureai
           - entra
+          - flexconsumption

cli/azd/pkg/azapi/azure_client_functions_test.go

@@ -81,7 +81,7 @@ func Test_GetFunctionAppProperties(t *testing.T) {
 	})
 }
 
-func Test_DeployFunctionAppUsingZipFile(t *testing.T) {
+func Test_DeployFunctionAppUsingZipFileRegular(t *testing.T) {
 	t.Run("Success", func(t *testing.T) {
 		ran := false
 		mockContext := mocks.NewMockContext(context.Background())
@@ -93,13 +93,12 @@ func Test_DeployFunctionAppUsingZipFile(t *testing.T) {
 
 		zipFile := bytes.NewReader([]byte{})
 
-		res, err := azCli.DeployFunctionAppUsingZipFile(
+		res, err := azCli.DeployFunctionAppUsingZipFileRegular(
 			*mockContext.Context,
 			"SUBSCRIPTION_ID",
 			"RESOURCE_GROUP_ID",
 			"FUNC_APP_NAME",
 			zipFile,
-			false,
 		)
 
 		require.NoError(t, err)
@@ -117,13 +116,12 @@ func Test_DeployFunctionAppUsingZipFile(t *testing.T) {
 
 		zipFile := bytes.NewReader([]byte{})
 
-		res, err := azCli.DeployFunctionAppUsingZipFile(
+		res, err := azCli.DeployFunctionAppUsingZipFileRegular(
 			*mockContext.Context,
 			"SUBSCRIPTION_ID",
 			"RESOURCE_GROUP_ID",
 			"FUNC_APP_NAME",
 			zipFile,
-			false,
 		)
 
 		require.Nil(t, res)

cli/azd/pkg/azapi/function_app.go

@@ -7,7 +7,6 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"strings"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
@@ -35,7 +34,43 @@ func (cli *AzureClient) GetFunctionAppProperties(
 	}, nil
 }
 
-func (cli *AzureClient) DeployFunctionAppUsingZipFile(
+// GetFunctionAppPlan retrieves the app service plan for a function app
+func (cli *AzureClient) GetFunctionAppPlan(
+	ctx context.Context,
+	subscriptionId string,
+	resourceGroup string,
+	appName string,
+) (*armappservice.Plan, error) {
+	app, err := cli.appService(ctx, subscriptionId, resourceGroup, appName)
+	if err != nil {
+		return nil, err
+	}
+
+	planId, err := arm.ParseResourceID(*app.Properties.ServerFarmID)
+	if err != nil {
+		return nil, err
+	}
+
+	plansCred, err := cli.credentialProvider.CredentialForSubscription(ctx, planId.SubscriptionID)
+	if err != nil {
+		return nil, err
+	}
+
+	plansClient, err := armappservice.NewPlansClient(planId.SubscriptionID, plansCred, cli.armClientOptions)
+	if err != nil {
+		return nil, err
+	}
+
+	planResp, err := plansClient.Get(ctx, planId.ResourceGroupName, planId.Name, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return &planResp.Plan, nil
+}
+
+// DeployFunctionAppUsingZipFileFlexConsumption deploys to a Flex Consumption function app
+func (cli *AzureClient) DeployFunctionAppUsingZipFileFlexConsumption(
 	ctx context.Context,
 	subscriptionId string,
 	resourceGroup string,
@@ -53,42 +88,39 @@ func (cli *AzureClient) DeployFunctionAppUsingZipFile(
 		return nil, err
 	}
 
-	planId, err := arm.ParseResourceID(*app.Properties.ServerFarmID)
+	cred, err := cli.credentialProvider.CredentialForSubscription(ctx, subscriptionId)
 	if err != nil {
 		return nil, err
 	}
 
-	plansCred, err := cli.credentialProvider.CredentialForSubscription(ctx, planId.SubscriptionID)
+	client, err := azsdk.NewFuncAppHostClient(hostName, cred, cli.armClientOptions)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("creating func app host client: %w", err)
 	}
 
-	plansClient, err := armappservice.NewPlansClient(planId.SubscriptionID, plansCred, cli.armClientOptions)
+	response, err := client.Publish(ctx, deployZipFile, &azsdk.PublishOptions{RemoteBuild: remoteBuild})
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("publishing zip file: %w", err)
 	}
+	return to.Ptr(response.StatusText), nil
+}
 
-	plan, err := plansClient.Get(ctx, planId.ResourceGroupName, planId.Name, nil)
+// DeployFunctionAppUsingZipFileRegular deploys to a regular (non-Flex Consumption) function app
+func (cli *AzureClient) DeployFunctionAppUsingZipFileRegular(
+	ctx context.Context,
+	subscriptionId string,
+	resourceGroup string,
+	appName string,
+	deployZipFile io.ReadSeeker,
+) (*string, error) {
+	app, err := cli.appService(ctx, subscriptionId, resourceGroup, appName)
 	if err != nil {
 		return nil, err
 	}
 
-	if strings.ToLower(*plan.SKU.Tier) == "flexconsumption" {
-		cred, err := cli.credentialProvider.CredentialForSubscription(ctx, subscriptionId)
-		if err != nil {
-			return nil, err
-		}
-
-		client, err := azsdk.NewFuncAppHostClient(hostName, cred, cli.armClientOptions)
-		if err != nil {
-			return nil, fmt.Errorf("creating func app host client: %w", err)
-		}
-
-		response, err := client.Publish(ctx, deployZipFile, &azsdk.PublishOptions{RemoteBuild: remoteBuild})
-		if err != nil {
-			return nil, fmt.Errorf("publishing zip file: %w", err)
-		}
-		return to.Ptr(response.StatusText), nil
+	hostName, err := appServiceRepositoryHost(app, appName)
+	if err != nil {
+		return nil, err
 	}
 
 	client, err := cli.createZipDeployClient(ctx, subscriptionId, hostName)

cli/azd/pkg/project/service_config.go

@@ -59,6 +59,9 @@ type ServiceConfig struct {
 	// Condition for deploying the service. When evaluated, the service is only deployed if the value
 	// is a truthy boolean (1, true, TRUE, True, yes). If not defined, the service is enabled by default.
 	Condition osutil.ExpandableString `yaml:"condition,omitempty"`
+	// Whether to build the service remotely. Only applicable to function app services.
+	// When set to nil (unset), the default behavior based on language is used.
+	RemoteBuild *bool `yaml:"remoteBuild,omitempty"`
 
 	// AdditionalProperties captures any unknown YAML fields for extension support
 	AdditionalProperties map[string]interface{} `yaml:",inline"`

cli/azd/pkg/project/service_target_functionapp.go

@@ -10,28 +10,33 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/azure/azure-dev/cli/azd/internal"
 	"github.com/azure/azure-dev/cli/azd/internal/mapper"
 	"github.com/azure/azure-dev/cli/azd/pkg/async"
 	"github.com/azure/azure-dev/cli/azd/pkg/azapi"
 	"github.com/azure/azure-dev/cli/azd/pkg/environment"
+	"github.com/azure/azure-dev/cli/azd/pkg/input"
 	"github.com/azure/azure-dev/cli/azd/pkg/tools"
 )
 
 // functionAppTarget specifies an Azure Function to deploy to.
 // Implements `project.ServiceTarget`
 type functionAppTarget struct {
-	env *environment.Environment
-	cli *azapi.AzureClient
+	env     *environment.Environment
+	cli     *azapi.AzureClient
+	console input.Console
 }
 
 // NewFunctionAppTarget creates a new instance of the Function App target
 func NewFunctionAppTarget(
 	env *environment.Environment,
 	azCli *azapi.AzureClient,
+	console input.Console,
 ) ServiceTarget {
 	return &functionAppTarget{
-		env: env,
-		cli: azCli,
+		env:     env,
+		cli:     azCli,
+		console: console,
 	}
 }
 
@@ -124,19 +129,57 @@ func (f *functionAppTarget) Deploy(
 
 	defer zipFile.Close()
 
-	progress.SetProgress(NewServiceProgress("Uploading deployment package"))
-	remoteBuild := serviceConfig.Language == ServiceLanguageJavaScript ||
-		serviceConfig.Language == ServiceLanguageTypeScript ||
-		serviceConfig.Language == ServiceLanguagePython
-
-	_, err = f.cli.DeployFunctionAppUsingZipFile(
+	// Get the function app's plan
+	plan, err := f.cli.GetFunctionAppPlan(
 		ctx,
 		targetResource.SubscriptionId(),
 		targetResource.ResourceGroupName(),
 		targetResource.ResourceName(),
-		zipFile,
-		remoteBuild,
 	)
+	if err != nil {
+		return nil, fmt.Errorf("determining function app plan type: %w", err)
+	}
+
+	isFlexConsumption := strings.EqualFold(*plan.SKU.Tier, "flexconsumption")
+
+	if serviceConfig.RemoteBuild != nil && !isFlexConsumption {
+		return nil, &internal.ErrorWithSuggestion{
+			Err: fmt.Errorf("'remoteBuild' is only supported for Flex Consumption plan function apps"),
+			Suggestion: "For other plan types, set these environment variables on the function app:\n" +
+				"  ENABLE_ORYX_BUILD=true\n" +
+				"  SCM_DO_BUILD_DURING_DEPLOYMENT=true",
+		}
+	}
+
+	progress.SetProgress(NewServiceProgress("Uploading deployment package"))
+	var remoteBuild bool
+	if serviceConfig.RemoteBuild != nil {
+		remoteBuild = *serviceConfig.RemoteBuild
+	} else {
+		remoteBuild = serviceConfig.Language == ServiceLanguageJavaScript ||
+			serviceConfig.Language == ServiceLanguageTypeScript ||
+			serviceConfig.Language == ServiceLanguagePython
+	}
+
+	// Deploy to appropriate plan type
+	if isFlexConsumption {
+		_, err = f.cli.DeployFunctionAppUsingZipFileFlexConsumption(
+			ctx,
+			targetResource.SubscriptionId(),
+			targetResource.ResourceGroupName(),
+			targetResource.ResourceName(),
+			zipFile,
+			remoteBuild,
+		)
+	} else {
+		_, err = f.cli.DeployFunctionAppUsingZipFileRegular(
+			ctx,
+			targetResource.SubscriptionId(),
+			targetResource.ResourceGroupName(),
+			targetResource.ResourceName(),
+			zipFile,
+		)
+	}
 	if err != nil {
 		return nil, err
 	}