windows-development-sandbox 1.23.2 → 1.25.0

package/sandbox/scripts/save-visual-studio.ps1

@@ -0,0 +1,106 @@
+#Requires -Version 5.1
+# Saves a finished Visual Studio install onto the data disk, once (guest/toolchains/native/visual-studio.ts; what goes
+# where is decided in vs-persist.ts). -PlanFile is JSON written by the runtime:
+#   copies:     [{ name, from, to, optional }]   each mirrored with robocopy (/MIR); a missing optional one is skipped
+#   registry:   [{ view: '64'|'32', key, names: [..] | null, recurse }]   string and DWORD values read under HKLM
+#   resultFile: where the result goes, as JSON: { copied: [names], registry: [{ view, key, name, kind, value }] }
+# -LowPriority runs it (and robocopy) below normal priority. Safe to run again: robocopy copies only what differs.
+# Exit 0 when every copy worked, 1 when one failed (no result file then), 2 for a bad plan.
+param(
+    [Parameter(Mandatory = $true)][string]$PlanFile,
+    [switch]$LowPriority
+)
+$ErrorActionPreference = 'Stop'
+
+if ($LowPriority) {
+    try {
+        [System.Diagnostics.Process]::GetCurrentProcess().PriorityClass = [System.Diagnostics.ProcessPriorityClass]::BelowNormal
+    } catch {
+        # Normal priority only makes the copy compete a little more with the sessions.
+    }
+}
+
+$plan = Get-Content -LiteralPath $PlanFile -Raw -Encoding UTF8 | ConvertFrom-Json
+if (-not $plan.resultFile -or -not $plan.copies) {
+    Write-Error 'save-visual-studio: the plan has no copies or no result file'
+    exit 2
+}
+$robocopy = Join-Path $env:SystemRoot 'System32\Robocopy.exe'
+
+function Copy-Folder([string]$From, [string]$To) {
+    New-Item -ItemType Directory -Force -Path $To | Out-Null
+    # /MIR drops files a previous capture left; /XJ skips links (the data disk refuses them); /A-:R keeps read-only
+    # files rewritable by the next capture.
+    & $robocopy $From $To /MIR /COPY:DAT /XJ /A-:R /R:1 /W:1 /MT:16 /NP /NFL /NDL /NJH /NJS | Where-Object { $_ -and $_.Trim() } | Out-Host
+    return $LASTEXITCODE
+}
+
+$copied = New-Object System.Collections.ArrayList
+$failed = New-Object System.Collections.ArrayList
+foreach ($copy in @($plan.copies)) {
+    if (-not (Test-Path -LiteralPath $copy.from -PathType Container)) {
+        if ($copy.optional) { continue }
+        [void]$failed.Add($copy.name + ' (' + $copy.from + ' is missing)')
+        continue
+    }
+    $code = Copy-Folder -From $copy.from -To $copy.to
+    if ($code -ge 8) { [void]$failed.Add($copy.name + ' (robocopy ' + $code + ')') } else { [void]$copied.Add([string]$copy.name) }
+}
+if ($failed.Count) {
+    Write-Error ('save-visual-studio: could not save ' + ($failed -join ', '))
+    exit 1
+}
+
+function Get-View([string]$View) {
+    if ($View -eq '32') { return [Microsoft.Win32.RegistryView]::Registry32 }
+    return [Microsoft.Win32.RegistryView]::Registry64
+}
+
+function Read-Values([Microsoft.Win32.RegistryKey]$Key, [string]$Path, [string]$View, $Names, [bool]$Recurse, $Out) {
+    $options = [Microsoft.Win32.RegistryValueOptions]::DoNotExpandEnvironmentNames
+    foreach ($name in $Key.GetValueNames()) {
+        if ($null -ne $Names -and -not ($Names -contains $name)) { continue }
+        $kind = $Key.GetValueKind($name)
+        $value = $Key.GetValue($name, $null, $options)
+        $label = $null
+        if ($kind -eq [Microsoft.Win32.RegistryValueKind]::String) { $label = 'string' }
+        elseif ($kind -eq [Microsoft.Win32.RegistryValueKind]::ExpandString) { $label = 'expand' }
+        elseif ($kind -eq [Microsoft.Win32.RegistryValueKind]::DWord) { $label = 'dword'; $value = [int]$value }
+        if ($null -eq $label -or $null -eq $value) { continue }
+        [void]$Out.Add([ordered]@{ view = $View; key = $Path; name = $name; kind = $label; value = $value })
+    }
+    if (-not $Recurse) { return }
+    foreach ($sub in $Key.GetSubKeyNames()) {
+        $child = $Key.OpenSubKey($sub)
+        if ($null -eq $child) { continue }
+        try {
+            Read-Values -Key $child -Path ($Path + '\' + $sub) -View $View -Names $Names -Recurse $true -Out $Out
+        } finally {
+            $child.Close()
+        }
+    }
+}
+
+$values = New-Object System.Collections.ArrayList
+foreach ($read in @($plan.registry)) {
+    $base = [Microsoft.Win32.RegistryKey]::OpenBaseKey([Microsoft.Win32.RegistryHive]::LocalMachine, (Get-View $read.view))
+    try {
+        $key = $base.OpenSubKey([string]$read.key)
+        if ($null -eq $key) { continue }
+        try {
+            $names = $null
+            if ($null -ne $read.names) { $names = @($read.names) }
+            Read-Values -Key $key -Path ([string]$read.key) -View ([string]$read.view) -Names $names -Recurse ([bool]$read.recurse) -Out $values
+        } finally {
+            $key.Close()
+        }
+    } finally {
+        $base.Close()
+    }
+}
+
+$result = [ordered]@{ copied = @($copied.ToArray()); registry = @($values.ToArray()) }
+$json = ConvertTo-Json -InputObject $result -Depth 6
+[System.IO.File]::WriteAllText($plan.resultFile, $json, (New-Object System.Text.UTF8Encoding $false))
+Write-Output ('Saved Visual Studio: ' + $copied.Count + ' folders, ' + $values.Count + ' registry values')
+exit 0

package/schemas/config.schema.json

@@ -864,7 +864,7 @@
                   "const": "auto"
                 }
               ],
