Merge branch 'main' into dev/cazamor/cmdNotFound

Author: carlos-zamora

.github/actions/spelling/allow/microsoft.txt

@@ -32,6 +32,7 @@ DWINRT
 enablewttlogging
 HOMESHARE
 Intelli
+issecret
 IVisual
 libucrt
 libucrtd
@@ -74,6 +75,7 @@ sid
 Skype
 SRW
 sxs
+symbolrequestprod
 Sysinternals
 sysnative
 systemroot

.github/actions/spelling/expect/expect.txt

@@ -1,3 +1,4 @@
+aaaaabbb
 aabbcc
 ABANDONFONT
 abbcc
@@ -92,6 +93,8 @@ backported
 backstory
 barbaz
 Bazz
+bbb
+bbccb
 BBDM
 bbwe
 bcount
@@ -597,6 +600,7 @@ FECF
 FEEF
 fesb
 FFAF
+ffd
 FFDE
 FFFDb
 fgbg
@@ -757,6 +761,7 @@ hdr
 HDROP
 hdrstop
 HEIGHTSCROLL
+hfind
 hfont
 hfontresource
 hglobal
@@ -1155,6 +1160,7 @@ NOCONTEXTHELP
 NOCOPYBITS
 NODUP
 noexcepts
+NOFONT
 NOINTEGRALHEIGHT
 NOINTERFACE
 NOLINKINFO

build/pipelines/ci.yml

