ReleaseTools.psm1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

#requires -Version 7.0

using module PowerShellForGitHub
using namespace System.Management.Automation

class RepoNames: IValidateSetValuesGenerator {
    # NOTE: This is super over-engineered, but it was fun.
    static [string[]] $Values = "vscode-powershell", "PowerShellEditorServices"
    [String[]] GetValidValues() { return [RepoNames]::Values }
}

$ChangelogFile = "CHANGELOG.md"

<#
.SYNOPSIS
  Given the repository name, execute the script in its directory.
#>
function Use-Repository {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName,

        [Parameter(Mandatory)]
        [scriptblock]$Script
    )
    try {
        switch ($RepositoryName) {
            "vscode-powershell" {
                Push-Location -Path "$PSScriptRoot/../"
            }
            "PowerShellEditorServices" {
                Push-Location -Path "$PSScriptRoot/../../PowerShellEditorServices"
            }
        }
        & $Script
    } finally {
        Pop-Location
    }
}

<#
.SYNOPSIS
  Given a collection of PRs, generates a bulleted list.
#>
function Get-Bullets {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName,

        [Parameter(Mandatory, ValueFromPipeline)]
        [PSCustomObject[]]$PullRequests
    )
    begin {
        $SkipThanks = @(
            'andschwa'
            'daxian-dbw'
            'PaulHigin'
            'rjmholt'
            'SteveL-MSFT'
            'TylerLeonhardt'
        )

        $IssueEmojis = @{
            'Issue-Enhancement'         = '✨'
            'Issue-Bug'                 = '🐛'
            'Issue-Performance'         = '⚡️'
        }

        $AreaEmojis = @{
            'Area-Build & Release'      = '👷'
            'Area-Code Formatting'      = '💎'
            'Area-Configuration'        = '🔧'
            'Area-Debugging'            = '🔍'
            'Area-Documentation'        = '📖'
            'Area-Engine'               = '🚂'
            'Area-Folding'              = '📚'
            'Area-Integrated Console'   = '📟'
            'Area-IntelliSense'         = '🧠'
            'Area-Logging'              = '💭'
            'Area-Pester'               = '🐢'
            'Area-Script Analysis'      = '‍🕵️'
            'Area-Snippets'             = '✂️'
            'Area-Startup'              = '🛫'
            'Area-Symbols & References' = '🔗'
            'Area-Tasks'                = '✅'
            'Area-Test'                 = '🚨'
            'Area-Threading'            = '⏱️'
            'Area-UI'                   = '📺'
            'Area-Workspaces'           = '📁'
        }

        $CloseKeywords = @(
            'close'
            'closes'
            'closed'
            'fix'
            'fixes'
            'fixed'
            'resolve'
            'resolves'
            'resolved'
        )

        $IssueRegex = '(' + ($CloseKeywords -join '|') + ')\s+(?<repo>\D+)(?<number>\d+)'
    }

    process {
        $PullRequests | ForEach-Object {
            # Map all the labels to emoji (or use a default).
            $labels = if ($_.labels) { $_.labels.LabelName } else { "" }
            $issueEmoji = $IssueEmojis[$labels] + "#️⃣" | Select-Object -First 1
            $areaEmoji = $AreaEmojis[$labels] + "🙏" | Select-Object -First 1

            # Get a linked issue number if it exists (or use the PR).
            $link = if ($_.body -match $IssueRegex) {
                $number = $Matches.number
                $repo = $Matches.repo
                # Handle links to issues in both repos, in both shortcode and URLs.
                $name = [RepoNames]::Values | Where-Object { $repo -match $_ } | Select-Object -First 1
                "$($name ?? $RepositoryName) #$number"
            } else {
                "$RepositoryName #$($_.number)"
            }

            # Thank the contributor if they are not one of us.
            $thanks = if ($_.user.UserName -notin $SkipThanks) {
                "(Thanks @$($_.user.UserName)!)"
            }

            # Put the bullet point together.
            ("-", $issueEmoji, $areaEmoji, "[$link]($($_.html_url))", "-", "$($_.title).", $thanks -join " ").Trim()
        }
    }
}

