shorebird/bin/shorebird.ps1

# This is the windows equivalent of the `third_party/flutter/bin/internal/shared.sh` script
# compiles `shorebird_cli/bin/shorebird_cli.dart` to `bin/cache/shorebird.snapshot`

$ErrorActionPreference = "Stop"

# We are running from $shorebirdRootDir\bin
$shorebirdBinDir = (Get-Item $PSScriptRoot).FullName
$shorebirdRootDir = (Get-Item $shorebirdBinDir\..\).FullName
$flutterVersion = Get-Content "$shorebirdBinDir\internal\flutter.version"
$shorebirdCacheDir = [IO.Path]::Combine($shorebirdRootDir, "bin", "cache")
$shorebirdCliDir = [IO.Path]::Combine($shorebirdRootDir, "packages", "shorebird_cli")
$snapshotPath = [IO.Path]::Combine($shorebirdCacheDir, "shorebird.snapshot")
$stampPath = [IO.Path]::Combine($shorebirdCacheDir, "shorebird.stamp")
$flutterPath = [IO.Path]::Combine($shorebirdCacheDir, "flutter", $flutterVersion)
$flutter = [IO.Path]::Combine($shorebirdCacheDir, "flutter", $flutterVersion, "bin", "flutter.bat")
$shorebirdScript = [IO.Path]::Combine($shorebirdCliDir, "bin", "shorebird.dart")
$dart = [IO.Path]::Combine($flutterPath, "bin", "cache", "dart-sdk", "bin", "dart.exe")
$defaultFlutterGitUrl = "https://github.com/tony-cloud/flutter.git"
$defaultFlutterStorageBaseUrl = "http://localhost:8080/download.flutter.io"

# Executes $command and redirects as much output to $null as possible.
#
# This is a workaround for old versions of Powershell treating any write to
# the Error stream with $ErrorActionPreference = "Stop" as a terminating error.
# This is fixed in Powershell 7.1.
# 
# See https://github.com/PowerShell/PowerShell/issues/4002 for more info.
function Invoke-SilentlyIfNeeded($command) {
    $psVersion = $PSVersionTable.PSVersion
    $isErrorStreamIssueFixed = $psVersion.Major -ge 7 -and $psVersion.Minor -ge 1
    if ($isErrorStreamIssueFixed) {
        # Execute the command with no redirection.
        & $command
    }
    else {
        # Otherwise redirect everything _but_ the Error stream to $null. See
        # https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_output_streams?view=powershell-7.3#long-description
        # for a description of these streams.
        & $command  1> $null 3> $null 4> $null 5> $null 6> $null
    }
}

function Test-GitConfigLongpaths {
    $longpathsEnabled = git config --system core.longpaths
    if ($longpathsEnabled -ne "true") {
        Write-Output "Git is not configured to allow long paths. This can cause issues with Shorebird's Flutter checkout. Please run 'git config --system core.longpaths true' to enable long paths."
    }
}

function Test-GitInstalled {
    if (Get-Command git -ErrorAction SilentlyContinue) {
        Write-Debug "Git is installed."
    }
    else {
        Write-Output "No git installation detected. Git is required to use shorebird."
        exit 1
    }
}

function Test-ShorebirdNeedsUpdate {
    Write-Debug "Checking whether shorebird needs to be rebuilt"

    # Invalidate cache if:
    #  * snapshotFile is not a file, or
    #  * stampFile is not a file, or
    #  * stampFile is an empty file, or
    #  * Contents of stampFile contains a different git hash than HEAD, or
    #  * pubspec.yaml last modified after pubspec.lock
    $snapshotFile = [System.IO.FileInfo] $snapshotPath
    $stampFile = [System.IO.FileInfo] $stampPath
    $pubspecFile = [System.IO.FileInfo] "$shorebirdCliDir\pubspec.yaml"
    $pubspecLockFile = [System.IO.FileInfo] "$shorebirdRootDir\pubspec.lock"

    Push-Location $shorebirdRootDir
    $compileKey = & { git rev-parse HEAD } -split
    Pop-Location

    if (!$snapshotFile.Exists) {
        Write-Debug "snapshot file does not exist, shorebird needs update"
        return $true
    }

    if (!$stampFile.Exists) {
        Write-Debug "stamp file does not exist at $($stampFile), shorebird needs update"
        return $true
    }

    if ($stampFile.Length -eq 0) {
        Write-Debug "stamp file is empty, shorebird needs update"
        return $true
    }

    $stampFileContents = Get-Content $stampFile
    if ($stampFileContents -ne $compileKey) {
        Write-Debug "contents of stamp file do not match compile key ($($stampFileContents) vs $($compileKey)), shorebird needs update"
        return $true
    }

    if ($pubspecFile.LastWriteTime -gt $pubspecLockFile.LastWriteTime) {
        Write-Debug "pubspec.yaml updated more recently than pubspec.lock, shorebird needs update"
        return $true
    }

    Write-Debug "shorebird does not need update"
    return $false
}