@@ -4,6 +4,7 @@ trigger:
     include:
       - main
       - feature/*
+      - gh-readonly-queue/*
   paths:
     exclude:
       - doc/*

build/pipelines/ob-nightly.yml

@@ -33,6 +33,8 @@ extends:
     publishSymbolsToPublic: true
     publishVpackToWindows: false
     symbolExpiryTime: 15
+    symbolPublishingSubscription: $(SymbolPublishingServiceConnection)
+    symbolPublishingProject: $(SymbolPublishingProject)
     ${{ if eq(true, parameters.publishToAzure) }}:
       extraPublishJobs:
         - template: build/pipelines/templates-v2/job-deploy-to-azure-storage.yml@self

build/pipelines/ob-release.yml

@@ -81,3 +81,5 @@ extends:
     terminalInternalPackageVersion: ${{ parameters.terminalInternalPackageVersion }}
     publishSymbolsToPublic: ${{ parameters.publishSymbolsToPublic }}
     publishVpackToWindows: ${{ parameters.publishVpackToWindows }}
+    symbolPublishingSubscription: $(SymbolPublishingServiceConnection)
+    symbolPublishingProject: $(SymbolPublishingProject)

build/pipelines/templates-v2/job-publish-symbols-using-symbolrequestprod-api.yml

@@ -0,0 +1,117 @@
+parameters:
+  - name: includePublicSymbolServer
+    type: boolean
+    default: false
+  - name: pool
+    type: object
+    default: []
+  - name: dependsOn
+    type: object
+    default: null
+  - name: artifactStem
+    type: string
+    default: ''
+  - name: jobName
+    type: string
+    default: PublishSymbols
+  - name: symbolExpiryTime
+    type: string
+    default: 36530 # This is the default from PublishSymbols@2
+  - name: variables
+    type: object
+    default: {}
+  - name: subscription
+    type: string
+  - name: symbolProject
+    type: string
+
+jobs:
+- job: ${{ parameters.jobName }}
+  ${{ if ne(length(parameters.pool), 0) }}:
+    pool: ${{ parameters.pool }}
+  ${{ if eq(parameters.includePublicSymbolServer, true) }}:
+    displayName: Publish Symbols to Internal and MSDL
+  ${{ else }}:
+    displayName: Publish Symbols Internally
+  dependsOn: ${{ parameters.dependsOn }}
+  variables:
+    ${{ insert }}: ${{ parameters.variables }}
+  steps:
+  - checkout: self
+    clean: true
+    fetchDepth: 1
+    fetchTags: false # Tags still result in depth > 1 fetch; we don't need them here
+    submodules: true
+    persistCredentials: True
+
+  - task: PkgESSetupBuild@12
+    displayName: Package ES - Setup Build
+    inputs:
+      disableOutputRedirect: true
+
+  - task: DownloadPipelineArtifact@2
+    displayName: Download all PDBs from all prior build phases
+    inputs:
+      itemPattern: '**/*.pdb'
+      targetPath: '$(Build.SourcesDirectory)/bin'
+
+  - powershell: |-
+      Get-PackageProvider -Name NuGet -ForceBootstrap
+      Install-Module -Verbose -AllowClobber -Force Az.Accounts, Az.Storage, Az.Network, Az.Resources, Az.Compute
+    displayName: Install Azure Module Dependencies
+
+  # Transit the Azure token from the Service Connection into a secret variable for the rest of the pipeline to use.
+  - task: AzurePowerShell@5
+    displayName: Generate an Azure Token
+    inputs:
+      azureSubscription: ${{ parameters.subscription }}
+      azurePowerShellVersion: LatestVersion
+      pwsh: true
+      ScriptType: InlineScript
+      Inline: |-
+        $AzToken = (Get-AzAccessToken -ResourceUrl api://30471ccf-0966-45b9-a979-065dbedb24c1).Token
+        Write-Host "##vso[task.setvariable variable=SymbolAccessToken;issecret=true]$AzToken"
+
+
+  - task: PublishSymbols@2
+    displayName: Publish Symbols (to current Azure DevOps tenant)
+    continueOnError: True
+    inputs:
+      SymbolsFolder: '$(Build.SourcesDirectory)/bin'
+      SearchPattern: '**/*.pdb'
+      IndexSources: false
+      DetailedLog: true
+      SymbolsMaximumWaitTime: 30
+      SymbolServerType: 'TeamServices'
+      SymbolsProduct: 'Windows Terminal Converged Symbols'
+      SymbolsVersion: '$(XES_APPXMANIFESTVERSION)'
+      SymbolsArtifactName: 'WindowsTerminal_$(XES_APPXMANIFESTVERSION)'
+      SymbolExpirationInDays: ${{ parameters.symbolExpiryTime }}
+    env:
+      LIB: $(Build.SourcesDirectory)
+
+  - pwsh: |-
+      # Prepare the defaults for IRM
+      $PSDefaultParameterValues['Invoke-RestMethod:Headers'] = @{ Authorization = "Bearer $(SymbolAccessToken)" }
+      $PSDefaultParameterValues['Invoke-RestMethod:ContentType'] = "application/json"
+      $PSDefaultParameterValues['Invoke-RestMethod:Method'] = "POST"
+
+      $BaseUri = "https://symbolrequestprod.trafficmanager.net/projects/${{ parameters.symbolProject }}/requests"
+
+      # Prepare the request
+      $expiration = (Get-Date).Add([TimeSpan]::FromDays(${{ parameters.symbolExpiryTime }}))
+      $createRequestBody = @{
+        requestName = "WindowsTerminal_$(XES_APPXMANIFESTVERSION)";
+        expirationTime = $expiration.ToString();
+      }
+      Write-Host "##[debug]Starting request $($createRequestBody.requestName) with expiration date of $($createRequestBody.expirationTime)"
+      Invoke-RestMethod -Uri "$BaseUri" -Body ($createRequestBody | ConvertTo-Json -Compress) -Verbose
+
+      # Request symbol publication
+      $publishRequestBody = @{
+        publishToInternalServer = $true;
+        publishToPublicServer = $${{ parameters.includePublicSymbolServer }};
+      }
+      Write-Host "##[debug]Submitting request $($createRequestBody.requestName) ($($publishRequestBody | ConvertTo-Json -Compress))"
+      Invoke-RestMethod -Uri "$BaseUri/$($createRequestBody.requestName)" -Body ($publishRequestBody | ConvertTo-Json -Compress) -Verbose
+    displayName: Publish Symbols using internal REST API

build/pipelines/templates-v2/pipeline-onebranch-full-release-build.yml

@@ -52,6 +52,10 @@ parameters:
   - name: publishVpackToWindows
     type: boolean
     default: false
+  - name: symbolPublishingSubscription
+    type: string
+  - name: symbolPublishingProject
+    type: string
 
   - name: extraPublishJobs
     type: object
@@ -248,12 +252,13 @@ extends:
         displayName: Publish
         dependsOn: [Build]
         jobs:
-          - template: ./build/pipelines/templates-v2/job-publish-symbols.yml@self
+          - template: ./build/pipelines/templates-v2/job-publish-symbols-using-symbolrequestprod-api.yml@self
             parameters:
               pool: { type: windows }
               includePublicSymbolServer: ${{ parameters.publishSymbolsToPublic }}
-              symbolPatGoesInTaskInputs: true # onebranch tries to muck with the PAT variable, so we need to change how it get the PAT
               symbolExpiryTime: ${{ parameters.symbolExpiryTime }}
+              subscription: ${{ parameters.symbolPublishingSubscription }}
+              symbolProject: ${{ parameters.symbolPublishingProject }}
               variables:
                 ob_git_checkout: false # This job checks itself out
                 ob_git_skip_checkout_none: true

doc/building.md

@@ -154,3 +154,47 @@ popd
 The `bx` will build just the Terminal package, critically, populating the `CascadiaPackage.build.appxrecipe` file. Once that's been built, then the `DeployAppRecipe.exe` command can be used to deploy a loose layout in the same way that Visual Studio does.
 
 Notably, this method of building the Terminal package can't leverage the FastUpToDate check in Visual Studio, so the builds end up being considerably slower for the whole package, as cppwinrt does a lot of work before confirming that it's up to date and doing nothing.
+
+
+### Are you seeing `DEP0700: Registration of the app failed`?
+
+Once in a blue moon, I get a `DEP0700: Registration of the app failed.
+[0x80073CF6] error 0x80070020: Windows cannot register the package because of an
+internal error or low memory.` when trying to deploy in VS. For us, that can
+happen if the `OpenConsoleProxy.dll` gets locked up, in use by some other
+terminal package.
+
+Doing the equivalent command in powershell can give us more info:
+
+```pwsh
+Add-AppxPackage -register "Z:\dev\public\OpenConsole\src\cascadia\CascadiaPackage\bin\x64\Debug\AppX\AppxManifest.xml"
+```
+
+That'll suggest `NOTE: For additional information, look for [ActivityId]
+dbf551f1-83d0-0007-43e7-9cded083da01 in the Event Log or use the command line
+Get-AppPackageLog -ActivityID dbf551f1-83d0-0007-43e7-9cded083da01`. So do that:
+
+```pwsh
+Get-AppPackageLog -ActivityID dbf551f1-83d0-0007-43e7-9cded083da01
+```
+
+which will give you a lot of info. In my case, that revealed that the platform
+couldn't delete the packaged com entries. The key line was: `AppX Deployment
+operation failed with error 0x0 from API Logging data because access was denied
+for file:
+C:\ProgramData\Microsoft\Windows\AppRepository\Packages\WindowsTerminalDev_0.0.1.0_x64__8wekyb3d8bbwe,
+user SID: S-1-5-18`
+
+Take that path, and
+```pwsh
+sudo start C:\ProgramData\Microsoft\Windows\AppRepository\Packages\WindowsTerminalDev_0.0.1.0_x64__8wekyb3d8bbwe
+```
+
+(use `sudo`, since the path is otherwise locked down). From there, go into the
+`PackagedCom` folder, and open [File
+Locksmith](https://learn.microsoft.com/en-us/windows/powertoys/file-locksmith)
+(or Process Explorer, if you're more familiar with that) on
+`OpenConsoleProxy.dll`. Just go ahead and immediately re-launch it as admin,
+too. That should list off a couple terminal processes that are just hanging
+around. Go ahead and end them all. You should be good to deploy again after
+that.

doc/cascadia/profiles.schema.json

@@ -2332,12 +2332,20 @@
           },
           "type": "array"
         },
-        "experimental.rendering.forceFullRepaint": {
-          "description": "When set to true, we will redraw the entire screen each frame. When set to false, we will render only the updates to the screen between frames.",
+        "rendering.graphicsAPI": {
+          "description": "Direct3D 11 provides a more performant and feature-rich experience, whereas Direct2D is more stable. The default option \"Automatic\" will pick the API that best fits your graphics hardware. If you experience significant issues, consider using Direct2D.",
+          "type": "string",
+          "enum": [
+            "direct2d",
+            "direct3d11"
+          ]
+        },
+        "rendering.disablePartialInvalidation": {
+          "description": "By default, the text renderer uses a FLIP_SEQUENTIAL Swap Chain and declares dirty rectangles via the Present1 API. When this setting is enabled, a FLIP_DISCARD Swap Chain will be used instead, and no dirty rectangles will be declared. Whether one or the other is better depends on your hardware and various other factors.",
           "type": "boolean"
         },
-        "experimental.rendering.software": {
-          "description": "When set to true, we will use the software renderer (a.k.a. WARP) instead of the hardware one.",
+        "rendering.software": {
+          "description": "When enabled, the terminal will use a software rasterizer (WARP). This setting should be left disabled under almost all circumstances.",
           "type": "boolean"
         },
         "experimental.input.forceVT": {
@@ -2769,10 +2777,6 @@
           "description": "When set to true, prompts will automatically be marked.",
           "type": "boolean"
         },
-        "experimental.connection.passthroughMode": {
-          "description": "When set to true, directs the PTY for this connection to use pass-through mode instead of the original Conhost PTY simulation engine. This is an experimental feature, and its continued existence is not guaranteed.",
-          "type": "boolean"
-        },
         "experimental.retroTerminalEffect": {
           "description": "When set to true, enable retro terminal effects. This is an experimental feature, and its continued existence is not guaranteed.",
           "type": "boolean"

src/buffer/out/LineRendition.hpp

@@ -23,21 +23,24 @@ enum class LineRendition : uint8_t
 
 constexpr til::inclusive_rect ScreenToBufferLine(const til::inclusive_rect& line, const LineRendition lineRendition)
 {
-    // Use shift right to quickly divide the Left and Right by 2 for double width lines.
     const auto scale = lineRendition == LineRendition::SingleWidth ? 0 : 1;
     return { line.left >> scale, line.top, line.right >> scale, line.bottom };
 }
 
-constexpr til::point ScreenToBufferLine(const til::point& line, const LineRendition lineRendition)
+constexpr til::point ScreenToBufferLineInclusive(const til::point& line, const LineRendition lineRendition)
 {
-    // Use shift right to quickly divide the Left and Right by 2 for double width lines.
     const auto scale = lineRendition == LineRendition::SingleWidth ? 0 : 1;
     return { line.x >> scale, line.y };
 }
 
+constexpr til::rect BufferToScreenLine(const til::rect& line, const LineRendition lineRendition)
+{
+    const auto scale = lineRendition == LineRendition::SingleWidth ? 0 : 1;
+    return { line.left << scale, line.top, line.right << scale, line.bottom };
+}
+
 constexpr til::inclusive_rect BufferToScreenLine(const til::inclusive_rect& line, const LineRendition lineRendition)
 {
-    // Use shift left to quickly multiply the Left and Right by 2 for double width lines.
     const auto scale = lineRendition == LineRendition::SingleWidth ? 0 : 1;
     return { line.left << scale, line.top, (line.right << scale) + scale, line.bottom };
 }