-              "description": "Unreal Engine development: Visual Studio Community 2022 with the C++ game workload (MSVC, a Windows 11 SDK, .NET Framework targeting packs, Unreal integration and the Epic Games Launcher) and the DirectX End-User Runtime. A real installer: it runs every boot (~10 GB on the sandbox disk). The engine itself comes from the Epic Games Launcher or its source. true, false, or \"auto\" = only when the project has a .uproject or .uplugin."
+              "description": "Unreal Engine development: Visual Studio Community 2022 with the C++ game workload (MSVC, a Windows 11 SDK, .NET Framework targeting packs, Unreal integration and the Epic Games Launcher) and the DirectX End-User Runtime. Visual Studio is installed once and kept on the data disk (~6.5 GB); later boots put it back in seconds. The engine itself comes from the Epic Games Launcher or its source. true, false, or \"auto\" = only when the project has a .uproject or .uplugin."
             },
             "acceptLicense": {
               "type": "boolean",
@@ -877,17 +877,13 @@
               },
               "description": "More Visual Studio workload or component IDs to add, e.g. [\"Microsoft.VisualStudio.Component.VC.Llvm.Clang\"]."
             },
-            "keepInstallFiles": {
-              "type": "boolean",
-              "description": "Keep an offline copy of the Visual Studio install files in tools\\visualstudio (~10 GB, made once), so later boots install without downloading them again. Skipped while that disk has too little room."
-            },
             "visualStudio": {
               "type": "string",
               "enum": [
                 "full",
-                "autosdk"
+                "buildtools"
               ],
-              "description": "\"full\": install Visual Studio Community (the engine finds it through the Setup API; ~10 GB, redone every boot). \"autosdk\" (experimental): skip Visual Studio and build an Unreal AutoSDK tree from the portable MSVC in tools\\unreal\\autosdk (kept between sandboxes); UnrealBuildTool finds MSVC through AutoSDK, but the editor's Visual Studio integration is not available. Needs toolchains.msvc (turned on for you)."
+              "description": "\"full\": Visual Studio Community with the C++ game workload (the IDE, its debugger and Unreal integration). \"buildtools\": only the Visual Studio Build Tools (MSVC, the Windows SDK and the .NET Framework parts UnrealBuildTool needs; no IDE). Either is installed once and kept on the data disk (tools\\visualstudio\\persist, ~6.5 GB for Community); later boots put it back in seconds."
             },
             "persistEngines": {
               "type": "boolean",

package/schemas/sandbox-config.schema.json

@@ -549,7 +549,7 @@
                   "const": "auto"
                 }
               ],
-              "description": "Unreal Engine development: Visual Studio Community 2022 with the C++ game workload (MSVC, a Windows 11 SDK, .NET Framework targeting packs, Unreal integration and the Epic Games Launcher) and the DirectX End-User Runtime. A real installer: it runs every boot (~10 GB on the sandbox disk). The engine itself comes from the Epic Games Launcher or its source. true, false, or \"auto\" = only when the project has a .uproject or .uplugin."
+              "description": "Unreal Engine development: Visual Studio Community 2022 with the C++ game workload (MSVC, a Windows 11 SDK, .NET Framework targeting packs, Unreal integration and the Epic Games Launcher) and the DirectX End-User Runtime. Visual Studio is installed once and kept on the data disk (~6.5 GB); later boots put it back in seconds. The engine itself comes from the Epic Games Launcher or its source. true, false, or \"auto\" = only when the project has a .uproject or .uplugin."
             },
             "acceptLicense": {
               "type": "boolean",
@@ -562,17 +562,13 @@
               },
               "description": "More Visual Studio workload or component IDs to add, e.g. [\"Microsoft.VisualStudio.Component.VC.Llvm.Clang\"]."
             },