<#
.SYNOPSIS
  Gets the unpublished content from the changelog.
.DESCRIPTION
  This is used so that we can manually touch-up the automatically updated
  changelog, and then bring its contents into the extension's changelog or
  the GitHub release. It just gets the first header's contents.
#>
function Get-FirstChangelog {
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName
    )
    $Changelog = Use-Repository -RepositoryName $RepositoryName -Script {
        Get-Content -Path $ChangelogFile
    }
    # NOTE: The space after the header marker is important! Otherwise ### matches.
    $Header = $Changelog.Where({$_.StartsWith("## ")}, "First")
    $Changelog.Where(
        { $_ -eq $Header }, "SkipUntil"
    ).Where(
        { $_.StartsWith("## ") -and $_ -ne $Header }, "Until"
    )
}

<#
.SYNOPSIS
  Creates and checks out `release` if not already on it.
#>
function Update-Branch {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName
    )
    Use-Repository -RepositoryName $RepositoryName -Script {
        $Branch = git branch --show-current
        if ($Branch -ne "release") {
            if ($PSCmdlet.ShouldProcess("release", "git checkout -b")) {
                git checkout -b "release"
            }
        }
    }
}

<#
.SYNOPSIS
  Gets current version from changelog as `[semver]`.
#>
function Get-Version {
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName
    )
    # NOTE: The first line should always be the header.
    $Changelog = (Get-FirstChangelog -RepositoryName $RepositoryName)[0]
    if ($Changelog -match '## v(?<version>\d+\.\d+\.\d+(-preview\.?\d*)?)') {
        return [semver]$Matches.version
    } else {
        Write-Error "Couldn't find version from changelog!"
    }
}

<#
.SYNOPSIS
  Updates the CHANGELOG file with PRs merged since the last release.
.DESCRIPTION
  Uses the local Git repositories but does not pull, so ensure HEAD is where you
  want it. Creates the branch `release` if not already checked out. Handles any
  merge option for PRs, but is a little slow as it queries all PRs.
#>
function Update-Changelog {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName,

        # TODO: Validate version style for each repo.
        [Parameter(Mandatory)]
        [ValidateScript({ $_.StartsWith("v") })]
        [string]$Version
    )

    # Get the repo object, latest release, and commits since its tag.
    $Repo = Get-GitHubRepository -OwnerName PowerShell -RepositoryName $RepositoryName
    $Commits = Use-Repository -RepositoryName $RepositoryName -Script {
        git rev-list "v$(Get-Version -RepositoryName $RepositoryName)..."
    }

    # NOTE: This is a slow API as it gets all PRs, and then filters.
    $Bullets = $Repo | Get-GitHubPullRequest -State All |
        Where-Object { $_.merge_commit_sha -in $Commits } |
        Where-Object { -not $_.user.UserName.EndsWith("[bot]") } |
        Where-Object { "Ignore" -notin $_.labels.LabelName } |
        Where-Object { -not $_.title.StartsWith("[Ignore]") } |
        Where-Object { -not $_.title.StartsWith("Release ``v") } |
        Get-Bullets -RepositoryName $RepositoryName

    $NewSection = switch ($RepositoryName) {
        "vscode-powershell" {
            @(
                "#### [vscode-powershell](https://github.com/PowerShell/vscode-powershell)"
                ""
                $Bullets
                ""
                "#### [PowerShellEditorServices](https://github.com/PowerShell/PowerShellEditorServices)"
                ""
                (Get-FirstChangelog -RepositoryName "PowerShellEditorServices").Where({ $_.StartsWith("- ") }, "SkipUntil")
            )
        }
        "PowerShellEditorServices" {
            @($Bullets)
        }
    }

    Update-Branch -RepositoryName $RepositoryName

    Use-Repository -RepositoryName $RepositoryName -Script {
        $CurrentChangelog = Get-Content -Path $ChangelogFile
        @(
            $CurrentChangelog[0..1]
            "## $Version"
            "### $([datetime]::Now.ToString('dddd, MMMM dd, yyyy'))"
            ""
            $NewSection
            ""
            $CurrentChangelog[2..$CurrentChangelog.Length]
        ) | Set-Content -Encoding utf8NoBOM -Path $ChangelogFile

        if ($PSCmdlet.ShouldProcess("$RepositoryName/$ChangelogFile", "git commit")) {
            git add $ChangelogFile
            git commit -m "Update CHANGELOG for ``$Version``"
        }
    }

    Update-Version -RepositoryName $RepositoryName
}

