Add support for workspace compilation

Actions/.Modules/ReadSettings.psm1

@@ -161,6 +161,8 @@ function GetDefaultSettings
         "enableUICop"                                   = $false
         "enableCodeAnalyzersOnTestApps"                 = $false
         "customCodeCops"                                = @()
+        "preprocessorSymbols"                           = @()
+        "features"                                      = @()
         "trackALAlertsInGitHub"                         = $false
         "failOn"                                        = "error"
         "treatTestFailuresAsWarnings"                   = $false
@@ -211,6 +213,10 @@ function GetDefaultSettings
         "environments"                                  = @()
         "buildModes"                                    = @()
         "useCompilerFolder"                             = $false
+        "workspaceCompilation"                          = [ordered]@{
+            "enabled"                                   = $false
+            "parallelism"                               = 1
+        }
         "pullRequestTrigger"                            = "pull_request"
         "bcptThresholds"                                = [ordered]@{
             "DurationWarning"                           = 10
@@ -564,6 +570,11 @@ function ReadSettings {
         $settings.projectName = $project # Default to project path as project name
     }
 
+    # Interpret zero or negative parallelism as the max number of processors
+    if ($settings.workspaceCompilation.parallelism -le 0) {
+        $settings.workspaceCompilation.parallelism = [System.Environment]::ProcessorCount
+    }
+
     $settings | ValidateSettings
 
     $settings

Actions/.Modules/settings.schema.json

@@ -297,6 +297,20 @@
             },
             "description": "See https://aka.ms/ALGoSettings#customcodecops"
         },
+        "preprocessorSymbols": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "Preprocessor symbols to use when compiling the app. See https://aka.ms/ALGoSettings#preprocessorsymbols"
+        },
+        "features": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "Features to enable when compiling the app. See https://aka.ms/ALGoSettings#features"
+        },
         "trackALAlertsInGitHub": {
             "type": "boolean",
             "description": "Enable tracking of AL Alerts in GitHub. See https://aka.ms/ALGoSettings#trackALAlertsInGitHub"
@@ -518,6 +532,21 @@
             "type": "boolean",
             "description": "Use the compiler folder instead of a BC container. See https://aka.ms/ALGoSettings#usecompilerfolder"
         },