-            "keepInstallFiles": {
-              "type": "boolean",
-              "description": "Keep an offline copy of the Visual Studio install files in tools\\visualstudio (~10 GB, made once), so later boots install without downloading them again. Skipped while that disk has too little room."
-            },
             "visualStudio": {
               "type": "string",
               "enum": [
                 "full",
-                "autosdk"
+                "buildtools"
               ],
-              "description": "\"full\": install Visual Studio Community (the engine finds it through the Setup API; ~10 GB, redone every boot). \"autosdk\" (experimental): skip Visual Studio and build an Unreal AutoSDK tree from the portable MSVC in tools\\unreal\\autosdk (kept between sandboxes); UnrealBuildTool finds MSVC through AutoSDK, but the editor's Visual Studio integration is not available. Needs toolchains.msvc (turned on for you)."
+              "description": "\"full\": Visual Studio Community with the C++ game workload (the IDE, its debugger and Unreal integration). \"buildtools\": only the Visual Studio Build Tools (MSVC, the Windows SDK and the .NET Framework parts UnrealBuildTool needs; no IDE). Either is installed once and kept on the data disk (tools\\visualstudio\\persist, ~6.5 GB for Community); later boots put it back in seconds."
             },
             "persistEngines": {
               "type": "boolean",

package/dist/guest/toolchains/native/autosdk.d.ts

@@ -1,3 +0,0 @@
-import { type ToolEnv } from '../tool-env.js';
-/** Makes the AutoSDK tree from the portable MSVC if it is missing for this MSVC and SDK, and points Unreal at it. */
-export declare function setupAutosdk(env: ToolEnv): Promise<void>;

package/dist/guest/toolchains/native/autosdk.js

@@ -1,50 +0,0 @@
-// Unreal without Visual Studio (toolchains.unreal.visualStudio = "autosdk", experimental): an AutoSDK tree made from
-// the portable MSVC (tools\msvc), at tools\unreal\autosdk, which UnrealBuildTool finds through UE_SDKS_ROOT. Made of
-// copies (mapped folders refuse links), once; kept between sandboxes. The editor's Visual Studio integration is not
-// available.
-import fs from 'node:fs';
-import path from 'node:path';
-import { z } from 'zod';
-import { writeJsonAtomic } from '../../../shared/io/json.js';
-import { robocopyFailed } from '../../../shared/io/robocopy-result.js';
-import { spawnAsync } from '../../../shared/download/index.js';
-import { SYSTEM } from '../../../shared/system.js';
-import { exists, mkdirp } from '../../runtime/fs.js';
-import { log } from '../../runtime/log.js';
-import { tool } from '../tool-env.js';
-import { hasCompiler, readInstalled, ROOT as MSVC_ROOT } from './msvc/tree.js';
-import { autosdkLayout } from './vs-request.js';
-const AUTOSDK_DIR = tool('unreal', 'autosdk');
-const MARKER = path.join(AUTOSDK_DIR, '.complete.json');
-const MarkerSchema = z.object({ msvc: z.string(), sdk: z.string() });
-function builtFor(msvc, sdk) {
-    try {
-        const done = MarkerSchema.parse(JSON.parse(fs.readFileSync(MARKER, 'utf8')));
-        return done.msvc === msvc && done.sdk === sdk;
-    }
-    catch {
-        return false; // No marker, or a half-written one: build again.
-    }
-}
-/** Makes the AutoSDK tree from the portable MSVC if it is missing for this MSVC and SDK, and points Unreal at it. */
-export async function setupAutosdk(env) {
-    const msvc = readInstalled();
-    if (!msvc || !hasCompiler(msvc.msvc))
-        throw new Error('toolchains.unreal.visualStudio = "autosdk" builds from the portable MSVC, which is not installed ' +
-            '(is toolchains.msvc off?)');
-    if (!builtFor(msvc.msvc, msvc.sdk)) {
-        log('Making the Unreal AutoSDK from MSVC ' + msvc.msvc + ' (~2 GB, once) ...');
-        fs.rmSync(MARKER, { force: true });
-        for (const pair of autosdkLayout(MSVC_ROOT, msvc.msvc, msvc.sdk, AUTOSDK_DIR)) {
-            mkdirp(pair.to);
-            const code = await spawnAsync(SYSTEM.robocopy(), [pair.from, pair.to, '/E', '/COPY:DAT', '/R:1', '/W:1', '/NP']);
-            if (robocopyFailed(code))
-                throw new Error('could not copy ' + pair.from + ' into the AutoSDK (robocopy ' + code + ')');
-        }
-        writeJsonAtomic(MARKER, { msvc: msvc.msvc, sdk: msvc.sdk });
-    }
-    if (!exists(MARKER))
-        throw new Error('the Unreal AutoSDK was not completed');
-    env.vars['UE_SDKS_ROOT'] = AUTOSDK_DIR;
-    env.summary.push('unreal autosdk: MSVC ' + msvc.msvc + ', Windows SDK ' + msvc.sdk + ' (UE_SDKS_ROOT=' + AUTOSDK_DIR + ')');
-}