<#
.SYNOPSIS
  Updates version in repository.
.DESCRIPTION
  Note that our Git tags and changelog prefix all versions with `v`.

  PowerShellEditorServices: version is `X.Y.Z-preview`

  - PowerShellEditorServices.psd1:
    - `ModuleVersion` variable with `'X.Y.Z'` string, no pre-release info
  - PowerShellEditorServices.Common.props:
    - `VersionPrefix` field with `X.Y.Z`
    - `VersionSuffix` field with pre-release portion excluding hyphen

  vscode-powershell: version is `YYYY.M.X-preview`

  - package.json:
    - `version` field with `"X.Y.Z"` and no prefix or suffix
    - `preview` field set to `true` or `false` if version is a preview
    - `name` field has `-preview` appended similarly
    - `displayName` field has ` Preview` appended similarly
    - `description` field has `(Preview) ` prepended similarly
#>
function Update-Version {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName
    )
    $Version = Get-Version -RepositoryName $RepositoryName
    $v = "$($Version.Major).$($Version.Minor).$($Version.Patch)"

    Update-Branch -RepositoryName $RepositoryName

    # TODO: Maybe cleanup the replacement logic.
    Use-Repository -RepositoryName $RepositoryName -Script {
        switch ($RepositoryName) {
            "vscode-powershell" {
                $d = "Develop PowerShell modules, commands and scripts in Visual Studio Code!"
                if ($Version.PreReleaseLabel) {
                    $name = "powershell-preview"
                    $displayName = "PowerShell Preview"
                    $preview = "true"
                    $description = "(Preview) $d"
                    $icon = "media/PowerShell_Preview_Icon.png"
                } else {
                    $name = "powershell"
                    $displayName = "PowerShell"
                    $preview = "false"
                    $description = $d
                    $icon = "media/PowerShell_Icon.png"
                }

                $path = "package.json"
                $f = Get-Content -Path $path
                # NOTE: The prefix regex match two spaces exactly to avoid matching
                # nested objects in the file.
                $f = $f -replace '^(?<prefix>  "name":\s+")(.+)(?<suffix>",)$', "`${prefix}${name}`${suffix}"
                $f = $f -replace '^(?<prefix>  "displayName":\s+")(.+)(?<suffix>",)$', "`${prefix}${displayName}`${suffix}"
                $f = $f -replace '^(?<prefix>  "version":\s+")(.+)(?<suffix>",)$', "`${prefix}${v}`${suffix}"
                $f = $f -replace '^(?<prefix>  "preview":\s+)(.+)(?<suffix>,)$', "`${prefix}${preview}`${suffix}"
                $f = $f -replace '^(?<prefix>  "description":\s+")(.+)(?<suffix>",)$', "`${prefix}${description}`${suffix}"
                $f = $f -replace '^(?<prefix>  "icon":\s+")(.+)(?<suffix>",)$', "`${prefix}${icon}`${suffix}"
                $f | Set-Content -Path $path
                git add $path
            }
            "PowerShellEditorServices" {
                $path = "PowerShellEditorServices.Common.props"
                $f = Get-Content -Path $path
                $f = $f -replace '^(?<prefix>\s+<VersionPrefix>)(.+)(?<suffix></VersionPrefix>)$', "`${prefix}${v}`${suffix}"
                $f = $f -replace '^(?<prefix>\s+<VersionSuffix>)(.*)(?<suffix></VersionSuffix>)$', "`${prefix}$($Version.PreReleaseLabel)`${suffix}"
                $f | Set-Content -Path $path
                git add $path

                $path = "module/PowerShellEditorServices/PowerShellEditorServices.psd1"
                $f = Get-Content -Path $path
                $f = $f -replace "^(?<prefix>ModuleVersion = ')(.+)(?<suffix>')`$", "`${prefix}${v}`${suffix}"
                $f | Set-Content -Path $path
                git add $path
            }
        }

        if ($PSCmdlet.ShouldProcess("$RepositoryName/v$Version", "git commit")) {
            git commit -m "Bump version to ``v$Version``"
        } # TODO: Git reset to unstage
    }

    New-ReleasePR -RepositoryName $RepositoryName
}