+        "workspaceCompilation": {
+            "type": "object",
+            "description": "PREVIEW: Configuration for workspace compilation. See https://aka.ms/ALGoSettings#workspacecompilation",
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "description": "Enable workspace compilation for building apps"
+                },
+                "parallelism": {
+                    "type": "integer",
+                    "description": "The number of parallel processes to use for workspace compilation. Set to 0 or -1 to use all available processors."
+                }
+            },
+            "additionalProperties": false
+        },
         "pullRequestTrigger": {
             "type": "string",
             "pattern": "^(pull_request|pull_request_target)$",

Actions/AL-Go-Helper.ps1

@@ -54,6 +54,42 @@ $runAlPipelineOverrides = @(
     "PipelineFinalize"
 )
 
+<#
+    .SYNOPSIS
+        Gets script overrides from the AL-Go folder.
+    .DESCRIPTION
+        Checks the specified AL-Go folder for .ps1 scripts matching the provided override names.
+        Returns a hashtable mapping each found override name to its script block.
+    .PARAMETER ALGoFolderName
+        The folder where the AL-Go scripts are located.
+    .PARAMETER OverrideScriptNames
+        An array of script names to look for (without .ps1 extension).
+    .OUTPUTS
+        Hashtable with override script names as keys and their script blocks as values.
+#>
+function Get-ScriptOverrides() {
+    param(
+        [Parameter(Mandatory = $true)]
+        [string] $ALGoFolderName,
+        [Parameter(Mandatory = $true)]
+        [string[]] $OverrideScriptNames
+    )
+    $overrides = @{}
+    foreach ($scriptName in $OverrideScriptNames) {
+        $scriptPath = Join-Path $ALGoFolderName "$scriptName.ps1"
+        if (Test-Path -Path $scriptPath -Type Leaf) {
+            OutputDebug "Add override for $scriptName ($scriptPath)"
+            Trace-Information -Message "Using override for $scriptName"
+            $scriptBlock = (Get-Command $scriptPath | Select-Object -ExpandProperty ScriptBlock)
+            if (-not $scriptBlock) {
+                OutputError -message "Failed to get scriptblock for $scriptName.ps1, please check the override for validity."
+            }
+            $overrides[$scriptName] = $scriptBlock
+        }
+    }
+    return $overrides
+}
+
 # Well known AppIds
 $platformAppId = "8874ed3a-0643-4247-9ced-7a7002f7135d"
 $systemAppId = "63ca2fa4-4f03-4f2b-a480-172fef340d3f"
@@ -1570,16 +1606,7 @@ function CreateDevEnv {
 
         Push-Location $projectFolder
         try {
-            $runAlPipelineOverrides | ForEach-Object {
-                $scriptName = $_
-                $scriptPath = Join-Path $ALGoFolderName "$ScriptName.ps1"
-                if (Test-Path -Path $scriptPath -Type Leaf) {
-                    Write-Host "Add override for $scriptName"
-                    $runAlPipelineParams += @{
-                        "$scriptName" = (Get-Command $scriptPath | Select-Object -ExpandProperty ScriptBlock)
-                    }
-                }
-            }
+            $runAlPipelineParams += (Get-ScriptOverrides -ALGoFolderName $ALGoFolderName -OverrideScriptNames $runAlPipelineOverrides)
 
             if ($kind -eq "local") {
                 $runAlPipelineParams += @{
@@ -2411,3 +2438,49 @@ function RunAndCheck {
         throw "$($args[0]) $($rest | ForEach-Object { $_ }) failed with exit code $LASTEXITCODE"
     }
 }
+
+<#
+.SYNOPSIS
+Get the version number components based on the versioning strategy
+.DESCRIPTION
+Get the version number components based on the versioning strategy defined in the settings.
+.PARAMETER Settings
+The settings object containing versioning information.
+.RETURNS
+A PSCustomObject with MajorMinorVersion, BuildNumber, and RevisionNumber properties.
+#>
+function Get-VersionNumber() {
+    param(
+        [Parameter(Mandatory=$true)]
+        $Settings
+    )
+    $majorMinorVersion = ""
+    $appBuild = $Settings.appBuild
+    $appRevision = $Settings.appRevision
+
+    if ($Settings.versioningStrategy -eq -1) {
+        $artifactVersion = [Version]$Settings.artifact.Split('/')[4]
+        $majorMinorVersion = "$($artifactVersion.Major).$($artifactVersion.Minor)"
+        $appBuild = $artifactVersion.Build
+        $appRevision = $artifactVersion.Revision
+    } elseif (($Settings.versioningStrategy -band 16) -eq 16) {
+        # For versioningStrategy +16, the version number is taken from repoVersion setting
+        $repoVersion = [System.Version]$Settings.repoVersion
+        $majorMinorVersion = "$($repoVersion.Major).$($repoVersion.Minor)"
+        if (($Settings.versioningStrategy -band 15) -eq 3) {
+            # For versioning strategy 3, we need to get the build number from repoVersion setting
+            $appBuild = $repoVersion.Build
+            if ($appBuild -eq -1) {
+                OutputWarning -message "RepoVersion setting only contains Major.Minor version. When using versioningStrategy 3, it should contain 3 digits"
+                $appBuild = 0
+            }
+        }
+    }
+
+    # Construct object to return
+    return [PSCustomObject]@{
+        MajorMinorVersion = $majorMinorVersion
+        BuildNumber = $appBuild
+        RevisionNumber = $appRevision
+    }
+}

Actions/CompileApps/Compile.ps1

@@ -0,0 +1,190 @@
+Param(
+    [Parameter(HelpMessage = "The GitHub token running the action", Mandatory = $false)]
+    [string] $token,
+    [Parameter(HelpMessage = "ArtifactUrl to use for the build", Mandatory = $false)]
+    [string] $artifact = "",
+    [Parameter(HelpMessage = "Project folder", Mandatory = $false)]
+    [string] $project = "",
+    [Parameter(HelpMessage = "Specifies a mode to use for the build steps", Mandatory = $false)]
+    [string] $buildMode = 'Default',
+    [Parameter(HelpMessage = "A path to a JSON-formatted list of dependency apps", Mandatory = $false)]
+    [string] $dependencyAppsJson = '',
+    [Parameter(HelpMessage = "A path to a JSON-formatted list of dependency test apps", Mandatory = $false)]
+    [string] $dependencyTestAppsJson = '',
+    [Parameter(HelpMessage = "RunId of the baseline workflow run", Mandatory = $false)]
+    [string] $baselineWorkflowRunId = '0',
+    [Parameter(HelpMessage = "SHA of the baseline workflow run", Mandatory = $false)]
+    [string] $baselineWorkflowSHA = ''
+)
+
+. (Join-Path -Path $PSScriptRoot -ChildPath "..\AL-Go-Helper.ps1" -Resolve)
+Import-Module (Join-Path -Path $PSScriptRoot "..\.Modules\CompileFromWorkspace.psm1" -Resolve)
+Import-Module (Join-Path $PSScriptRoot '..\TelemetryHelper.psm1' -Resolve)
+Import-Module (Join-Path -Path $PSScriptRoot -ChildPath "..\DetermineProjectsToBuild\DetermineProjectsToBuild.psm1" -Resolve) -DisableNameChecking
+DownloadAndImportBcContainerHelper
+
+# ANALYZE - Analyze the repository and determine settings
+$baseFolder = (Get-BasePath)
+$settings = $env:Settings | ConvertFrom-Json | ConvertTo-HashTable
+$settings = AnalyzeRepo -settings $settings -baseFolder $baseFolder -project $project -doNotCheckArtifactSetting
+$settings = CheckAppDependencyProbingPaths -settings $settings -token $token -baseFolder $baseFolder -project $project
+
+# Check if there are any app folders or test app folders to compile
+if ($settings.appFolders.Count -eq 0 -and $settings.testFolders.Count -eq 0) {
+    Write-Host "No app folders or test app folders specified for compilation. Skipping compilation step."
+    return
+}
+
+$projectFolder = Join-Path $baseFolder $project
+Push-Location $projectFolder
+try {
+    # Set up output folders
+    $buildArtifactFolder = Join-Path $projectFolder ".buildartifacts"
+    $appOutputFolder = Join-Path $buildArtifactFolder "Apps"
+    $testAppOutputFolder = Join-Path $buildArtifactFolder "TestApps"
+    if (-not (Test-Path $buildArtifactFolder)) {
+        New-Item $buildArtifactFolder -ItemType Directory -Force | Out-Null
+    }
+    if (-not (Test-Path $appOutputFolder)) {
+        New-Item $appOutputFolder -ItemType Directory -Force | Out-Null
+    }
+    if (-not (Test-Path $testAppOutputFolder)) {
+        New-Item $testAppOutputFolder -ItemType Directory -Force | Out-Null
+    }
+
+    # Check for precompile and postcompile overrides
+    $scriptOverrides = Get-ScriptOverrides -ALGoFolderName (Join-Path $projectFolder ".AL-Go") -OverrideScriptNames @("PreCompileApp", "PostCompileApp")
+
+    # Prepare build metadata
+    $buildMetadata = Get-BuildMetadata
+
+    # Get version number
+    $versionNumber = Get-VersionNumber -Settings $settings
+
+    # Get ruleset file if specified
+    $rulesetPath = $settings.rulesetFile
+    if ($settings.rulesetFile) {
+        $rulesetPath = Join-Path $projectFolder $settings.rulesetFile -Resolve
+        if (-not (Test-Path $rulesetPath)) {
+            throw "Ruleset file specified in settings.rulesetFile not found at path '$rulesetPath'."
+        }
+    }
+
+    # Read existing install apps and test apps from JSON files
+    $dependencyApps = @()
+    $dependencyTestApps = @()
+
+    if ($dependencyAppsJson -and (Test-Path $dependencyAppsJson)) {
+        try {
+            $dependencyApps += Get-Content -Path $dependencyAppsJson | ConvertFrom-Json
+        }
+        catch {
+            throw "Failed to parse JSON file at path '$dependencyAppsJson'. Error: $($_.Exception.Message)"
+        }
+    }
+
+    if ($dependencyTestAppsJson -and (Test-Path $dependencyTestAppsJson)) {
+        try {
+            $dependencyTestApps += Get-Content -Path $dependencyTestAppsJson | ConvertFrom-Json
+        }
+        catch {
+            throw "Failed to parse JSON file at path '$dependencyTestAppsJson'. Error: $($_.Exception.Message)"
+        }
+    }
+
+    # Set up a compiler folder
+    $containerName = GetContainerName($project)
+    $cacheFolder = ""
+    if ($settings.gitHubRunner -like "windows-*" -or $settings.gitHubRunner -like "ubuntu-*") {
+        # On GitHub-hosted runners, use a folder in the runner temp directory for caching to speed up subsequent builds
+        $cacheFolder = Join-Path $ENV:RUNNER_TEMP ".artifactcache"
+    }
+    $compilerFolder = New-BcCompilerFolder -artifactUrl $artifact -containerName "$($containerName)compiler" -cacheFolder $cacheFolder
+    $packageCachePath = Join-Path $compilerFolder "symbols"
+
+    # Copy dependency apps to the package cache so the compiler can resolve them
+    foreach ($appFile in $dependencyApps) {
+        $appFile = $appFile.Trim('()')
+        if ($appFile -and (Test-Path $appFile)) {
+            Copy-Item -Path $appFile -Destination $packageCachePath -Force
+            OutputDebug "Copied dependency app to package cache: $(Split-Path $appFile -Leaf)"
+        }
+    }
+
+    # Incremental Builds - Determine unmodified apps from baseline workflow run if applicable
+    if ($baselineWorkflowSHA -and $baselineWorkflowRunId -ne '0' -and $settings.incrementalBuilds.mode -eq 'modifiedApps') {
+        #TODO: Implement support for incremental builds (AB#620492)
+        Write-Host "Incremental builds based on modified apps is not yet implemented."
+    }
+
+    if ((-not $settings.skipUpgrade) -and $settings.enableAppSourceCop) {
+        # TODO: Missing implementation of around using latest release as a baseline (skipUpgrade) / Appsourcecop.json baseline implementation (AB#620310)
+        Write-Host "Checking for required upgrades using AppSourceCop..."
+    }
+
+    # Update the app jsons with version number (and other properties) from the app manifest files
+    Update-AppJsonProperties -Folders ($settings.appFolders + $settings.testFolders) `
+        -MajorMinorVersion $versionNumber.MajorMinorVersion -BuildNumber $versionNumber.BuildNumber -RevisionNumber $versionNumber.RevisionNumber `
+        -BuildBy $buildMetadata.BuildBy -BuildUrl $buildMetadata.BuildUrl
+
+    # Collect common parameters for Build-AppsInWorkspace
+    $buildParams = @{
+        CompilerFolder              = $compilerFolder
+        PackageCachePath            = $packageCachePath
+        LogDirectory                = $buildArtifactFolder
+        Ruleset                     = $rulesetPath
+        AssemblyProbingPaths        = (Get-AssemblyProbingPaths -CompilerFolder $compilerFolder)
+        PreprocessorSymbols         = $settings.preprocessorSymbols
+        Features                    = $settings.features
+        MajorMinorVersion           = $versionNumber.MajorMinorVersion
+        BuildNumber                 = $versionNumber.BuildNumber
+        RevisionNumber              = $versionNumber.RevisionNumber
+        MaxCpuCount                 = $settings.workspaceCompilation.parallelism
+        SourceRepositoryUrl         = $buildMetadata.SourceRepositoryUrl
+        SourceCommit                = $buildMetadata.SourceCommit
+        ReportSuppressedDiagnostics = $settings.reportSuppressedDiagnostics
+        EnableExternalRulesets      = $settings.enableExternalRulesets
+        PreCompileApp               = $scriptOverrides['PreCompileApp']
+        PostCompileApp              = $scriptOverrides['PostCompileApp']
+        Analyzers                   = (Get-CodeAnalyzers -Settings $settings)
+        CustomAnalyzers             = (Get-CustomAnalyzers -Settings $settings -CompilerFolder $compilerFolder)
+    }
+
+    # Start compilation
+    $appFiles = @()
+    $testAppFiles = @()
+    try {
+        if ($settings.appFolders.Count -gt 0) {
+            # Compile Apps
+            $appFiles = Build-AppsInWorkspace @buildParams `
+                -Folders $settings.appFolders `
+                -OutFolder $appOutputFolder `
+                -AppType 'app'
+        }
+
+        if ($settings.testFolders.Count -gt 0) {
+            if (-not ($settings.enableCodeAnalyzersOnTestApps)) {
+                $buildParams.Analyzers = @()
+            }
+
+            # Compile Test Apps
+            $testAppFiles = Build-AppsInWorkspace @buildParams `
+                -Folders $settings.testFolders `
+                -OutFolder $testAppOutputFolder `
+                -AppType 'testApp'
+        }
+
+    } finally {
+        New-BuildOutputFile -BuildArtifactFolder $buildArtifactFolder -BuildOutputPath (Join-Path $projectFolder "BuildOutput.txt") -DisplayInConsole -FailOn $settings.failOn
+    }
+
+    # OUTPUT - Output the updated list of dependency apps and test apps to JSON files for downstream steps
+    $dependencyApps += $appFiles
+    $dependencyTestApps += $testAppFiles
+    Trace-Information -message "Compilation completed. Compiled $(@($appFiles).Count) apps and $(@($testAppFiles).Count) test apps."
+
+    ConvertTo-Json $dependencyApps -Depth 99 -Compress | Out-File -Encoding UTF8 -FilePath $dependencyAppsJson
+    ConvertTo-Json $dependencyTestApps -Depth 99 -Compress | Out-File -Encoding UTF8 -FilePath $dependencyTestAppsJson
+} finally {
+    Pop-Location
+}