function Update-Flutter {
    Write-Output "Updating Flutter..."
    $flutterGitUrl = $env:SHOREBIRD_FLUTTER_GIT_URL
    if ([string]::IsNullOrWhiteSpace($flutterGitUrl)) {
        $flutterGitUrl = $defaultFlutterGitUrl
    }
    $flutterStorageBaseUrl = $env:SHOREBIRD_FLUTTER_STORAGE_BASE_URL
    if ([string]::IsNullOrWhiteSpace($flutterStorageBaseUrl)) {
        $flutterStorageBaseUrl = $env:FLUTTER_STORAGE_BASE_URL
    }
    if ([string]::IsNullOrWhiteSpace($flutterStorageBaseUrl)) {
        $flutterStorageBaseUrl = $defaultFlutterStorageBaseUrl
    }

    if (!(Test-Path $flutterPath)) {
        Invoke-SilentlyIfNeeded {
            git clone --filter=tree:0 "$flutterGitUrl" --no-checkout "$flutterPath"
        }
    }
    else {
        Invoke-SilentlyIfNeeded {
            git -C "$flutterPath" fetch
        }
    }

    Invoke-SilentlyIfNeeded {
        # -c to avoid printing a warning about being in a detached head state.
        git -C "$flutterPath" -c advice.detachedHead=false checkout "$flutterVersion"
    }

    # Set FLUTTER_STORAGE_BASE_URL and execute a `flutter` command to trigger
    # a download of Dart, etc. through the configured open mirror.
    $hadFlutterStorageBaseUrl = Test-Path Env:\FLUTTER_STORAGE_BASE_URL
    $previousFlutterStorageBaseUrl = $env:FLUTTER_STORAGE_BASE_URL
    $env:FLUTTER_STORAGE_BASE_URL = $flutterStorageBaseUrl;
    & $flutter --version
    if ($hadFlutterStorageBaseUrl) {
        $env:FLUTTER_STORAGE_BASE_URL = $previousFlutterStorageBaseUrl
    }
    else {
        Remove-Item Env:\FLUTTER_STORAGE_BASE_URL -ErrorAction SilentlyContinue
    }
}

function Update-Shorebird {
    Push-Location $shorebirdRootDir
    $compileKey = & { git rev-parse HEAD } -split
    Pop-Location
 
    Write-Output "Rebuilding shorebird..."

    Update-Flutter

    Push-Location $shorebirdCliDir
    & $dart pub get
    Pop-Location
    # pub get may not update pubspec.lock's mtime if dependencies are unchanged,
    # which would cause the pubspec.yaml -gt pubspec.lock check to keep
    # triggering a rebuild on every invocation.
    (Get-Item "$shorebirdRootDir/pubspec.lock").LastWriteTime = Get-Date

    Write-Output "Compiling shorebird..."

    # Compile our snapshot
    # We invoke `$SNAPSHOT_PATH completion` to trigger the "completion" command, which
    # avoids executing as much of our code as possible. We do this because running
    # the script here (instead of from the compiled snapshot) invalidates a lot of
    # assumptions we make about the cwd in the shorebird_cli tool.
    & $dart --verbosity=error --disable-dart-dev --snapshot="$snapshotPath" `
        --snapshot-kind="app-jit" --packages="$shorebirdRootDir/.dart_tool/package_config.json" `
        --no-enable-mirrors "$shorebirdScript" completion > $null

    Write-Debug "writing $compileKey to $stampPath"
    Set-Content -Path $stampPath -Value $compileKey
}

Test-GitInstalled

Test-GitConfigLongpaths

if (Test-ShorebirdNeedsUpdate) {
    Update-Shorebird
}

& $dart --disable-dart-dev --packages="$shorebirdRootDir\.dart_tool\package_config.json" "$snapshotPath" $args