<#
.SYNOPSIS
  Creates a new draft GitHub PR from the release branch.
.DESCRIPTION
  Pushes the release branch to `origin` and then opens a draft PR.
#>
function New-ReleasePR {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName
    )
    $Version = Get-Version -RepositoryName $RepositoryName
    $Branch = "release/v$Version"

    Update-Branch -RepositoryName $RepositoryName
    Use-Repository -RepositoryName $RepositoryName -Script {
        if ($PSCmdlet.ShouldProcess("$RepositoryName/$Branch", "git push")) {
            Write-Host "Pushing branch ``$Branch``..."
            git push origin $Branch
        }
    }

    $Repo = Get-GitHubRepository -OwnerName PowerShell -RepositoryName $RepositoryName

    $Params = @{
        Head  = $Branch
        Base  = "master"
        Draft = $true
        Title = "Release ``v$Version``"
        Body  = "Automated PR for new release!"
        # TODO: Fix passing Confirm/WhatIf (again)
    }

    $PR = $Repo | New-GitHubPullRequest @Params
    Write-Host "Draft PR URL: $($PR.html_url)"

    # NOTE: The API is weird. According to GitHub, all PRs are Issues, so this
    # works, but the module doesn't support it as easily as it could.
    $Repo | Add-GitHubIssueLabel -Issue $PR.PullRequestNumber -LabelName "Ignore"
}

<#
.SYNOPSIS
  Creates a new draft GitHub release and Git tag from the updated changelog.
.DESCRIPTION
  Requires that the changelog has been updated first as it pulls the release
  content and new version number from it. Note that our tags and version name
  are prefixed with a `v`. Creates a Git tag if it does not already exist.
#>
function New-DraftRelease {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [Parameter(Mandatory)]
        [ValidateSet([RepoNames])]
        [string]$RepositoryName,

        [Parameter()]
        [string[]]$Assets
    )
    $Version = Get-Version -RepositoryName $RepositoryName
    $Changelog = (Get-FirstChangelog -RepositoryName $RepositoryName) -join "`n"
    $ReleaseParams = @{
        # NOTE: We rely on GitHub to create the tag at that branch.
        Tag            = "v$Version"
        Committish     = "release"
        Name           = "v$Version"
        Body           = $ChangeLog
        Draft          = $true
        PreRelease     = [bool]$Version.PreReleaseLabel
        OwnerName      = "PowerShell"
        RepositoryName = $RepositoryName
        # TODO: Fix passing Confirm/WhatIf (again)
    }

    $Release = New-GitHubRelease @ReleaseParams
    if ($Release) {
        Write-Host "Draft release URL: $($Release.html_url)"
        # NOTE: We must loop around `New-GitHubReleaseAsset` so we can pipe
        # `$Release` or it can fail to find the newly created release by its ID
        # (probably a race condition).
        Write-Host "Uploading assets..."
        $Assets | ForEach-Object { $Release | New-GitHubReleaseAsset -Path $_ }
    }
}